API Process
Create Process Run
Create a new processing run from a JSON config and optional inline files. The run is auto-started unless staged=true. Returns 200 with the result when a terminal state is reached within wait, otherwise 202 with the run handle.
Path Parameters
workspace_id*Workspace Id
Format
uuidQuery Parameters
wait?Wait
Maximum time in seconds to wait for the run to reach a terminal state. Set to 0 for immediate response.
Default
0Range
0 <= value <= 60staged?Staged
If true, the run is created in IDLE state, allowing files to be uploaded individually before submission.
Default
falseidempotency_key?|
Optional unique key to ensure idempotency. Reusing a key in the same workspace returns a 409 Conflict.
Request Body
multipart/form-data
Response Body
application/json
application/json
{ "data": { "config": { "extractionConfig": { "jsonSchema": { "properties": { "invoiceNumber": { "type": "string" }, "totalAmount": { "type": "number" } }, "required": [ "invoiceNumber", "totalAmount" ], "type": "object" } }, "parserConfig": { "jpegQuality": 95, "maxPixels": 11289600, "provider": "axelered" }, "parserId": "018f8e02-4b2a-7c9d-8d4e-987654321abc" }, "files": [ "invoice.pdf" ], "id": "018f8e02-4b2a-7c9d-8d4e-123456789abc", "status": "queued" }, "status": "ok"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string", "input": null, "ctx": {} } ]}