すべてのエンドポイント

グループごとにメソッドとパスを見ます。管理用ルートは含みません。

セッション

get /v1/me

現在のユーザーと権限

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/system/status

現在の組織に有効なお知らせ、メンテナンス、機能の状態を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/system/capabilities

現在の組織のモデル設定と機能の利用状況

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

モデル

get /v1/models

利用可能なモデルと機能契約

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/models/{code}/price

モデルの販売価格

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
codepathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/models/{code}

モデルの詳細

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
codepathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/quotes

料金見積もり(課金なし)

モデル契約に沿ってパラメーターを検証し、課金やジョブ作成なしで料金を見積もります。本文は POST /v1/generations と共通です。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
project_idbodyanyOf任意
model_codebodystring必須
promptbodystring任意
negative_promptbodystring任意
paramsbodyobject任意
referencesbodyobject[]任意
countbodyinteger任意
sourcebodystudio|canvas|editor|api|pipeline|mcp|shots任意
idempotency_keybodystring任意
expected_quotebodyobject任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

プロジェクト

post /v1/organization-invite-links/access/preview

招待リンクを確認(ログインセッション)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Originheaderstring必須
x-lashot-expected-user-idheaderstring必須
tokenbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/organization-invite-links/access/receipt

元の招待の参加結果を確認(ログインセッション)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Originheaderstring必須
x-lashot-expected-user-idheaderstring必須
tokenbodystring必須
expected_org_idbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/organization-invite-links/access/accept

招待された組織への参加を確定(ログインセッション)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Originheaderstring必須
x-lashot-expected-user-idheaderstring必須
tokenbodystring必須
expected_org_idbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/organization-invite-links/access/enter

参加済みの組織に入る(ログインセッション)

Requires a fresh account session, a trusted Origin and the expected user identity. API keys are not accepted. The token is read from the JSON body and never cached.

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Originheaderstring必須
x-lashot-expected-user-idheaderstring必須
tokenbodystring必須
expected_org_idbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/organization-invite-links

組織の招待リンク一覧(管理者セッション)

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/organization-invite-links

組織の招待リンクを作成(管理者セッション)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
create_request_idbodystring必須
max_usesbodyinteger任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/organization-invite-links/{id}/copy

組織の招待リンクをコピー(管理者セッション)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/organization-invite-links/{id}/revoke

組織の招待リンクを無効化(管理者セッション)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/members

プロジェクトメンバーの権限を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/member-candidates

招待可能な組織メンバーを取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

put /v1/projects/{id}/members/{userId}

プロジェクトメンバーの権限を付与

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
userIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
access_revisionbodystring必須
idempotency_keybodystring必須
permissionbodyread|write|admin必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/projects/{id}/members/{userId}

プロジェクトメンバーの権限を取り消す

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
userIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
access_revisionbodystring必須
idempotency_keybodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects

プロジェクト一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
include_archivedquerytrue|false任意
limitqueryinteger任意
cursorquerystring任意前のページの next_cursor

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects

プロジェクト作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
kindbodygeneral|drama|commerce|quickcut任意
aspect_ratiobody16:9|9:16|1:1|4:3|3:4|21:9任意
style_presetbodystring任意
settingsbodyobject任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}

プロジェクトとアセットの統計

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/projects/{id}

revision によるプロジェクト更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring任意
kindbodygeneral|drama|commerce|quickcut任意
aspect_ratiobody16:9|9:16|1:1|4:3|3:4|21:9任意
style_presetbodyanyOf任意
cover_asset_idbodyanyOf任意
settingsbodyobject任意
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/projects/{id}

ごみ箱へ移動(30 日間保持)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
204成功、本文なし
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/archive

プロジェクトをアーカイブ

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/restore

アーカイブしたプロジェクトを復元

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/package/export

ワークスペース文書と元のメディアを書き出す

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/project-packages/inspect

パッケージの検証と概要の確認

Raw application/zip body; maximum 256 MiB.

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/project-packages/import

パッケージを新規プロジェクトとして読み込む

Raw application/zip body. X-Import-Key must be a stable UUID; optional X-Project-Name is URL-encoded. Always creates a new project and never overwrites another project.

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/batches

プロジェクトの一括処理を一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/batches

一括処理の下書きを作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
idpathstring必須
namebodystring必須
csvbodystring任意
databodyobject[]任意
mappingbodyobject任意
concurrencybodyinteger任意
template_version_idbodystring任意
template_idbodystring任意
idempotency_keybodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/batches/{id}

