curl --request POST 'https://api.voicecheap.ai/v1/actions/images_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/images_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
画像
生成画像を一覧表示
接続先アカウントが生成した画像を新しい順に一覧表示します。状態、寸法、有効期限が含まれます。次のページには nextCursor を使用してください。
POST
/
v1
/
actions
/
images_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/images_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"items": [
{
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
接続先アカウントが生成した画像を新しい順に一覧表示します。状態、寸法、有効期限が含まれます。次のページには nextCursor を使用してください。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/images_list
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
images:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
integer
整数値。最小値: 1. 最大値: 100. デフォルト値: 20.
string
前のページの nextCursor。最小文字数: 1. 最大文字数: 512.
完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"description": "The nextCursor from the previous page.",
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/images_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"limit":20}'
const input = {
limit: 20,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/images_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"limit": 20},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 接続済みユーザーがアプリで生成した画像メタデータの1ページ。新しい順。履歴が空の場合は items: [] と nextCursor: null を返します。{
"data": {
"items": [
{
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
],
"nextCursor": null
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.items | 画像メタデータオブジェクトの配列。 |
data.items[].generationId | images_get または images_download にそのまま渡す識別子。 |
data.items[].status | pending、completed、failed、expired のいずれか。有効期限切れは保存されたステータスより優先されます。 |
data.items[].aspectRatio | square、landscape、portrait のいずれか。 |
data.items[].width | 出力の幅（ピクセル）。サイズが利用可能になる前は null。 |
data.items[].height | 出力の高さ（ピクセル）。寸法が未取得の場合は null。 |
data.items[].referenceImageCount | 使用した参照画像数：0 または 1。 |
data.items[].createdAt | 作成時刻（Unix ミリ秒）。 |
data.items[].updatedAt | 最終更新時刻。Unix 時間のミリ秒単位。 |
data.items[].expiresAt | 生成画像をダウンロードできなくなる時刻（Unix ミリ秒）。 |
data.nextCursor | 不透明な次ページカーソル。次のページがない場合は null。 |
操作の注意事項
- images:read が必要です。limit のデフォルトは20で、1から100までの整数である必要があります。cursor は任意で、最大512文字です。
- 次のページでは、nextCursor を変更せず cursor として渡してください。最後は nextCursor が null になります。作成時刻と生成識別子の降順で並びます。
- 認証情報がチームのコンテキストで接続されている場合も、このアクションは接続ユーザー自身の作成物とアップロードを使用します。
- レコードは pending、completed、failed、expired の status を公開します。未完了または失敗した生成では、画像サイズが null の場合があります。クリーンアップでレコードが削除される前に、メタデータが expired を示す場合がありますが、画像をダウンロード可能にするものではありません。
- この履歴にはアプリで生成した画像だけが含まれます。画像データは images_download で取得してください。履歴には画像のバイトデータやプレビュー URL は埋め込まれていません。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | INVALID_CURSOR | cursor は有効な履歴カーソルではありません。前のページで返された nextCursor を使用してください。 |
| 400 | VALIDATION_ERROR | 引数が不足している、値が未対応、上限を超えている、または厳密な入力スキーマに含まれていません。 |
| 401 | API_KEY_EXPIRED | API キーの有効期限が切れています。 |
| 401 | INVALID_API_KEY | 有効期限内の有効な API キーを指定してください。 |
| 401 | INVALID_CREDENTIAL | Authorization ヘッダーの形式が不正、または x-api-key と競合しています。 |
| 401 | MISSING_CREDENTIAL | 利用可能なヘッダー認証情報が指定されていないか、4096文字を超えています。 |
| 401 | USER_NOT_FOUND | 認証情報に対応するアカウントはすでに存在しません。 |
| 403 | AMBIGUOUS_TEAM_API_KEY | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | INSUFFICIENT_SCOPE | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 月次リセットを待つか、プランを変更してください。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | INTERNAL_ERROR | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["images:read"]
}
}
このページは役に立ちましたか？