Documents
Base URL
Production:
https://api.docanalyzer.ai/api/v1
What made this section unhelpful for you?
List all documents in a given workspace
Header Parameters
The workspace to use
Query Parameters
Responses
Response Attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Upload document(s)
Header Parameters
The workspace to use
Path Parameters
Comma-separated options (e.g.,sync) that modify upload behavior. If sync, the server wait document(s) analysis is ready to return.
Body Parameters
Show child attributes
Responses
Response Attributes
Show child attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Get document information
Header Parameters
Path Parameters
The unique identifier of the document to retrieve
Responses
Response Attributes
A safe, unique identifier for the document. The identifier starts with 'd' followed by 15 characters, ensuring a total length of 16 characters.
A smallint value representing the workspace. It designates the workspace in which the document exists.
The human-readable name or title of the document for display purposes.
Indicates whether the document has been successfully analyzed and is fully processed. When set to true, the document is ready for actions such as initiating an interactive chat session.
Response Attributes
Show child attributes
What made this section unhelpful for you?
Delete document
Header Parameters
Path Parameters
The unique identifier of the document to delete
Responses
Response Attributes
A safe, unique identifier for the document. The identifier starts with 'd' followed by 15 characters, ensuring a total length of 16 characters.
A smallint value representing the workspace. It designates the workspace in which the document exists.
The human-readable name or title of the document for display purposes.
Indicates whether the document has been successfully analyzed and is fully processed. When set to true, the document is ready for actions such as initiating an interactive chat session.
Response Attributes
Show child attributes
What made this section unhelpful for you?
Chat with a document
Header Parameters
Path Parameters
The unique identifier of the document to chat with
Body Parameters
The prompt to get an AI answer
Defines the AI model to be used for generating responses. The default model is 'OpenAI GPT-4o mini'. Other available options include advanced models from Anthropic and Google. You can also configure BYOK (Bring Your Own Key) models when its API key is stored in your account.
gpt-4o-mini
gemini-1.5-flash
claude-3-haiku
gpt-4o:byok
gemini-1.5-pro:byok
opus:byok
sonnet:byok
Specifies if page(s) reference(s) need to be added in the answer
d in the answer
strict
high
balanced
low
free
Specifies the maximum token length of answer
Specifies the default language for the answer
English
Arabic
Chinese (Simplified)
Dutch
French
German
Hindi
Italian
Japanese
Korean
... 5 other enums
Responses
Response Attributes
Unique identifier for the prompt
The AI answer
Response Attributes
Show child attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Perform OCR (Optical Character Recognition).
Header Parameters
Path Parameters
The unique identifier of the document to perform ocr on
Responses
Response Attributes
workflow id