Create a workflow

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.

• Access: an alpha-enabled API key with the MANAGE_RULEBOOKS permission.
• Send: a rulebook_id this key can reach - one it owns, or a shared template.
• Retries: an optional Idempotency-Key makes a repeated call safe.
• Not found: a rulebook_id or a source_ids entry you cannot reach is deliberately indistinguishable from one that does not exist.

Pass the returned id to POST /api/v1alpha1/runs as workflow_id to start a workflow run. Analysis runs instead accept an analysis profile and report template directly.

Header Parameters

Response Body

curl -X POST "https://example.com/api/v1alpha1/workflows" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "Warehouse safety review",    "output_modes": [      "report"    ],    "playbook": "Review every indexed scene.",    "rulebook_id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",    "source_ids": [      "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"    ],    "status": "draft",    "template_type": "media_review"  }'

{  "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"}