Get a workflow

GET/api/v1alpha1/workflows/{workflow_id}

Returns one workflow, including the rulebook it is bound to and the videos it covers.

Access: an alpha-enabled API key with the MANAGE_RULEBOOKS permission.
Not found: a workflow belonging to somebody else is deliberately indistinguishable from one that does not exist.

Authorization

apiKey

AuthorizationBearer <token>

In: header

Path Parameters

workflow_id*string

Identifier of a workflow your key can read.

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://example.com/api/v1alpha1/workflows/wf_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"

{  "created_at": "2026-08-10T10:05:00.000Z",  "created_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "id": "wf_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "latest_run_id": "run_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "name": "Warehouse safety review",  "output_modes": [    "report"  ],  "playbook": "Review every indexed scene.",  "rule_set_version_id": "snap_7ef3a4b2c1d0",  "rulebook_id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "source_ids": [    "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"  ],  "status": "draft",  "template_type": "media_review",  "updated_at": "2026-08-10T10:06:00.000Z"}

Authorization

Path Parameters

Response Body

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

409application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

503application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`