Get Workflow Status [Auth Required]

Changed on

Get comprehensive workflow status by workflow ID.

Accepts any workflow_id (parent, processing, or inference child) and returns status for all related workflows.

Authorization: User must own the workflow OR be a CFIA admin.

Returns detailed status information including:

  • Workflow type (parent/processing/inference)
  • Associated image ID
  • Overall status (pending/in_progress/completed/failed)
  • Parent workflow status and progress
  • Processing workflow stages and timestamps
  • Inference workflow status and details
  • Authorization metadata

Use cases:

  • Frontend receives workflow_id from POST /inf submission
  • Frontend polls this endpoint to check progress
  • Can query by any related workflow ID (parent or child)

Returns: Dict with comprehensive workflow status across all related workflows

get/workflow/{workflow_id}/status

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

workflow_idstring required

Response

Successful Response

workflowIdstring required

The queried workflow ID

workflowTypestring required

Workflow type: 'parent', 'processing', or 'inference'

imageIdstring required

Associated picture UUID

overallStatusstring required

High-level status: 'pending', 'in_progress', 'completed', 'failed'

errorMessagestring nullable

Error message (if failed)

errorDetailsstring nullable

Detailed error info (if failed)

Changes

    • info

      added to the // response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

    • info

      removed subschema #1 from the // response property anyOf list for the response status

    • info

      removed subschema #1 from the // response property anyOf list for the response status