API リファレンス

DeepFrame v1alpha1 public APIです。alphaアクセスにはPublic API Alpha keyまたは既存のoperator発行alpha keyが必要です。

ベース URL

• https://api.deepframe.cloud
• https://api.dev.deepframe.cloud

認証

すべてのリクエストで、環境変数 DEEPFRAME_API_KEY の値を Authorization: Bearer ヘッダーで送信します:

Authorization: Bearer $DEEPFRAME_API_KEY

API の規約

APIキー

認証では Authorization: Bearer <API key> ヘッダーを使用します。API キーは有効化されており、自身の organization に属し、かつ alpha アクセス権限を持っている必要があります。ワークスペースの管理者は、最新の API 利用規約（Terms）に同意した後、DeepFrame の developer settings で Public API Alpha キーを作成できます。alphaトラフィックを許可するには、プラットフォーム管理者が先にワークスペースを明示的にオプトインする必要があります。

バージョニング

この alpha リビジョンでは互換性を保証しません。破壊的変更（breaking change）は v1alpha2 として提供されます。旧 alpha リビジョンには 30 日間の廃止（Sunset）期間が設けられ、Deprecation ヘッダーおよび Sunset ヘッダーによってレスポンス上で通知される場合があります。

エラー

Synchronous HTTP errors use RFC 9457 application/problem+json. HTTP 200 asynchronous resources use a nested error object with code, title, detail, and next_action; that object has no HTTP status member.

日時

リクエストおよびレスポンスのボディに含まれる日時は、明示的なオフセットを持つ RFC 3339 形式の UTC 文字列です（例: 2026-08-08T10:15:00.000Z）。例外として、独自の日付形式を使用する HTTP ヘッダー（Retry-After や Sunset）と、秒単位の Unix タイムスタンプを使用する Webhook の webhook-timestamp ヘッダーがあります。

ページネーション

リストを取得するエンドポイントでは、不透明（opaque）なカーソルを用いたページネーションを使用します。limit の既定値は 25、最大値は 100 です。取得した next_cursor の値は変更せずに、次のリクエストの cursor パラメータとして渡してください。

べき等性

変更を行う POST エンドポイントは Idempotency-Key を受け付けます。キーは 24 時間保持され、ワークスペースおよび送信先のルートごとにスコープが限定されます。異なるリクエストボディやパスで同じキーを再利用した場合は、再送ではなく拒否されます。

レート制限

認証済みレスポンスには X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset が含まれます。Public API Alpha におけるサーバー側の制限（バジェット）は、ワークスペース全体で 1 時間あたり 10,000 リクエストです。この制限はすべての alpha キーで共有されます。X-RateLimit-Limit はキーごとの実効バジェットを示し、X-RateLimit-Remaining はワークスペース全体の共有バジェットによっても制限されます。既存の operator が発行したキーには、これよりも厳しいキーごとの制限（per-key limit）が設定される場合があります。バジェットを使い切ると Retry-After を付けた 429 を返します。

Webhook

認証済みワークスペースは、video.indexed、video.failed、run.completed、run.failed、run.canceled イベント用の HTTPS エンドポイントを登録し、配信履歴を確認し、再配信を要求できます。

エンドポイント