get /v1/me
現在のユーザーと権限
x-api-key ヘッダー、またはログイン中のセッションを使います。
レスポンス
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
グループごとにメソッドとパスを見ます。管理用ルートは含みません。
現在のユーザーと権限
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
現在の組織に有効なお知らせ、メンテナンス、機能の状態を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
現在の組織のモデル設定と機能の利用状況
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
利用可能なモデルと機能契約
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
モデルの販売価格
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
code | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
モデルの詳細
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
code | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
料金見積もり(課金なし)
モデル契約に沿ってパラメーターを検証し、課金やジョブ作成なしで料金を見積もります。本文は POST /v1/generations と共通です。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
project_id | body | anyOf | 任意 | |
model_code | body | string | 必須 | |
prompt | body | string | 任意 | |
negative_prompt | body | string | 任意 | |
params | body | object | 任意 | |
references | body | object[] | 任意 | |
count | body | integer | 任意 | |
source | body | studio|canvas|editor|api|pipeline|mcp|shots | 任意 | |
idempotency_key | body | string | 任意 | |
expected_quote | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
招待リンクを確認(ログインセッション)
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 ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Origin | header | string | 必須 | |
x-lashot-expected-user-id | header | string | 必須 | |
token | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
元の招待の参加結果を確認(ログインセッション)
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 ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Origin | header | string | 必須 | |
x-lashot-expected-user-id | header | string | 必須 | |
token | body | string | 必須 | |
expected_org_id | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
招待された組織への参加を確定(ログインセッション)
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 ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Origin | header | string | 必須 | |
x-lashot-expected-user-id | header | string | 必須 | |
token | body | string | 必須 | |
expected_org_id | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
参加済みの組織に入る(ログインセッション)
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 ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Origin | header | string | 必須 | |
x-lashot-expected-user-id | header | string | 必須 | |
token | body | string | 必須 | |
expected_org_id | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織の招待リンク一覧(管理者セッション)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織の招待リンクを作成(管理者セッション)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
create_request_id | body | string | 必須 | |
max_uses | body | integer | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織の招待リンクをコピー(管理者セッション)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織の招待リンクを無効化(管理者セッション)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトメンバーの権限を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
招待可能な組織メンバーを取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトメンバーの権限を付与
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
userId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
access_revision | body | string | 必須 | |
idempotency_key | body | string | 必須 | |
permission | body | read|write|admin | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトメンバーの権限を取り消す
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
userId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
access_revision | body | string | 必須 | |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクト一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
include_archived | query | true|false | 任意 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 | 前のページの next_cursor |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクト作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
kind | body | general|drama|commerce|quickcut | 任意 | |
aspect_ratio | body | 16:9|9:16|1:1|4:3|3:4|21:9 | 任意 | |
style_preset | body | string | 任意 | |
settings | body | object | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトとアセットの統計
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
revision によるプロジェクト更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 任意 | |
kind | body | general|drama|commerce|quickcut | 任意 | |
aspect_ratio | body | 16:9|9:16|1:1|4:3|3:4|21:9 | 任意 | |
style_preset | body | anyOf | 任意 | |
cover_asset_id | body | anyOf | 任意 | |
settings | body | object | 任意 | |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ごみ箱へ移動(30 日間保持)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
204 | 成功、本文なし |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトをアーカイブ
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アーカイブしたプロジェクトを復元
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ワークスペース文書と元のメディアを書き出す
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
パッケージの検証と概要の確認
Raw application/zip body; maximum 256 MiB.
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
パッケージを新規プロジェクトとして読み込む
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 | 内部サーバーエラー |
プロジェクトの一括処理を一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
一括処理の下書きを作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
id | path | string | 必須 | |
name | body | string | 必須 | |
csv | body | string | 任意 | |
data | body | object[] | 任意 | |
mapping | body | object | 任意 | |
concurrency | body | integer | 任意 | |
template_version_id | body | string | 任意 | |
template_id | body | string | 任意 | |
idempotency_key | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
一括処理と各行の進捗を確認
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
下書きの列対応を更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
id | path | string | 必須 | |
model_code | body | string | 任意 | |
model_column | body | string | 任意 | |
prompt_template | body | string | 任意 | |
variables | body | object | 任意 | |
params | body | object | 任意 | |
parameter_columns | body | object | 任意 | |
dependency_column | body | string | 任意 | |
dependency_role | body | image|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 | 内部サーバーエラー |
資金を確保せず検証・見積もり
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
確認済みの一括処理を開始
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
id | path | string | 必須 | |
digest | body | string | 必須 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
未実行行を中止し子タスクの中止を要求
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
失敗・中止行を再確認へ戻す
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
id | path | string | 必須 | |
rows | body | integer[] | 任意 | |
corrections | body | object[] | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
エラー行を CSV で取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シリーズ企画案一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
原文を保存し企画を作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
key | body | string | 必須 | |
source | body | object | 必須 | |
content | body | object | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
文書から脚本文字を抽出
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
bytes | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
企画と変更履歴を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
版の競合を確認して保存
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 必須 | |
content | body | object | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
企画から制作用の各話を作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
モデル企画処理の見積
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
key | body | string | 必須 | |
revision | body | integer | 必須 | |
operation | body | outline|divide|episode|script | 必須 | |
target | body | string | 任意 | |
instruction | body | string | 任意 | |
model | body | string | 必須 | |
params | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
見積確認済みの企画処理を送信
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
input | body | object | 必須 | |
quote | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
企画候補と生成記録を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
key | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
保存済み企画依頼を再開
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
key | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
企画候補を採用または却下
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
key | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
accept | body | boolean | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
413 | データが大きすぎます |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
502 | PROVIDER_ERROR |
503 | MODEL_UNAVAILABLE |
504 | PROVIDER_TIMEOUT |
競合保護付きドキュメントコマンド
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
command_id | body | string | 必須 | UUID |
type | body | string | 必須 | |
payload | body | object | 任意 | |
base_revision | body | integer | 必須 | |
idempotency_key | body | string | 必須 | UUID |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャンバス文書の取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
タイムライン文書の取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ステージ文書の取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像文書の取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像文書の履歴一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
cursor | query | string | 任意 | 前のページの next_cursor |
limit | query | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像文書の履歴を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
versionId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
FFmpeg タイムラインレンダリング
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
format | body | mp4|webm|wav|png_sequence | 任意 | |
revision | body | integer | 任意 | |
video_bitrate | body | integer | 任意 | |
width | body | integer | 任意 | |
height | body | integer | 任意 | |
fps | body | integer | 任意 | |
idempotency_key | body | string | 任意 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
未完了のタイムライン書き出しを中止
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
jobId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
レンダリングジョブの取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
jobId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像書き出しジョブ作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 | |
page_id | body | string | 任意 | UUID |
width | body | integer | 任意 | |
height | body | integer | 任意 | |
mode | body | contain|cover|stretch | 任意 | |
format | body | png|jpeg|webp | 任意 | |
idempotency_key | body | string | 任意 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
固定した版で失敗した画像書き出しを再試行
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
jobId | path | string | 必須 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像書き出しジョブの取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
jobId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
公式・チームテンプレート
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
kind | query | cover|knowledge|poster|product|quote|event|social|story | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像文書をテンプレートとして保存
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
code | body | string | 任意 | |
name | body | string | 必須 | |
kind | body | cover|knowledge|poster|product|quote|event|social|story | 必須 | |
document | body | object | 必須 | |
variables | body | object[] | 任意 | |
note | body | string | 任意 | |
publish_shared | body | boolean | 任意 | |
idempotency_key | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
テンプレートと最新バージョン
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像文書へテンプレートを適用
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
templateId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
version | body | integer | 任意 | |
variables | body | object | 任意 | |
base_revision | body | integer | 必須 | |
command_id | body | string | 任意 | |
idempotency_key | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
商品一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
商品作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
title | body | string | 必須 | |
brand_color | body | string | 任意 | |
logo_asset_id | body | anyOf | 任意 | |
publish_shared | body | boolean | 任意 | |
idempotency_key | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
商品と SKU の詳細
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
商品更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 任意 | |
title | body | string | 任意 | |
brand_color | body | string | 任意 | |
logo_asset_id | body | anyOf | 任意 | |
publish_shared | body | boolean | 任意 | |
idempotency_key | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
SKU とチャネル設定の作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
code | body | string | 必須 | |
title | body | string | 必須 | |
hero_asset_id | body | anyOf | 任意 | |
publish_shared | body | boolean | 任意 | |
idempotency_key | body | string | 任意 | |
channel_presets | body | object[] | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
SKU 更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
code | body | string | 任意 | |
title | body | string | 任意 | |
hero_asset_id | body | anyOf | 任意 | |
publish_shared | body | boolean | 任意 | |
idempotency_key | body | string | 任意 | |
channel_presets | body | object[] | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
SKU の書き出し進捗とファイルを取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
skuId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
SKU をテンプレートへ適用・書き出し
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
skuId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
template_id | body | string | 必須 | |
version | body | integer | 任意 | |
variables | body | object | 任意 | |
base_revision | body | integer | 必須 | |
command_id | body | string | 任意 | |
idempotency_key | body | string | 任意 | |
export_channels | body | boolean | 任意 | |
layout_mode | body | original|adaptive | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
リビジョンを確認してキャラクターのデザイン参照を更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
reference_asset_ids | body | string[] | 必須 | |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャラクターの履歴を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャラクターを新バージョンに復元
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
version | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
リビジョンを確認してシーンのデザイン参照を更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
reference_asset_ids | body | string[] | 必須 | |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シーンの履歴を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シーンを新バージョンに復元
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
version | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
リビジョンを確認して小道具のデザイン参照を更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
reference_asset_ids | body | string[] | 必須 | |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
小道具の履歴を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
小道具を新バージョンに復元
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
version | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
エピソード内のショット順を変更
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
shot_ids | body | string[] | 必須 | |
previous_ids | body | string[] | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャラクターを編集
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 任意 | |
role | body | string | 任意 | |
appearance | body | anyOf | 任意 | |
styling | body | anyOf | 任意 | |
personality | body | anyOf | 任意 | |
final_prompt | body | anyOf | 任意 | |
revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャラクター資料を削除
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 | |
base_updated_at | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シーンを編集
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 | |
location | body | string | 任意 | |
time_of_day | body | anyOf | 任意 | |
lighting | body | anyOf | 任意 | |
final_prompt | body | anyOf | 任意 | |
prompt | body | anyOf | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シーン資料を削除
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 | |
base_updated_at | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
小道具を編集
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
final_prompt | body | anyOf | 任意 | |
revision | body | integer | 任意 | |
name | body | string | 任意 | |
type | body | string | 任意 | |
prompt | body | anyOf | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
小道具資料を削除
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 | |
base_updated_at | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショットを取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショットの説明とプロンプトを編集
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
character_ids | body | string[] | 任意 | |
prop_ids | body | string[] | 任意 | |
shot_type | body | anyOf | 任意 | |
angle | body | anyOf | 任意 | |
movement | body | anyOf | 任意 | |
atmosphere | body | anyOf | 任意 | |
bgm_prompt | body | anyOf | 任意 | |
sfx | body | anyOf | 任意 | |
first_frame_asset_id | body | anyOf | 任意 | |
last_frame_asset_id | body | anyOf | 任意 | |
scene_id | body | anyOf | 任意 | |
base_updated_at | body | string | 任意 | |
title | body | string | 任意 | |
description | body | anyOf | 任意 | |
duration_ms | body | integer | 任意 | |
image_prompt | body | anyOf | 任意 | |
video_prompt | body | anyOf | 任意 | |
dialogue | body | object[] | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショットとテイク記録を削除
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 | |
base_updated_at | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
エピソードとショット記録を削除
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 任意 | |
base_updated_at | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャラクター参照画像を更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
reference_asset_ids | body | string[] | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトのドラマを取得・作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ドラマ情報の更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
title | body | string | 任意 | |
genre | body | anyOf | 任意 | |
style_preset | body | anyOf | 任意 | |
aspect_ratio | body | string | 任意 | |
language | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
エピソード一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
エピソード作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
title | body | string | 必須 | |
source_text | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
エピソードのタイトル・原文更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
episodeId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
title | body | string | 任意 | |
source_text | body | anyOf | 任意 | |
script_text | body | string | 任意 | |
resolution | body | 720x1280|1080x1920 | 任意 | |
base_updated_at | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャラクター一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
キャラクターと初版の作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
role | body | string | 任意 | |
appearance | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シーン設定一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シーン設定作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
location | body | string | 必須 | |
time_of_day | body | string | 任意 | |
lighting | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
小道具設定一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
小道具設定作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
type | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
エピソードのショット一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
episodeId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショット作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
episodeId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
title | body | string | 必須 | |
description | body | string | 任意 | |
duration_ms | body | integer | 任意 | |
scene_id | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショットのテイク一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
shotId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショットのテイク記録
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
shotId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
generation_id | body | string | 任意 | |
asset_version_id | body | string | 必須 | |
note | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
採用するテイクを選択
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
takeId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
確認済みで未開始の操作を再開
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
operationId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
生成・アラインメント・レビューの証跡を出力
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
制作のビジュアル・字幕スタイル一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
自動編集の制作操作を見積もる
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
operation | body | alignment|research|stock|vision|critic|regenerate_scene|revise_script | 必須 | |
model_code | body | string | 必須 | |
scene_id | body | string | 任意 | |
frame_asset_version_id | body | string | 任意 | |
query | body | string | 任意 | |
media_kind | body | image|video | 任意 | |
params | body | object | 任意 | |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
見積を確認して制作操作を開始
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
operation | body | alignment|research|stock|vision|critic|regenerate_scene|revise_script | 必須 | |
model_code | body | string | 必須 | |
scene_id | body | string | 任意 | |
frame_asset_version_id | body | string | 任意 | |
query | body | string | 任意 | |
media_kind | body | image|video | 任意 | |
params | body | object | 任意 | |
idempotency_key | body | string | 必須 | |
quote_digest | body | string | 必須 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
操作状況と保存済み結果を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
operationId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
確認済みの制作結果を採用
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
operationId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ストック素材の利用許諾を確認して取込を依頼
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
operationId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
candidate_id | body | string | 必須 | |
scene_id | body | string | 必須 | |
license_accepted | body | boolean | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
取込済みのストック素材をショットに適用
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
operationId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
人物画像・ショットの一括見積りを準備
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
kind | body | character_image|scene_image|prop_image|shot_take|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_prompt | 必須 | |
target_ids | body | string[] | 必須 | |
model_code | body | string | 必須 | |
params | body | object | 任意 | |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
失敗した対象のみの再試行を作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
段階の結果を編集して続行
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
n | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 必須 | |
changes | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
指示のバージョン履歴を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
編集可能なチーム指示をコピー
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
body | body | string | 任意 | |
name | body | string | 任意 | |
attachments | body | object | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
指示の新バージョンを保存
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revision | body | integer | 必須 | |
body | body | string | 必須 | |
name | body | string | 任意 | |
attachments | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
素材画像・テイク・音声を生成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
kind | body | character_image|scene_image|prop_image|shot_take|speech|character_prompt|scene_prompt|prop_prompt|shot_image_prompt|shot_video_prompt | 必須 | |
target_id | body | string | 必須 | |
model_code | body | string | 必須 | |
prompt | body | string | 必須 | |
params | body | object | 任意 | |
references | body | object[] | 任意 | |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
サンドボックスの自動編集テンプレート
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
公式・チームのスキル一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトのワークフロー一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ドラマ・自動編集ワークフロー作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
kind | body | drama|quickcut|commerce | 任意 | |
params | body | object | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ワークフローとステップの詳細
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
保存済み指示を適用するか現在のパイプライン本文を維持
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
generation_id | body | string | 必須 | |
base | body | anyOf | 必須 | |
decision | body | apply|keep | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ステップの見積もりを確認
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
n | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
見積もりを承認して短編ドラマのステップを実行予約
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
n | path | string | 必須 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
承認済みステップを実行予約
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
n | path | string | 必須 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
モデルを呼ばずにプロンプトを構築
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
n | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
有料ステップを確認(残高確保なし)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
n | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
検証済みツール呼び出しを適用
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
n | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
arguments | body | object | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
公式・チームの音声一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
公式・チームの BGM 一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
プロジェクトの音声区間一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
音声区間作成(有料サービス呼び出しなし)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
projectId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
text | body | string | 必須 | |
voice_id | body | string | 任意 | |
request_id | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
サンドボックス WAV 生成(実サービス未接続)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショット音声一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
shotId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ショットに台詞・ナレーションを追加
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
shotId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
kind | body | dialogue|narration | 必須 | |
text | body | string | 必須 | |
voice_id | body | string | 任意 | |
speech_segment_id | body | string | 任意 | |
asset_version_id | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
撮影結果と一時プレビューを一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 | |
scene_id | query | string | 任意 | |
unmarked | query | true|false | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
シーンの版にカメラ撮影を登録
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
id | body | string | 必須 | |
camera_id | body | string | 必須 | |
time_ms | body | integer | 必須 | |
asset_version_id | body | string | 必須 | |
kind | body | image|video | 必須 | |
revision | body | integer | 必須 | |
source_stage_node_id | body | string | 任意 | |
scene_id | body | string | 任意 | |
view_camera | body | object | 任意 | |
orbit | body | object | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
所有画像をパノラマとして設定
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
asset_version_id | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ステージのキャラクタープリセット
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ステージのポーズプリセット
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
採用テイクと字幕をタイムラインへ配置
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
episodeId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
shot_ids | body | string[] | 任意 | |
music_asset_version_id | body | string | 任意 | |
mode | body | append|replace | 任意 | |
base_revision | body | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
リンクに紐づくメディア版を取得
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
token | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
レビューリンクのメディアを取得
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
token | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
206 | OK |
304 | No content |
400 | リクエストパラメーターが無効 |
404 | リソースが見つかりません |
416 | No content |
422 | CONTENT_BLOCKED / PROVIDER_REJECTED |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
レビューリンクからコメント
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
token | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
author_name | body | string | 必須 | |
body | body | string | 必須 | |
anchor | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
訪問者承認が有効な版を判定
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
token | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
author_name | body | string | 必須 | |
decision | body | approved|changes_requested | 必須 | |
version_hash | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織カタログの素材をプロジェクトにコピー
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
projectId | path | string | 必須 | |
asset_ids | body | string[] | 必須 | |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
認証されたメディアを取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
versionId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
206 | OK |
304 | No content |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
416 | No content |
422 | CONTENT_BLOCKED / PROVIDER_REJECTED |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アセット取り込み一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
status | query | pending|downloading|succeeded|failed | 任意 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
公開 HTTPS URL からアセットを取り込む
非同期アセット取り込みを作成し 202 を返します。公開 HTTPS のみ使用可能です。内部ネットワーク等は URL_BLOCKED となります。同じ組織・source_url は 24 時間再利用されます。url は必須、project_id と name は任意です。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
url | body | string | 必須 | |
project_id | body | anyOf | 任意 | |
name | body | string | 任意 | |
kind | body | image|video|audio|font|subtitle|model3d|document|bundle | 任意 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アセット取り込みの取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
分割アップロードを作成・再開
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
project_id | body | string | 必須 | |
mime | body | string | 必須 | |
byte_size | body | integer | 必須 | |
content_hash | body | string | 必須 | |
name | body | string | 必須 | |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
パート受領と完了状態を確認
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
分割アップロードを中止・削除確認
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
未送信パートの URL を発行
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
part_number | body | integer | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
パート受領を検証・保存
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
part_number | body | integer | 必須 | |
etag | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
パートを結合しファイルを検証
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アップロード URL 作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
request_id | body | string | 任意 | |
project_id | body | anyOf | 任意 | |
mime | body | string | 必須 | |
byte_size | body | integer | 必須 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
同じアップロードの復元または更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
intentId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アップロード完了とバージョン登録
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
intentId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 任意 | |
tags | body | string[] | 任意 | |
asset_id | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
413 | データが大きすぎます |
415 | error |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アセット一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
project_id | query | string | 任意 | |
kind | query | string | 任意 | |
tag | query | string | 任意 | |
q | query | string | 任意 | |
search_tags | query | true|false | 任意 | |
trash | query | true|false | 任意 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アセット詳細・バージョン・来歴
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アセット名・タグの更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 任意 | |
tags | body | string[] | 任意 | |
current_version_id | body | string | 任意 | |
rights | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
アセットをごみ箱へ移動
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
force | query | true|false | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
一時ダウンロード URL
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
version_id | query | string | 任意 | |
download | query | true|false | 任意 | |
expires_in | query | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ごみ箱からアセットを復元
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
先頭・末尾・指定時刻のフレーム抽出
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
position | body | start|end|ms | 必須 | |
at_ms | body | integer | 任意 | |
version_id | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
過去バージョンの一時 URL
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
versionId | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
再配布可能なフォント一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
project_id | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
フォントのサブセットをキャッシュ
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
family | body | string | 必須 | |
text | body | string | 必須 | |
weight | body | regular|medium|bold | 任意 | |
project_id | body | string | 任意 | |
asset_version_id | body | string | 任意 | |
source_hash | body | string | 任意 | |
include_source | body | boolean | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
レビュー対象の版と納品素材を一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
purpose | query | review|delivery | 任意 | |
q | query | string | 任意 | |
cursor | query | string | 任意 | |
limit | query | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
レビューリンク、コメント、判定を一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
版に紐づくレビューリンクを作成
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
target_type | body | asset|timeline|render|image_doc | 必須 | |
target_id | body | string | 必須 | |
media_version_id | body | string | 任意 | |
title | body | string | 必須 | |
expires_at | body | string | 必須 | |
allow_comment | body | boolean | 任意 | |
allow_approval | body | boolean | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
レビューリンクを無効化・期限変更
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
shareId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
revoke | body | boolean | 任意 | |
expires_at | body | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
対象の版を承認・修正依頼
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
shareId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
author_name | body | string | 必須 | |
decision | body | approved|changes_requested | 必須 | |
version_hash | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
コメントを解決・再開
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
commentId | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
resolved | body | boolean | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ZIP 納品タスクを一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
固定済みの素材版を梱包
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
version_ids | body | string[] | 必須 | |
idempotency_key | body | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
生成履歴一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
project_id | query | string | 任意 | |
idempotency_key | query | string | 任意 | |
status | query | string | 任意 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
生成ジョブ作成(見積もり・残高確保・キュー)
Studio 用の統一リクエストです。外部連携には /v1/images/generations または /v1/videos/generations を推奨します。同じ Idempotency-Key の再送は 200 と replayed=true を返します。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
project_id | body | anyOf | 任意 | |
model_code | body | string | 必須 | |
prompt | body | string | 任意 | |
negative_prompt | body | string | 任意 | |
params | body | object | 任意 | |
references | body | object[] | 任意 | |
count | body | integer | 任意 | |
source | body | studio|canvas|editor|api|pipeline|mcp|shots | 任意 | |
idempotency_key | body | string | 任意 | |
expected_quote | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
生成ジョブと出力の詳細
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
生成キャンセル(プロバイダー対応時)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ジョブ一覧
id は生成 ID です。署名 URL は expand=outputs 指定時のみ返します。既定 20 件、最大 100 件です。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
project_id | query | string | 任意 | |
status | query | string | 任意 | |
model | query | string | 任意 | |
key_id | query | string | 任意 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 | |
expand | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
生成 ID でジョブを取得
公開 id は生成 ID です。内部ジョブ ID も解決できます。出力 URL の有効期限は 1 時間。費用は quoted・reserved・charged の販売額です。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ジョブのキャンセル
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ジョブイベントストリーム(SSE)
GET /v1/generations/:id/events と共通で、id は生成 ID です。イベント受信後にジョブを再取得してください。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像生成ジョブ作成
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-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
model | body | string | 必須 | モデル一覧のモデルコード |
prompt | body | string | 任意 | |
n | body | integer | 任意 | 出力枚数。count に対応 |
size | body | string | 任意 | params.size に設定 |
aspect_ratio | body | string | 任意 | 契約の ratio または aspect_ratio に対応 |
quality | body | string | 任意 | 契約の quality に対応 |
seed | body | integer | 任意 | params.seed に設定 |
references | body | object[] | 任意 | |
project_id | body | anyOf | 任意 | |
negative_prompt | body | string | 任意 | |
expected_quote | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
画像編集ジョブ作成
画像生成と同じ本文ですが、references[].role の少なくとも一つは image または mask が必要です。モデル契約の対応も必要です。ジョブ形式で返します。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
model | body | string | 必須 | モデル一覧のモデルコード |
prompt | body | string | 任意 | |
n | body | integer | 任意 | 出力枚数。count に対応 |
size | body | string | 任意 | params.size に設定 |
aspect_ratio | body | string | 任意 | 契約の ratio または aspect_ratio に対応 |
quality | body | string | 任意 | 契約の quality に対応 |
seed | body | integer | 任意 | params.seed に設定 |
references | body | object[] | 任意 | |
project_id | body | anyOf | 任意 | |
negative_prompt | body | string | 任意 | |
expected_quote | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
動画生成ジョブ作成
model・prompt・duration_s・resolution・aspect_ratio・audio・seed・references を指定します。時長は契約の単位に換算し、比率は ratio/aspect_ratio に変換します。非対応の audio は無視し warnings を返します。参照 URL は最大 20 秒待機します。応答はジョブと warnings です。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
model | body | string | 必須 | モデル一覧のモデルコード |
prompt | body | string | 任意 | |
duration_s | body | integer | 任意 | 秒数。契約の duration/duration_s と単位に換算 |
resolution | body | string | 任意 | params.resolution に設定 |
aspect_ratio | body | string | 任意 | 契約の ratio または aspect_ratio に対応 |
audio | body | boolean | 任意 | モデル対応時に設定。非対応時は warnings |
seed | body | integer | 任意 | params.seed に設定 |
references | body | object[] | 任意 | |
project_id | body | anyOf | 任意 | |
negative_prompt | body | string | 任意 | |
expected_quote | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
動画・最終フレームから動画を延長
動画生成と同じ本文ですが、references[].role の少なくとも一つは video または last_frame が必要です。非対応の場合は MODEL_CAPABILITY_UNSUPPORTED を返します。応答はジョブと warnings です。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
model | body | string | 必須 | モデル一覧のモデルコード |
prompt | body | string | 任意 | |
duration_s | body | integer | 任意 | 秒数。契約の duration/duration_s と単位に換算 |
resolution | body | string | 任意 | params.resolution に設定 |
aspect_ratio | body | string | 任意 | 契約の ratio または aspect_ratio に対応 |
audio | body | boolean | 任意 | モデル対応時に設定。非対応時は warnings |
seed | body | integer | 任意 | params.seed に設定 |
references | body | object[] | 任意 | |
project_id | body | anyOf | 任意 | |
negative_prompt | body | string | 任意 | |
expected_quote | body | object | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
202 | 待機中。ジョブ照会またはイベント購読を利用 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
402 | 残高・割り当て不足 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織のイベントストリーム(SSE)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
project_id | query | string | 任意 | |
generation_id | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
生成イベントストリーム(SSE)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
残高・確保額・与信枠
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
残高不足通知のしきい値
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
残高不足通知の設定
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
low_balance_threshold | body | anyOf | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
変更不可の台帳(販売額のみ)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
type | query | string | 任意 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
利用可能なチャージ方法
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
チャージ注文一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
limit | query | integer | 任意 | |
cursor | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
チャージ注文作成
Wechat Native は CNY と明示的な Idempotency-Key が必須です。同じ注文を復旧するためにキーを保持してください。ブラウザーの戻りだけでは入金は確定しません。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
amount | body | anyOf | 必須 | |
channel | body | string | 必須 | |
return_url | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
元のチャージ注文と保存済み決済案内を取得
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
決済提供元に照会して検証済みの状態を反映
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
元の微信決済注文を再開して決済案内を復旧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
未払いチャージ注文のキャンセル
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
409 | バージョン・冪等キー・状態の競合 |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
リクエストと精算済み利用額の概要
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 ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
from | query | string | 任意 | |
to | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
利用量と販売額の集計
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
from | query | string | 任意 | |
to | query | string | 任意 | |
group_by | query | string | 任意 | |
project_id | query | string | 任意 | |
model_code | query | string | 任意 | |
key_id | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
利用量を UTF-8 BOM CSV へ出力
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
from | query | string | 任意 | |
to | query | string | 任意 | |
group_by | query | string | 任意 | |
project_id | query | string | 任意 | |
model_code | query | string | 任意 | |
key_id | query | string | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織の API リクエストログ
既定は過去 24 時間、最大 7 日間です。それ以上はエクスポートしてください。status は 2xx・4xx・5xx または HTTP ステータスを指定できます。
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
key_id | query | string | 任意 | |
route | query | string | 任意 | |
status | query | string | 任意 | |
from | query | string | 任意 | |
to | query | string | 任意 | |
cursor | query | string | 任意 | 前のページの next_cursor |
limit | query | integer | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
API キー一覧(ハッシュ除外)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
API キー作成(秘密値の表示は一度のみ)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 必須 | |
scopes | body | models:read|generations:write|generations:read|assets:read|assets:write|projects:read|projects:write|commands:write|billing:read|webhooks:write[] | 必須 | |
project_id | body | anyOf | 任意 | |
expires_in_days | body | anyOf | 任意 | |
ip_allowlist | body | string[] | 任意 | |
environment | body | live|test | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
API キーの権限・制限を更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
name | body | string | 任意 | |
ip_allowlist | body | string[] | 任意 | |
expires_in_days | body | anyOf | 任意 | |
scopes | body | models: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 | 内部サーバーエラー |
API キー失効
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
204 | 成功、本文なし |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook エンドポイント一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
limit | query | integer | 任意 | |
cursor | query | string | 任意 | 前のページの next_cursor |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook 作成(秘密値の表示は一度のみ)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
url | body | string | 必須 | |
events | body | job.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[] | 必須 | |
description | body | string | 任意 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
購読可能なイベント一覧
x-api-key ヘッダー、またはログイン中のセッションを使います。
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook エンドポイント詳細
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook エンドポイント更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
Idempotency-Key | header | string | 任意 | 同じキーと本文は 24 時間再利用されます。本文の相違は 409 IDEMPOTENCY_MISMATCH、処理中は 409 IDEMPOTENCY_IN_FLIGHT と Retry-After: 1。キーなしの作成・課金リクエストは 10 分間重複排除されます。 |
url | body | string | 任意 | |
events | body | job.succeeded|job.failed|job.needs_reconciliation|job.cancelled|asset.imported|balance.low|review.comment.added|review.approval.added[] | 任意 | |
description | body | anyOf | 任意 | |
status | body | active|paused | 任意 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook エンドポイント削除
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
204 | 成功、本文なし |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook シークレットの更新
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
ping テスト配信をキューへ追加
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 |
| ステータス | メモ |
|---|---|
201 | 作成成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook 配信履歴
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
status | query | pending|succeeded|failed | 任意 | |
limit | query | integer | 任意 | |
cursor | query | string | 任意 | 前のページの next_cursor |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
Webhook 配信を再試行
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
id | path | string | 必須 | |
did | path | string | 必須 |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |
組織の監査ログ(秘密情報除去済み)
x-api-key ヘッダー、またはログイン中のセッションを使います。
| 名前 | 位置 | 型 | メモ | |
|---|---|---|---|---|
actions | query | string | 任意 | カンマ区切りの操作名・接頭辞(auth、webhook.create 等) |
from | query | string | 任意 | created_at >= from の記録のみ |
limit | query | integer | 任意 | |
cursor | query | string | 任意 | 前のページの next_cursor |
| ステータス | メモ |
|---|---|
200 | 成功 |
400 | リクエストパラメーターが無効 |
401 | 未認証または API キー無効 |
403 | 権限・スコープ・モデルへのアクセス拒否 |
404 | リソースが見つかりません |
429 | レート制限。Retry-After に従ってください |
500 | 内部サーバーエラー |