一括処理と各行の進捗を確認

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/batches/{id}/mapping

下書きの列対応を更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
idpathstring必須
model_codebodystring任意
model_columnbodystring任意
prompt_templatebodystring任意
variablesbodyobject任意
paramsbodyobject任意
parameter_columnsbodyobject任意
dependency_columnbodystring任意
dependency_rolebodyimage|first_frame|last_frame|style|subject|mask|control|audio|video|person|top_garment|bottom_garment任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/batches/{id}/precheck

資金を確保せず検証・見積もり

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/batches/{id}/start

確認済みの一括処理を開始

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
idpathstring必須
digestbodystring必須

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/batches/{id}/cancel

未実行行を中止し子タスクの中止を要求

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/batches/{id}/retry

失敗・中止行を再確認へ戻す

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
idpathstring必須
rowsbodyinteger[]任意
correctionsbodyobject[]任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/batches/{id}/errors.csv

エラー行を CSV で取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

ドキュメント

get /v1/projects/{id}/drama-plans

シリーズ企画案一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/projects/{id}/drama-plans

原文を保存し企画を作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
keybodystring必須
sourcebodyobject必須
contentbodyobject必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/projects/{id}/drama-plans/import

文書から脚本文字を抽出

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
bytesbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

get /v1/drama-plans/{id}

企画と変更履歴を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

patch /v1/drama-plans/{id}

版の競合を確認して保存

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger必須
contentbodyobject必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/publish

企画から制作用の各話を作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/quote

モデル企画処理の見積

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
keybodystring必須
revisionbodyinteger必須
operationbodyoutline|divide|episode|script必須
targetbodystring任意
instructionbodystring任意
modelbodystring必須
paramsbodyobject任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/operations

見積確認済みの企画処理を送信

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
inputbodyobject必須
quotebodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

get /v1/drama-plans/{id}/operations/{key}

企画候補と生成記録を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
keypathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/operations/{key}/resume

保存済み企画依頼を再開

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
keypathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/drama-plans/{id}/operations/{key}/review

企画候補を採用または却下

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
keypathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
acceptbodyboolean必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
413データが大きすぎます
429レート制限。Retry-After に従ってください
500内部サーバーエラー
502PROVIDER_ERROR
503MODEL_UNAVAILABLE
504PROVIDER_TIMEOUT

post /v1/projects/{id}/commands

競合保護付きドキュメントコマンド

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
command_idbodystring必須UUID
typebodystring必須
payloadbodyobject任意
base_revisionbodyinteger必須
idempotency_keybodystring必須UUID

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/canvas

キャンバス文書の取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/timeline

タイムライン文書の取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/scene3d

ステージ文書の取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/image

画像文書の取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/image/versions

画像文書の履歴一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
cursorquerystring任意前のページの next_cursor
limitqueryinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/image/versions/{versionId}

画像文書の履歴を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
versionIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/renders

FFmpeg タイムラインレンダリング

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
formatbodymp4|webm|wav|png_sequence任意
revisionbodyinteger任意
video_bitratebodyinteger任意
widthbodyinteger任意
heightbodyinteger任意
fpsbodyinteger任意
idempotency_keybodystring任意

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/renders/{jobId}/cancel

未完了のタイムライン書き出しを中止

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
jobIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/renders/{jobId}

レンダリングジョブの取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
jobIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/exports

画像書き出しジョブ作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意
page_idbodystring任意UUID
widthbodyinteger任意
heightbodyinteger任意
modebodycontain|cover|stretch任意
formatbodypng|jpeg|webp任意
idempotency_keybodystring任意

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/exports/{jobId}/retry

固定した版で失敗した画像書き出しを再試行

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
jobIdpathstring必須

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/exports/{jobId}

画像書き出しジョブの取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
jobIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/templates

公式・チームテンプレート

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
kindquerycover|knowledge|poster|product|quote|event|social|story任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/templates

画像文書をテンプレートとして保存

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
codebodystring任意
namebodystring必須
kindbodycover|knowledge|poster|product|quote|event|social|story必須
documentbodyobject必須
variablesbodyobject[]任意
notebodystring任意
publish_sharedbodyboolean任意
idempotency_keybodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/templates/{id}

テンプレートと最新バージョン

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/templates/{templateId}/apply

画像文書へテンプレートを適用

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
templateIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
versionbodyinteger任意
variablesbodyobject任意
base_revisionbodyinteger必須
command_idbodystring任意
idempotency_keybodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/products

商品一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/products

