workflows

Get Workflow Status Endpoint

Get workflow status for documents.

get/workflows/status

Request

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

Query parameters

document_idstring uuid nullable

Filter by document ID

referencestring nullable

Filter by document reference

workspace_namestring nullable

Filter by workspace name

Response

Successful Response

workflow_idstring required

Workflow ID

document_idstring required

Document ID

group_idstring required

RQ Group ID

statusstring required

Workflow status

progressnumber required

Progress percentage (0.0-1.0)

referencestring nullable

Document reference

workspace_namestring nullable

Workspace name

workspace_idstring nullable

Workspace ID

workflow_typestring required

Type of workflow

total_jobsinteger required

Total number of jobs

completed_jobsinteger required

Number of completed jobs

failed_jobsinteger required

Number of failed jobs

running_jobsinteger required

Number of running jobs

created_atstring date-time nullable

When workflow was created

updated_atstring date-time nullable

When workflow was last updated

errorstring nullable

Error message if workflow failed

jobsobject[] nullable

Detailed job information

Changes

No recorded changes to this operation across all 7 revisions of this API.