docAnalyzer.ai

Documents

List all documents in a given workspace

Upload document(s)

Get document information

Delete document

Chat with a document

Perform OCR (Optical Character Recognition).

Labels

List all labels in a given workspace

Create a label

Upload documents associated with label(s)

Get label information

Update label

Delete label

Chat with all documents associated with a label

Settings

List all models

docAnalyzer.AI API

Production

da-workspace

Authorization

offset

limit

data

error

default

file

Comma-separated options (e.g.,sync) that modify upload behavior. If sync, the server wait document(s) analysis is ready to return.

options

The unique identifier of the document to retrieve

docid

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.

workspace

The human-readable name or title of the document for display purposes.

name

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.

ready

The unique identifier of the document to delete

prompt

If true, estimates the maximum credits the request might consume without processing it.

dryrun

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.

model

Maximum number of context tokens (from the prompt and document) to use for the prompt. Defaults and maximums vary by model (see GET /models).

budget

Specifies the reasoning process for compatible models. Refer to GET /models for valid values specific to each model.

thinking

Specifies if page(s) reference(s) need to be added in the answer

page

Specifies the maximum token length of answer

ocap

adherence

Specifies the default language for the answer

lang

Set to true to use a Bring Your Own Key (BYOK) model configured in your account.

Sections