商品作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
titlebodystring必須
brand_colorbodystring任意
logo_asset_idbodyanyOf任意
publish_sharedbodyboolean任意
idempotency_keybodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/products/{id}

商品と SKU の詳細

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/products/{id}

商品更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring任意
titlebodystring任意
brand_colorbodystring任意
logo_asset_idbodyanyOf任意
publish_sharedbodyboolean任意
idempotency_keybodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/products/{id}/skus

SKU とチャネル設定の作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
codebodystring必須
titlebodystring必須
hero_asset_idbodyanyOf任意
publish_sharedbodyboolean任意
idempotency_keybodystring任意
channel_presetsbodyobject[]任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/skus/{id}

SKU 更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
codebodystring任意
titlebodystring任意
hero_asset_idbodyanyOf任意
publish_sharedbodyboolean任意
idempotency_keybodystring任意
channel_presetsbodyobject[]任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/skus/{skuId}/exports

SKU の書き出し進捗とファイルを取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
skuIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/skus/{skuId}/apply

SKU をテンプレートへ適用・書き出し

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
skuIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
template_idbodystring必須
versionbodyinteger任意
variablesbodyobject任意
base_revisionbodyinteger必須
command_idbodystring任意
idempotency_keybodystring任意
export_channelsbodyboolean任意
layout_modebodyoriginal|adaptive任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/characters/{id}/reference-images

リビジョンを確認してキャラクターのデザイン参照を更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
reference_asset_idsbodystring[]必須
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/characters/{id}/versions

キャラクターの履歴を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/characters/{id}/versions/{version}/restore

キャラクターを新バージョンに復元

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
versionpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/scenes/{id}/reference-images

リビジョンを確認してシーンのデザイン参照を更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
reference_asset_idsbodystring[]必須
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/scenes/{id}/versions

シーンの履歴を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/scenes/{id}/versions/{version}/restore

シーンを新バージョンに復元

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
versionpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/props/{id}/reference-images

リビジョンを確認して小道具のデザイン参照を更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
reference_asset_idsbodystring[]必須
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/props/{id}/versions

小道具の履歴を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/props/{id}/versions/{version}/restore

小道具を新バージョンに復元

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
versionpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/episodes/{id}/shot-order

エピソード内のショット順を変更

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
shot_idsbodystring[]必須
previous_idsbodystring[]必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/characters/{id}

キャラクターを編集

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring任意
rolebodystring任意
appearancebodyanyOf任意
stylingbodyanyOf任意
personalitybodyanyOf任意
final_promptbodyanyOf任意
revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/characters/{id}

キャラクター資料を削除

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意
base_updated_atbodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/scenes/{id}

シーンを編集

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意
locationbodystring任意
time_of_daybodyanyOf任意
lightingbodyanyOf任意
final_promptbodyanyOf任意
promptbodyanyOf任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/scenes/{id}

シーン資料を削除

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意
base_updated_atbodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/props/{id}

小道具を編集

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
final_promptbodyanyOf任意
revisionbodyinteger任意
namebodystring任意
typebodystring任意
promptbodyanyOf任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/props/{id}

小道具資料を削除

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意
base_updated_atbodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/shots/{id}

ショットを取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/shots/{id}

ショットの説明とプロンプトを編集

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
character_idsbodystring[]任意
prop_idsbodystring[]任意
shot_typebodyanyOf任意
anglebodyanyOf任意
movementbodyanyOf任意
atmospherebodyanyOf任意
bgm_promptbodyanyOf任意
sfxbodyanyOf任意
first_frame_asset_idbodyanyOf任意
last_frame_asset_idbodyanyOf任意
scene_idbodyanyOf任意
base_updated_atbodystring任意
titlebodystring任意
descriptionbodyanyOf任意
duration_msbodyinteger任意
image_promptbodyanyOf任意
video_promptbodyanyOf任意
dialoguebodyobject[]任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/shots/{id}

ショットとテイク記録を削除

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意
base_updated_atbodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/episodes/{id}

エピソードとショット記録を削除

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger任意
base_updated_atbodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/characters/{id}/references

キャラクター参照画像を更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
reference_asset_idsbodystring[]必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/drama

プロジェクトのドラマを取得・作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/projects/{projectId}/drama

ドラマ情報の更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
titlebodystring任意
genrebodyanyOf任意
style_presetbodyanyOf任意
aspect_ratiobodystring任意
languagebodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/episodes

エピソード一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/episodes

エピソード作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
titlebodystring必須
source_textbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/episodes/{episodeId}

