Document Edit

Synchronous prompt/rule based edit proposal workflows.

Create document edit proposal

POST

https://api.providus.ai

/v1/edit/runs

Requires a parsed file and debits exactly 1 credit. Returns a proposal/diff only and does not mutate the source file.

Create document edit proposal › Request Body

EditRunRequest

file_id

string · uuid · required

prompt

string · required

model_id

string

reasoning_level

string · enum

Enum values:

none

low

medium

high

Default: medium

idempotency_key

string

rules

string[]

Create document edit proposal › Responses

Edit proposal

EditRunOutput

operation_id

string

proposal_id

string

object

modelId

string

WorkflowCredit

Credits debited by this run.

POST/v1/edit/runs

curl https://api.providus.ai/v1/edit/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",
  "prompt": "prompt",
  "rules": [
    "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",
  "prompt": "prompt",
  "rules": [
    "string"
  ]
}

json

Example Responses

{
  "operation_id": "operation_id",
  "proposal_id": "proposal_id",
  "proposal": {},
  "modelId": "modelId",
  "credit": {}
}

json

application/json

Document Classification Knowledge Base Corpus

DocAI Control Plane API

Document Edit

Synchronous prompt/rule based edit proposal workflows.

Create document edit proposal

POST

https://api.providus.ai

/v1/edit/runs

Requires a parsed file and debits exactly 1 credit. Returns a proposal/diff only and does not mutate the source file.

Create document edit proposal › Request Body

EditRunRequest

file_id

string · uuid · required

prompt

string · required

model_id

string

reasoning_level

string · enum

Enum values:

none

low

medium

high

Default: medium

idempotency_key

string

rules

string[]

Create document edit proposal › Responses

Edit proposal

EditRunOutput

operation_id

string

proposal_id

string

object

modelId

string

WorkflowCredit

Credits debited by this run.

POST/v1/edit/runs

curl https://api.providus.ai/v1/edit/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",
  "prompt": "prompt",
  "rules": [
    "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",
  "prompt": "prompt",
  "rules": [
    "string"
  ]
}

json

Example Responses

{
  "operation_id": "operation_id",
  "proposal_id": "proposal_id",
  "proposal": {},
  "modelId": "modelId",
  "credit": {}
}

json

application/json

Document Classification Knowledge Base Corpus