Workflows
workflowを作成
POST
/api/v1alpha1/workflowsworkflowを作成します。workflowは、rulebookと、それを適用する動画を結び付けたものです。workflow runはこのworkflowを使い、analysis runではanalysis profileとreport templateを直接指定できます。
- アクセス: alphaを有効にしたAPI keyと
MANAGE_RULEBOOKS権限。 - 送信する内容: このkeyが参照できる
rulebook_id。所有するrulebookか、共有テンプレートです。 - 再試行: 任意の
Idempotency-Keyにより、再送を安全に扱えます。 - 見つからない場合: 参照できない
rulebook_idやsource_idsの要素は、存在しない場合と意図的に区別できません。
返されたidをworkflow_idとしてPOST /api/v1alpha1/runsに渡すとworkflow runが始まります。analysis runではanalysis profileとreport templateを直接指定します。
認証
apiKey 認証Bearer <token>
場所: header
ヘッダーパラメーター
Idempotency-Key?string
このPOSTを安全にretryするための任意のkeyです。keyは24時間保持され、request payloadと具体的なpath parameterと比較されます。
長さ
length <= 255リクエストボディ
application/json
TypeScript 型定義
TypeScript では request 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 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"}