エピソードのタイトル・原文更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
episodeIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
titlebodystring任意
source_textbodyanyOf任意
script_textbodystring任意
resolutionbody720x1280|1080x1920任意
base_updated_atbodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/characters

キャラクター一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/characters

キャラクターと初版の作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
rolebodystring任意
appearancebodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/scenes

シーン設定一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/scenes

シーン設定作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
locationbodystring必須
time_of_daybodystring任意
lightingbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/props

小道具設定一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/props

小道具設定作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
typebodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/episodes/{episodeId}/shots

エピソードのショット一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
episodeIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/episodes/{episodeId}/shots

ショット作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
episodeIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
titlebodystring必須
descriptionbodystring任意
duration_msbodyinteger任意
scene_idbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/shots/{shotId}/takes

ショットのテイク一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
shotIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/shots/{shotId}/takes

ショットのテイク記録

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
shotIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
generation_idbodystring任意
asset_version_idbodystring必須
notebodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/takes/{takeId}/accept

採用するテイクを選択

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
takeIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/production/{operationId}/resume

確認済みで未開始の操作を再開

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
operationIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/pipelines/{id}/quality-evidence

生成・アラインメント・レビューの証跡を出力

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/quickcut/styles

制作のビジュアル・字幕スタイル一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/production/quote

自動編集の制作操作を見積もる

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
operationbodyalignment|research|stock|vision|critic|regenerate_scene|revise_script必須
model_codebodystring必須
scene_idbodystring任意
frame_asset_version_idbodystring任意
querybodystring任意
media_kindbodyimage|video任意
paramsbodyobject任意
idempotency_keybodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/production

見積を確認して制作操作を開始

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
operationbodyalignment|research|stock|vision|critic|regenerate_scene|revise_script必須
model_codebodystring必須
scene_idbodystring任意
frame_asset_version_idbodystring任意
querybodystring任意
media_kindbodyimage|video任意
paramsbodyobject任意
idempotency_keybodystring必須
quote_digestbodystring必須

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/pipelines/{id}/production/{operationId}

操作状況と保存済み結果を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
operationIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/production/{operationId}/accept

確認済みの制作結果を採用

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
operationIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/production/{operationId}/stock

ストック素材の利用許諾を確認して取込を依頼

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
operationIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
candidate_idbodystring必須
scene_idbodystring必須
license_acceptedbodyboolean必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/production/{operationId}/stock/attach

取込済みのストック素材をショットに適用

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
operationIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/resource-batches

人物画像・ショットの一括見積りを準備

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
kindbodycharacter_image|scene_image|prop_image|shot_take|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_prompt必須
target_idsbodystring[]必須
model_codebodystring必須
paramsbodyobject任意
idempotency_keybodystring必須

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/retry-failed

失敗した対象のみの再試行を作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
idempotency_keybodystring必須

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/steps/{n}/review

段階の結果を編集して続行

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
npathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger必須
changesbodyobject任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/skills/{id}/versions

指示のバージョン履歴を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/skills/{id}/fork

編集可能なチーム指示をコピー

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
bodybodystring任意
namebodystring任意
attachmentsbodyobject任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/skills/{id}

指示の新バージョンを保存

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revisionbodyinteger必須
bodybodystring必須
namebodystring任意
attachmentsbodyobject任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/resource-generations

素材画像・テイク・音声を生成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
kindbodycharacter_image|scene_image|prop_image|shot_take|speech|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_prompt必須
target_idbodystring必須
model_codebodystring必須
promptbodystring必須
paramsbodyobject任意
referencesbodyobject[]任意
idempotency_keybodystring必須

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/quickcut/archetypes

サンドボックスの自動編集テンプレート

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/skills

公式・チームのスキル一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/pipelines

プロジェクトのワークフロー一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/pipelines

ドラマ・自動編集ワークフロー作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
kindbodydrama|quickcut|commerce任意
paramsbodyobject任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/pipelines/{id}

ワークフローとステップの詳細

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/prompt-review

保存済み指示を適用するか現在のパイプライン本文を維持

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
generation_idbodystring必須
basebodyanyOf必須
decisionbodyapply|keep必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/pipelines/{id}/steps/{n}/quote

ステップの見積もりを確認

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
npathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/steps/{n}/approve-and-run

見積もりを承認して短編ドラマのステップを実行予約

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
npathstring必須

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/steps/{n}/execute

承認済みステップを実行予約

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
npathstring必須

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/pipelines/{id}/steps/{n}/prompt

モデルを呼ばずにプロンプトを構築

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
npathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/steps/{n}/confirm

