Get Workflow Results [Auth Required]

Changed on

Get inference results for a completed workflow.

Returns formatted inference results including bounding boxes, classifications, and model metadata when the workflow has completed successfully.

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

Args: workflow_id: Parent workflow ID returned by POST /inf

Returns: ApiInferenceResponse with: - filename: Image filename - imageId: Image UUID - inference_id: Annotation UUID (equals workflow_id) - boxes: List of detected objects with classifications - labelOccurrence: Count of each label - totalBoxes: Total number of detected boxes - models: Model metadata used for inference

Raises: 404: If workflow not found or results not ready 403: If user not authorized to access workflow 500: If results retrieval fails

Use cases:

  • Frontend polls /workflow/{id}/status until overall_status == "completed"
  • Frontend then calls this endpoint to get formatted results
  • Results are stored in Annotation table with id == parent workflow_id
get/workflow/{workflow_id}/results

Request

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

Path parameters

workflow_idstring required

Response

Successful Response

filenamestring required
imageIdstring required

Image UUID or identifier

inferenceIdstring required

Inference UUID or identifier

labelOccurrenceobject required

Count of each label found in the image

totalBoxesinteger required

Total number of detected boxes

Changes

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status