API explorerChangelog
API explorer
Changelog

Theme switcher

Documents

Base URL

Production:

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

Language Box

Labels

Was this section helpful?

What made this section unhelpful for you?

List all labels 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

Response

200
Object
A paged array of labels

Response Attributes

datastring
200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/label?offset=0&limit=100

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

Response

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

What made this section unhelpful for you?

Create a label

Header Parameters

da-workspaceinteger

The workspace to use

Maximum
32767
Default value
0
Authorizationstring

Body Parameters

namestring Required

Display name for the label

docidsarray

Unique identifiers of documents associated with the label

Show child attributes

colorstring Required

The hex color code of the label

Response

200
Object
A paged array of labels

Response Attributes

datastring
200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/label

Select
1 2 3 4 5 6 7 8 9 10 curl --location 'https://api.docanalyzer.ai/api/v1/label' \ --header 'da-workspace: 0' \ --header 'Authorization: sha256' \ --data '{ "name": "", "docids": [ "" ], "color": "" }'

Response

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

What made this section unhelpful for you?

Upload documents associated with label(s)

Header Parameters

da-workspaceinteger

The workspace to use

Maximum
32767
Default value
0
Authorizationstring

Path Parameters

lidarray Required

Unique identifier(s) of the label to associate documents with

Min items
1
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

Response

200
Object
Null response

Response Attributes

dataarray

Show child attributes

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/label/{lid}/upload/{options}

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

Response

{
  "data": [
    {
      "lid": "",
      "workspace": null,
      "name": "",
      "docids": [
        ""
      ],
      "color": ""
    }
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Get label information

Header Parameters

Authorizationstring

Path Parameters

lidstring Required

The unique identifier of the label to retrieve

Response

200
Object
Expected response to a valid request

Response Attributes

lidstring Required

The unique identifier of the label to retrieve (uuid)

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 of the label for display purposes.

docidsarray Required

Unique identifiers of documents associated with the label

Show child attributes

colorstring Required

The hex color code of the label

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/label/{lid}

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

Response

{
  "lid": "",
  "workspace": null,
  "name": "",
  "docids": [
    ""
  ],
  "color": ""
}
Was this section helpful?

What made this section unhelpful for you?

Update label

Header Parameters

Authorizationstring

Path Parameters

lidstring Required

The unique identifier of the label to update

Body Parameters

namestring

The new display name for the label

colorstring

The new hex color code for the label

docidsobject

Show child attributes

Response

200
Object
Expected response to a valid request

Response Attributes

lidstring Required

The unique identifier of the label to retrieve (uuid)

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 of the label for display purposes.

docidsarray Required

Unique identifiers of documents associated with the label

Show child attributes

colorstring Required

The hex color code of the label

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PUT

/label/{lid}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 curl --location --globoff --request PUT 'https://api.docanalyzer.ai/api/v1/label/{lid}' \ --header 'Authorization: sha256' \ --data '{ "name": "", "color": "", "docids": { "tag": [ "" ], "untag": [ "" ] } }'

Response

{
  "lid": "",
  "workspace": null,
  "name": "",
  "docids": [
    ""
  ],
  "color": ""
}
Was this section helpful?

What made this section unhelpful for you?

Delete label

Header Parameters

Authorizationstring

Path Parameters

lidstring Required

The unique identifier of the label to delete

Response

200
Object
Expected response to a valid request

Response Attributes

lidstring Required

The unique identifier of the label to retrieve (uuid)

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 of the label for display purposes.

docidsarray Required

Unique identifiers of documents associated with the label

Show child attributes

colorstring Required

The hex color code of the label

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

DELETE

/label/{lid}

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

Response

{
  "lid": "",
  "workspace": null,
  "name": "",
  "docids": [
    ""
  ],
  "color": ""
}
Was this section helpful?

What made this section unhelpful for you?

Chat with all documents associated with a label

Header Parameters

Authorizationstring

Path Parameters

lidstring Required

The unique identifier of the label 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-2.0-flashgemini-2.0-flash-liteclaude-3.5-haikudeepseek-v3gpt-4o:byokgemini-1.5-pro:byoksonnet-3.7: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

Response

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

Was this section helpful?

What made this section unhelpful for you?

POST

/label/{lid}/chat

Select
1 2 3 4 5 6 7 8 9 10 curl --location --globoff 'https://api.docanalyzer.ai/api/v1/label/{lid}/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?

Create a new thread external link on a label

Header Parameters

Authorizationstring

Path Parameters

lidstring Required

The unique identifier of the label

Body Parameters

titlestring Required

Display name for the label

externalboolean Required

If this parameter is true, create an external link for the chat session.

Response

200
Object
Null response

Response Attributes

urlstring

Standalone chat URL

200
Object
Error response.

Response Attributes

errorobject Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/label/{lid}/thread

Select
1 2 3 4 5 6 curl --location --globoff 'https://api.docanalyzer.ai/api/v1/label/{lid}/thread' \ --header 'Authorization: sha256' \ --data '{ "title": "", "external": false }'

Response

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

What made this section unhelpful for you?