workflows

Start Workflow

Changed on

Start PDF processing workflow for a document.

post/workflows/start

Request

  • Base URL
    https://extralit-public-demo.hf.space/api/v1
  • URL
    https://extralit-public-demo.hf.space/api/v1/workflows/start
  • Auth
    • API key in header X-Extralit-Api-Key
    • or HTTP bearer

Request body

document_idstring uuid required

Document UUID to process

workspace_namestring required

Workspace name

referencestring nullable

Document reference for tracking

forceboolean

Force restart if workflow already exists

waitboolean

Wait for job to finish before returning

timeoutinteger nullable

Max seconds to wait if wait=True

layout_parserstring nullable

Layout parser to run (e.g. pdf_inspector, pymupdf); omit to skip layout extraction

Response

Successful Response

workflow_idstring required

Workflow ID

document_idstring required

Document ID

group_idstring required

RQ Group ID for tracking

statusstring required

Initial workflow status

referencestring nullable

Document reference

restarted_jobsstring[] nullable

List of restarted job IDs (for restarts)

Changes