Skip to content
DeepFrame Alpha
日本語
Workflows

List workflows

GET/api/v1alpha1/workflows

Returns the workflows this API key has created in the workspace, most recently updated first.

  • Access: an alpha-enabled API key with the MANAGE_RULEBOOKS permission.
  • Paging: limit defaults to 25, maximum 100. Pass next_cursor back unchanged as cursor.

Take an id from the list and pass it to POST /api/v1alpha1/runs as workflow_id when starting a workflow run. Analysis runs do not require a workflow; they accept an analysis profile and report template directly.

Authorization

apiKey
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

Opaque cursor returned as next_cursor by the previous response. Pass it byte-for-byte as cursor; do not decode, edit, or construct it.

limit?number

Number of resources to return in one page. The default is 25 and the accepted range is 1-100.

Formatint32
Range1 <= value <= 100
Default25

Response Body

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

curl -X GET "https://example.com/api/v1alpha1/workflows" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"
{  "data": [    {      "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"    }  ],  "has_more": false,  "next_cursor": "MDEyMzQ1Njc4OWFitSLKnTQIcJAwDPi07V5EGs76Im3F8rCuUshrBnHuUJY7_8Ie8Stea_TKuhKhDw5XkRdkBI3IKkvsKT9Kp60Wpx7CoTCGQW8FnalDILVbuy8wxvWWf_B8SA"}

Get rulebook usage GET

Reports what depends on one rulebook, so you can see the effect of changing or deleting it.

Create a workflow POST

Creates a workflow: a rulebook bound to the videos you want checked against it. Workflow runs use this workflow; analysis runs can use an analysis profile and report template directly.