Documents

Base URL

Production:

https://api.docanalyzer.ai/api/v1

Language Box

Was this section helpful?

What made this section unhelpful for you?

List all documents in a given workspace

Header Parameters

da-workspaceinteger

The workspace to use

Maximum
32767
Default value
0
Authorizationstring

Query Parameters

offsetinteger (int32)
Default value
0
limitinteger (int32)
Default value
100

Responses

200
Object
A paged array of documents

Response Attributes

datastring
200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

GET

/doc?offset=0&limit=100

Select
1 2 3 curl --location 'https://api.docanalyzer.ai/api/v1/doc?offset=0&limit=100' \ --header 'da-workspace: 0' \ --header 'Authorization: sha256' \

Response

{
  "data": ""
}
Was this section helpful?

What made this section unhelpful for you?

Upload document(s)

Header Parameters

da-workspaceinteger

The workspace to use

Maximum
32767
Default value
0
Authorizationstring

Path Parameters

optionsarray

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

Body Parameters

filearray

Show child attributes

Responses

200
Object
Null response

Response Attributes

dataarray

Show child attributes

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

POST

/doc/upload/{options}

Select
1 2 3 curl --location --globoff --request POST 'https://api.docanalyzer.ai/api/v1/doc/upload/{options}' \ --header 'da-workspace: 0' \ --header 'Authorization: sha256'

Response

{
  "data": [
    {
      "docid": "",
      "workspace": null,
      "name": "",
      "ready": false
    }
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Get document information

Header Parameters

Authorizationstring

Path Parameters

docidstring Required

The unique identifier of the document to retrieve

Responses

200
Object
Expected response to a valid request

Response Attributes

docidstring Required

A safe, unique identifier for the document. The identifier starts with 'd' followed by 15 characters, ensuring a total length of 16 characters.

Pattern
^d[0-9a-z]{15}$
workspaceinteger (int32)Required

A smallint value representing the workspace. It designates the workspace in which the document exists.

Maximum
32767
namestring Required

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

readyboolean Required

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.

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

GET

/doc/{docid}

Select
1 2 curl --location --globoff 'https://api.docanalyzer.ai/api/v1/doc/{docid}' \ --header 'Authorization: sha256'

Response

{
  "docid": "",
  "workspace": null,
  "name": "",
  "ready": false
}
Was this section helpful?

What made this section unhelpful for you?

Delete document

Header Parameters

Authorizationstring

Path Parameters

docidstring Required

The unique identifier of the document to delete

Responses

200
Object
Expected response to a valid request

Response Attributes

docidstring Required

A safe, unique identifier for the document. The identifier starts with 'd' followed by 15 characters, ensuring a total length of 16 characters.

Pattern
^d[0-9a-z]{15}$
workspaceinteger (int32)Required

A smallint value representing the workspace. It designates the workspace in which the document exists.

Maximum
32767
namestring Required

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

readyboolean Required

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.

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

DELETE

/doc/{docid}

Select
1 2 curl --location --globoff --request DELETE 'https://api.docanalyzer.ai/api/v1/doc/{docid}' \ --header 'Authorization: sha256'

Response

{
  "docid": "",
  "workspace": null,
  "name": "",
  "ready": false
}
Was this section helpful?

What made this section unhelpful for you?

Chat with a document

Header Parameters

Authorizationstring

Path Parameters

docidstring Required

The unique identifier of the document to chat with

Body Parameters

promptstring Required

The prompt to get an AI answer

modelstring

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.

Default value
gpt-4o-mini
Enum values:
gpt-4o-minigemini-1.5-flashclaude-3-haikugpt-4o:byokgemini-1.5-pro:byokopus:byoksonnet:byok
pageboolean

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

Default value
true
adherencestring

d in the answer

Default value
balanced
Enum values:
stricthighbalancedlowfree
ocapnumber

Specifies the maximum token length of answer

Default value
1024
langstring

Specifies the default language for the answer

Enum values:
EnglishArabicChinese (Simplified)DutchFrenchGermanHindiItalianJapaneseKorean
... 5 other enums

Responses

200
Object
Expected response to a valid request

Response Attributes

promptidstring Required

Unique identifier for the prompt

answerstring Required

The AI answer

401
Object
Unauthorized

Response Attributes

errorobject Required

Show child attributes

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

POST

/doc/{docid}/chat

Select
1 2 3 4 5 6 7 8 9 10 curl --location --globoff 'https://api.docanalyzer.ai/api/v1/doc/{docid}/chat' \ --header 'Authorization: sha256' \ --data '{ "prompt": "", "model": "gpt-4o-mini", "page": true, "adherence": "balanced", "ocap": 1024, "lang": "English" }'

Response

{
  "promptid": "",
  "answer": ""
}
Was this section helpful?

What made this section unhelpful for you?

Perform OCR (Optical Character Recognition).

Header Parameters

Authorizationstring

Path Parameters

docidstring Required

The unique identifier of the document to perform ocr on

Responses

200
Object
Expected response to a valid request

Response Attributes

queuearray

workflow id

Show child attributes

401
Object
Unauthorized

Response Attributes

errorobject Required

Show child attributes

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

POST

/doc/{docid}/ocr

Select
1 2 curl --location --globoff --request POST 'https://api.docanalyzer.ai/api/v1/doc/{docid}/ocr' \ --header 'Authorization: sha256'

Response

{
  "queue": [
    ""
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Labels