コンテンツへスキップ
Runs

分析ランを作成

POST/api/v1alpha1/runs

既存workflowのrunまたはanalysisを開始します。202応答は受付を示し、処理完了を示しません。

  • アクセス: alphaを有効にしたAPI keyとRUN_WORKFLOWS権限が必要です。workflow requestではworkflow_idを使います。analysis requestではワークスペースから見える、処理済みでsearchableなsource_idsを使います。
  • 分析入力: 保存済みのprofile_idとreport_template_idに加えて、formatsとexecution_profile_refを送信します。それぞれのimmutable versionを指定できます。versionを省略するとサーバーはlatestを解決し、再現性のため解決したversionをrun snapshotに記録します。このendpointではinline profileとtemplateを受け付けません。新しい表示viewにはrerender/report endpointを使います。
  • workflowの任意項目: source_snapshotは選択した動画識別子を含むimmutable objectです。
  • 再試行: Idempotency-Keyを指定します。異なるbodyで同じkeyを使うと422になります。

GET /api/v1alpha1/runs/{run_id}でrunが終了するまでpollします。analysis answerはGET /api/v1alpha1/runs/{run_id}/answersで、workflow findingはGET /api/v1alpha1/findings?run_id={run_id}で取得します。

認証

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

application/problem+json

curl -X POST "https://example.com/api/v1alpha1/runs" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "execute_now": true,    "execution_profile_ref": "premium-analysis@1",    "formats": [      "json",      "markdown"    ],    "kind": "analysis",    "profile_id": "prof_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",    "profile_version": 1,    "report_template_id": "tpl_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",    "report_template_version": 1,    "source_ids": [      "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"    ]  }'
{  "analysis": {    "execution_profile_ref": "premium-analysis@1",    "locale": "ja",    "request_id": "0190b5d4-7e1f-7a2b-9c3d-1234567890ab",    "source_ids": [      "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"    ],    "sub_state": "accepted"  },  "created_at": "2026-08-21T09:00:00.000Z",  "id": "run_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "kind": "analysis",  "status": "queued",  "updated_at": "2026-08-21T09:00:00.000Z"}