Document Classification

Synchronous document and portion classification workflows.

Classify document and portions

POST

https://api.providus.ai

/v1/classify/runs

Requires a parsed file and debits exactly 1 credit. Persists classifications for audit and later filtering.

Classify document and portions › Request Body

ClassifyRunRequest

file_id

string · uuid · required

model_id

string

reasoning_level

string · enum

Enum values:

none

low

medium

high

Default: medium

idempotency_key

string

labels

string[]

ClassificationClass[]

Classify document and portions › Responses

Classification result

ClassifyRunOutput

operation_id

string

object[]

object

warnings

string[]

modelId

string

WorkflowCredit

Credits debited by this run.

POST/v1/classify/runs

curl https://api.providus.ai/v1/classify/runs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-docai-org-id: <api-key>' \
  --data '{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "labels": [
    "string"
  ],
  "classes": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "examples": [
        "string"
      ]
    }
  ]
}'

Example Request Body

{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "labels": [
    "string"
  ],
  "classes": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "examples": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "operation_id": "operation_id",
  "classes": [
    {}
  ],
  "classifications": [
    {}
  ],
  "pageClassifications": [
    {}
  ],
  "quality": {},
  "warnings": [
    "string"
  ],
  "modelId": "modelId",
  "credit": {}
}

json

application/json

Suggest page classification classes

POST

https://api.providus.ai

/v1/classify/classes/suggest

Requires a parsed file and debits exactly 1 credit. Returns editable class definitions grounded in parsed document evidence.

Suggest page classification classes › Request Body

ClassifyClassesSuggestRequest

file_id

string · uuid · required

model_id

string

reasoning_level

string · enum

Enum values:

none

low

medium

high

Default: medium

idempotency_key

string

guidelines

string

Suggest page classification classes › Responses

Class suggestions

ClassifyClassesOutput

operation_id

string

object[]

warnings

string[]

modelId

string

WorkflowCredit

Credits debited by this run.

POST/v1/classify/classes/suggest

curl https://api.providus.ai/v1/classify/classes/suggest \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-docai-org-id: <api-key>' \
  --data '{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "guidelines": "guidelines"
}'

Example Request Body

{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "guidelines": "guidelines"
}

json

Example Responses

{
  "operation_id": "operation_id",
  "classes": [
    {}
  ],
  "warnings": [
    "string"
  ],
  "modelId": "modelId",
  "credit": {}
}

json

application/json

Document Split Document Edit

DocAI Control Plane API

Document Classification

Synchronous document and portion classification workflows.

Classify document and portions

POST

https://api.providus.ai

/v1/classify/runs

Requires a parsed file and debits exactly 1 credit. Persists classifications for audit and later filtering.

Classify document and portions › Request Body

ClassifyRunRequest

file_id

string · uuid · required

model_id

string

reasoning_level

string · enum

Enum values:

none

low

medium

high

Default: medium

idempotency_key

string

labels

string[]

ClassificationClass[]

Classify document and portions › Responses

Classification result

ClassifyRunOutput

operation_id

string

object[]

object

warnings

string[]

modelId

string

WorkflowCredit

Credits debited by this run.

POST/v1/classify/runs

curl https://api.providus.ai/v1/classify/runs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-docai-org-id: <api-key>' \
  --data '{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "labels": [
    "string"
  ],
  "classes": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "examples": [
        "string"
      ]
    }
  ]
}'

Example Request Body

{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "labels": [
    "string"
  ],
  "classes": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "examples": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "operation_id": "operation_id",
  "classes": [
    {}
  ],
  "classifications": [
    {}
  ],
  "pageClassifications": [
    {}
  ],
  "quality": {},
  "warnings": [
    "string"
  ],
  "modelId": "modelId",
  "credit": {}
}

json

application/json

Suggest page classification classes

POST

https://api.providus.ai

/v1/classify/classes/suggest

Requires a parsed file and debits exactly 1 credit. Returns editable class definitions grounded in parsed document evidence.

Suggest page classification classes › Request Body

ClassifyClassesSuggestRequest

file_id

string · uuid · required

model_id

string

reasoning_level

string · enum

Enum values:

none

low

medium

high

Default: medium

idempotency_key

string

guidelines

string

Suggest page classification classes › Responses

Class suggestions

ClassifyClassesOutput

operation_id

string

object[]

warnings

string[]

modelId

string

WorkflowCredit

Credits debited by this run.

POST/v1/classify/classes/suggest

curl https://api.providus.ai/v1/classify/classes/suggest \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-docai-org-id: <api-key>' \
  --data '{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "guidelines": "guidelines"
}'

Example Request Body

{
  "model_id": "lmstudio/qwen3-vl-32b-instruct-mlx",
  "reasoning_level": "medium",
  "idempotency_key": "idempotency_key",
  "file_id": "00000000-0000-0000-0000-000000000000",
  "guidelines": "guidelines"
}

json

Example Responses

{
  "operation_id": "operation_id",
  "classes": [
    {}
  ],
  "warnings": [
    "string"
  ],
  "modelId": "modelId",
  "credit": {}
}

json

application/json

Document Split Document Edit