API documentation

The docAnalyzer API is organized around REST principles. It features predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and adheres to standard HTTP response codes, authentication, and verbs. Each "chat type" request uses 1 credit, while all other requests do not consume credits.

Endpoint

             https://api.docanalyzer.ai
             

Authentication

The docAnalyzer API uses API keys to authenticate requests. You can create and manage your API keys in your account API Dashboard.

Your API keys carry many privileges, so be sure to keep them secure. Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Your API requests should include your API key in an Authorization HTTP header as follows:

             Authorization: Bearer DOCANALYZER_API_KEY
             

Quick start

POST /api/v1/doc/upload

Upload a document using multipart/form-data

             curl https://api.docanalyzer.ai/api/v1/doc/upload              -H "Authorization: Bearer $DOCANALYZER_API_KEY"              -F [email protected]
             

GET /api/v1/doc

Return a JSON list of all your documents with their docids:

             curl https://api.docanalyzer.ai/api/v1/doc              -H "Authorization: Bearer $DOCANALYZER_API_KEY"              

POST /api/v1/doc/{docid}/chat

Return a chat answer and update chat history:

             curl -H "Authorization: Bearer $DOCANALYZER_API_KEY"              --json '{ "prompt": "$YOUR_QUESTION" }              https://api.docanalyzer.ai/api/v1/doc/$YOUR_DOCID/chat'
             

Rate Limit

The rate limit system in place at docAnalyzer.ai ensures fair and efficient API usage, optimizing performance across all user accounts. Here’s what users need to know about the rate limits and what they entail.

Per-Minute Quota

Users can make up to 100 requests within any 60-second period. This is a rolling window, meaning that each new request looks back over the previous 60 seconds. If 100 requests have already been made in that span, additional requests will trigger an error indicating the limit has been reached.

To help you monitor usage, each API response includes helpful headers:

• X-RateLimit-Limit: Shows the maximum allowed requests (100 per minute)
• X-RateLimit-Remaining: Displays the number of requests left for the current period.

Per-Day Quota

The system permits up to 10,000 requests within each calendar day (based on UTC time). Once this limit is reached, no further requests will be processed until the start of the next UTC day.

API reference

To check the complete API, please visit our reference documentation.

Please note that the reference documentation is work in progress and may be yet incomplete

Community API Contributions Repository

Explore our Community Contributions Repository where you can discover a variety of user-generated code samples that leverage the docAnalyzer API across different programming languages. This repository is a valuable resource for seeing practical implementations and innovative uses of our API, allowing you to learn from and build upon the work of other developers. To contribute your own examples or browse the existing contributions, visit our Community Contributions Repository on GitHub. Remember, while we do not offer specific support for these scripts, our Discord community is available to assist you.