有料ステップを確認(残高確保なし)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
npathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/pipelines/{id}/steps/{n}/apply

検証済みツール呼び出しを適用

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
npathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
argumentsbodyobject必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/voices

公式・チームの音声一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/music-tracks

公式・チームの BGM 一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{projectId}/speech-segments

プロジェクトの音声区間一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/speech-segments

音声区間作成(有料サービス呼び出しなし)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
projectIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
textbodystring必須
voice_idbodystring任意
request_idbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/speech-segments/{id}/synthesize

サンドボックス WAV 生成(実サービス未接続)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/shots/{shotId}/audio

ショット音声一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
shotIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/shots/{shotId}/audio

ショットに台詞・ナレーションを追加

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
shotIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
kindbodydialogue|narration必須
textbodystring必須
voice_idbodystring任意
speech_segment_idbodystring任意
asset_version_idbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/scene3d/captures

撮影結果と一時プレビューを一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
limitqueryinteger任意
cursorquerystring任意
scene_idquerystring任意
unmarkedquerytrue|false任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/scene3d/captures

シーンの版にカメラ撮影を登録

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
idbodystring必須
camera_idbodystring必須
time_msbodyinteger必須
asset_version_idbodystring必須
kindbodyimage|video必須
revisionbodyinteger必須
source_stage_node_idbodystring任意
scene_idbodystring任意
view_camerabodyobject任意
orbitbodyobject任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/scene3d/panorama

所有画像をパノラマとして設定

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
asset_version_idbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/stage/character-presets

ステージのキャラクタープリセット

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/stage/pose-presets

ステージのポーズプリセット

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/episodes/{episodeId}/assemble

採用テイクと字幕をタイムラインへ配置

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
episodeIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
shot_idsbodystring[]任意
music_asset_version_idbodystring任意
modebodyappend|replace任意
base_revisionbodyinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

アセット

get /v1/share/{token}

リンクに紐づくメディア版を取得

パラメータ

名前位置型メモ
tokenpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/share/{token}/media

レビューリンクのメディアを取得

パラメータ

名前位置型メモ
tokenpathstring必須

レスポンス

ステータスメモ
200成功
206OK
304No content
400リクエストパラメーターが無効
404リソースが見つかりません
416No content
422CONTENT_BLOCKED / PROVIDER_REJECTED
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/share/{token}/comments

レビューリンクからコメント

パラメータ

名前位置型メモ
tokenpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
author_namebodystring必須
bodybodystring必須
anchorbodyobject任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/share/{token}/approval

訪問者承認が有効な版を判定

パラメータ

名前位置型メモ
tokenpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
author_namebodystring必須
decisionbodyapproved|changes_requested必須
version_hashbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{projectId}/shared-copies

組織カタログの素材をプロジェクトにコピー

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
projectIdpathstring必須
asset_idsbodystring[]必須
idempotency_keybodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/asset-versions/{versionId}/content

認証されたメディアを取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
versionIdpathstring必須

レスポンス

ステータスメモ
200成功
206OK
304No content
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
416No content
422CONTENT_BLOCKED / PROVIDER_REJECTED
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/assets/imports

アセット取り込み一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
statusquerypending|downloading|succeeded|failed任意
limitqueryinteger任意
cursorquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/imports

公開 HTTPS URL からアセットを取り込む

非同期アセット取り込みを作成し 202 を返します。公開 HTTPS のみ使用可能です。内部ネットワーク等は URL_BLOCKED となります。同じ組織・source_url は 24 時間再利用されます。url は必須、project_id と name は任意です。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
urlbodystring必須
project_idbodyanyOf任意
namebodystring任意
kindbodyimage|video|audio|font|subtitle|model3d|document|bundle任意

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/assets/imports/{id}

アセット取り込みの取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/multipart

分割アップロードを作成・再開

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
project_idbodystring必須
mimebodystring必須
byte_sizebodyinteger必須
content_hashbodystring必須
namebodystring必須
idempotency_keybodystring必須

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/assets/multipart/{id}

パート受領と完了状態を確認

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/assets/multipart/{id}

分割アップロードを中止・削除確認

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/multipart/{id}/parts

未送信パートの URL を発行

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
part_numberbodyinteger必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/multipart/{id}/parts/complete

パート受領を検証・保存

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
part_numberbodyinteger必須
etagbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/multipart/{id}/complete

パートを結合しファイルを検証

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/uploads

アップロード URL 作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
request_idbodystring任意
project_idbodyanyOf任意
mimebodystring必須
byte_sizebodyinteger必須

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/uploads/{intentId}/resume

