コンテンツへスキップ
Workflows

workflowを取得

GET/api/v1alpha1/workflows/{workflow_id}

1件のworkflowを、紐付いたrulebookと対象の動画とあわせて返します。

  • アクセス: alphaを有効にしたAPI keyとMANAGE_RULEBOOKS権限。
  • 見つからない場合: 他者が所有するworkflowは、存在しない場合と意図的に区別できません。

認証

apiKey
認証Bearer <token>

場所: header

パスパラメーター

workflow_id*string

このkeyが読み取れるworkflowの識別子です。

レスポンスボディ

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