同じアップロードの復元または更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
intentIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/uploads/{intentId}/complete

アップロード完了とバージョン登録

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
intentIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring任意
tagsbodystring[]任意
asset_idbodystring任意

レスポンス

ステータスメモ
200成功
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
413データが大きすぎます
415error
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/assets

アセット一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
project_idquerystring任意
kindquerystring任意
tagquerystring任意
qquerystring任意
search_tagsquerytrue|false任意
trashquerytrue|false任意
limitqueryinteger任意
cursorquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/assets/{id}

アセット詳細・バージョン・来歴

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/assets/{id}

アセット名・タグの更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring任意
tagsbodystring[]任意
current_version_idbodystring任意
rightsbodyobject任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/assets/{id}

アセットをごみ箱へ移動

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
forcequerytrue|false任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/assets/{id}/url

一時ダウンロード URL

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
version_idquerystring任意
downloadquerytrue|false任意
expires_inqueryinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/{id}/restore

ごみ箱からアセットを復元

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/assets/{id}/frames

先頭・末尾・指定時刻のフレーム抽出

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
positionbodystart|end|ms必須
at_msbodyinteger任意
version_idbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/asset-versions/{versionId}/url

過去バージョンの一時 URL

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
versionIdpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/fonts

再配布可能なフォント一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
project_idquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/fonts/subset

フォントのサブセットをキャッシュ

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
familybodystring必須
textbodystring必須
weightbodyregular|medium|bold任意
project_idbodystring任意
asset_version_idbodystring任意
source_hashbodystring任意
include_sourcebodyboolean任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/review-targets

レビュー対象の版と納品素材を一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
purposequeryreview|delivery任意
qquerystring任意
cursorquerystring任意
limitqueryinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/shares

レビューリンク、コメント、判定を一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/shares

版に紐づくレビューリンクを作成

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
target_typebodyasset|timeline|render|image_doc必須
target_idbodystring必須
media_version_idbodystring任意
titlebodystring必須
expires_atbodystring必須
allow_commentbodyboolean任意
allow_approvalbodyboolean任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/projects/{id}/shares/{shareId}

レビューリンクを無効化・期限変更

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
shareIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
revokebodyboolean任意
expires_atbodystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/shares/{shareId}/approval

対象の版を承認・修正依頼

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
shareIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
author_namebodystring必須
decisionbodyapproved|changes_requested必須
version_hashbodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/projects/{id}/review-comments/{commentId}

コメントを解決・再開

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
commentIdpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
resolvedbodyboolean必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/projects/{id}/deliveries

ZIP 納品タスクを一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/projects/{id}/deliveries

固定済みの素材版を梱包

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
version_idsbodystring[]必須
idempotency_keybodystring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

生成

get /v1/generations

生成履歴一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
project_idquerystring任意
idempotency_keyquerystring任意
statusquerystring任意
limitqueryinteger任意
cursorquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/generations

生成ジョブ作成(見積もり・残高確保・キュー)

Studio 用の統一リクエストです。外部連携には /v1/images/generations または /v1/videos/generations を推奨します。同じ Idempotency-Key の再送は 200 と replayed=true を返します。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
project_idbodyanyOf任意
model_codebodystring必須
promptbodystring任意
negative_promptbodystring任意
paramsbodyobject任意
referencesbodyobject[]任意
countbodyinteger任意
sourcebodystudio|canvas|editor|api|pipeline|mcp|shots任意
idempotency_keybodystring任意
expected_quotebodyobject任意

レスポンス

ステータスメモ
200成功
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/generations/{id}

生成ジョブと出力の詳細

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/generations/{id}/cancel

生成キャンセル(プロバイダー対応時)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

ジョブ

get /v1/jobs

ジョブ一覧

id は生成 ID です。署名 URL は expand=outputs 指定時のみ返します。既定 20 件、最大 100 件です。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
project_idquerystring任意
statusquerystring任意
modelquerystring任意
key_idquerystring任意
limitqueryinteger任意
cursorquerystring任意
expandquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/jobs/{id}

生成 ID でジョブを取得

公開 id は生成 ID です。内部ジョブ ID も解決できます。出力 URL の有効期限は 1 時間。費用は quoted・reserved・charged の販売額です。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/jobs/{id}/cancel

ジョブのキャンセル

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/jobs/{id}/events

ジョブイベントストリーム(SSE)

GET /v1/generations/:id/events と共通で、id は生成 ID です。イベント受信後にジョブを再取得してください。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

画像

post /v1/images/generations

画像生成ジョブ作成

model・prompt・n・size・aspect_ratio・quality・seed・references を指定します。n は count、size/seed は params に変換します。比率・品質には契約の対応が必要です。参照は asset_id・version_id・role を使用でき、URL 取り込みは最大 20 秒待機します。応答は object=job、待機中の outputs は空です。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
modelbodystring必須モデル一覧のモデルコード
promptbodystring任意
nbodyinteger任意出力枚数。count に対応
sizebodystring任意params.size に設定
aspect_ratiobodystring任意契約の ratio または aspect_ratio に対応
qualitybodystring任意契約の quality に対応
seedbodyinteger任意params.seed に設定
referencesbodyobject[]任意
project_idbodyanyOf任意
negative_promptbodystring任意
expected_quotebodyobject任意

レスポンス

ステータスメモ
200成功
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/images/edits

画像編集ジョブ作成

画像生成と同じ本文ですが、references[].role の少なくとも一つは image または mask が必要です。モデル契約の対応も必要です。ジョブ形式で返します。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
modelbodystring必須モデル一覧のモデルコード
promptbodystring任意
nbodyinteger任意出力枚数。count に対応
sizebodystring任意params.size に設定
aspect_ratiobodystring任意契約の ratio または aspect_ratio に対応
qualitybodystring任意契約の quality に対応
seedbodyinteger任意params.seed に設定
referencesbodyobject[]任意
project_idbodyanyOf任意
negative_promptbodystring任意
expected_quotebodyobject任意

レスポンス

ステータスメモ
200成功
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

動画

post /v1/videos/generations

動画生成ジョブ作成

model・prompt・duration_s・resolution・aspect_ratio・audio・seed・references を指定します。時長は契約の単位に換算し、比率は ratio/aspect_ratio に変換します。非対応の audio は無視し warnings を返します。参照 URL は最大 20 秒待機します。応答はジョブと warnings です。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
modelbodystring必須モデル一覧のモデルコード
promptbodystring任意
duration_sbodyinteger任意秒数。契約の duration/duration_s と単位に換算
resolutionbodystring任意params.resolution に設定
aspect_ratiobodystring任意契約の ratio または aspect_ratio に対応
audiobodyboolean任意モデル対応時に設定。非対応時は warnings
seedbodyinteger任意params.seed に設定
referencesbodyobject[]任意
project_idbodyanyOf任意
negative_promptbodystring任意
expected_quotebodyobject任意

レスポンス

ステータスメモ
200成功
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/videos/extensions

動画・最終フレームから動画を延長

動画生成と同じ本文ですが、references[].role の少なくとも一つは video または last_frame が必要です。非対応の場合は MODEL_CAPABILITY_UNSUPPORTED を返します。応答はジョブと warnings です。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
modelbodystring必須モデル一覧のモデルコード
promptbodystring任意
duration_sbodyinteger任意秒数。契約の duration/duration_s と単位に換算
resolutionbodystring任意params.resolution に設定
aspect_ratiobodystring任意契約の ratio または aspect_ratio に対応
audiobodyboolean任意モデル対応時に設定。非対応時は warnings
seedbodyinteger任意params.seed に設定
referencesbodyobject[]任意
project_idbodyanyOf任意
negative_promptbodystring任意
expected_quotebodyobject任意

レスポンス

ステータスメモ
200成功
202待機中。ジョブ照会またはイベント購読を利用
400リクエストパラメーターが無効
401未認証または API キー無効
402残高・割り当て不足
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

イベント

get /v1/events

組織のイベントストリーム(SSE)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
project_idquerystring任意
generation_idquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/generations/{id}/events

生成イベントストリーム(SSE)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

課金

get /v1/billing/balance

残高・確保額・与信枠

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/billing/settings

残高不足通知のしきい値

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/billing/settings

残高不足通知の設定

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
low_balance_thresholdbodyanyOf必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/billing/ledger

変更不可の台帳(販売額のみ)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
typequerystring任意
limitqueryinteger任意
cursorquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/billing/channels

利用可能なチャージ方法

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/billing/topups

チャージ注文一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
limitqueryinteger任意
cursorquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/billing/topups

チャージ注文作成

Wechat Native は CNY と明示的な Idempotency-Key が必須です。同じ注文を復旧するためにキーを保持してください。ブラウザーの戻りだけでは入金は確定しません。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
amountbodyanyOf必須
channelbodystring必須
return_urlbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/billing/topups/{id}

元のチャージ注文と保存済み決済案内を取得

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/billing/topups/{id}/refresh

決済提供元に照会して検証済みの状態を反映

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/billing/topups/{id}/resume

元の微信決済注文を再開して決済案内を復旧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/billing/topups/{id}/cancel

未払いチャージ注文のキャンセル

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
409バージョン・冪等キー・状態の競合
429レート制限。Retry-After に従ってください
500内部サーバーエラー

利用量

get /v1/usage/overview

リクエストと精算済み利用額の概要

Defaults to the last seven days; maximum span is seven days, with inclusive UTC bounds. Failures are HTTP 4xx/5xx and failure_rate is null for zero requests. API keys see only their own calls and sales; project-bound keys additionally restrict attributed jobs and sales to their project. Unattributed calls remain limited to the requesting key.

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
fromquerystring任意
toquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/usage

利用量と販売額の集計

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
fromquerystring任意
toquerystring任意
group_byquerystring任意
project_idquerystring任意
model_codequerystring任意
key_idquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/usage/export.csv

利用量を UTF-8 BOM CSV へ出力

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
fromquerystring任意
toquerystring任意
group_byquerystring任意
project_idquerystring任意
model_codequerystring任意
key_idquerystring任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/usage/requests

組織の API リクエストログ

既定は過去 24 時間、最大 7 日間です。それ以上はエクスポートしてください。status は 2xx・4xx・5xx または HTTP ステータスを指定できます。

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
key_idquerystring任意
routequerystring任意
statusquerystring任意
fromquerystring任意
toquerystring任意
cursorquerystring任意前のページの next_cursor
limitqueryinteger任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

API キー

get /v1/api-keys

API キー一覧(ハッシュ除外)

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/api-keys

API キー作成(秘密値の表示は一度のみ)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring必須
scopesbodymodels:read|generations:write|generations:read|assets:read|assets:write|projects:read|projects:write|commands:write|billing:read|webhooks:write[]必須
project_idbodyanyOf任意
expires_in_daysbodyanyOf任意
ip_allowlistbodystring[]任意
environmentbodylive|test任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/api-keys/{id}

API キーの権限・制限を更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
namebodystring任意
ip_allowlistbodystring[]任意
expires_in_daysbodyanyOf任意
scopesbodymodels:read|generations:write|generations:read|assets:read|assets:write|projects:read|projects:write|commands:write|billing:read|webhooks:write[]任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/api-keys/{id}

API キー失効

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
204成功、本文なし
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

Webhook

get /v1/webhooks

Webhook エンドポイント一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
limitqueryinteger任意
cursorquerystring任意前のページの next_cursor

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/webhooks

Webhook 作成(秘密値の表示は一度のみ)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
urlbodystring必須
eventsbodyjob.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[]必須
descriptionbodystring任意

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/webhooks/events

購読可能なイベント一覧

x-api-key ヘッダー、またはログイン中のセッションを使います。

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/webhooks/{id}

Webhook エンドポイント詳細

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

patch /v1/webhooks/{id}

Webhook エンドポイント更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
Idempotency-Keyheaderstring任意同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。
urlbodystring任意
eventsbodyjob.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[]任意
descriptionbodyanyOf任意
statusbodyactive|paused任意

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

delete /v1/webhooks/{id}

Webhook エンドポイント削除

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
204成功、本文なし
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/webhooks/{id}/rotate-secret

Webhook シークレットの更新

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/webhooks/{id}/test

ping テスト配信をキューへ追加

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須

レスポンス

ステータスメモ
201作成成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

get /v1/webhooks/{id}/deliveries

Webhook 配信履歴

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
statusquerypending|succeeded|failed任意
limitqueryinteger任意
cursorquerystring任意前のページの next_cursor

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

post /v1/webhooks/{id}/deliveries/{did}/redeliver

Webhook 配信を再試行

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
idpathstring必須
didpathstring必須

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー

監査

get /v1/audit

組織の監査ログ(秘密情報除去済み)

x-api-key ヘッダー、またはログイン中のセッションを使います。

パラメータ

名前位置型メモ
actionsquerystring任意カンマ区切りの操作名・接頭辞(auth、webhook.create 等)
fromquerystring任意created_at >= from の記録のみ
limitqueryinteger任意
cursorquerystring任意前のページの next_cursor

レスポンス

ステータスメモ
200成功
400リクエストパラメーターが無効
401未認証または API キー無効
403権限・スコープ・モデルへのアクセス拒否
404リソースが見つかりません
429レート制限。Retry-After に従ってください
500内部サーバーエラー