> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 画像生成の情報を取得

> 接続先アカウントが生成した画像の状態、寸法、有効期限を取得します。

接続先アカウントが生成した画像の状態、寸法、有効期限を取得します。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/images_get
```

## 認証と権限

<ParamField header="x-api-key" type="string" required>
  このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
  でのみ使用でき、この REST エンドポイントでは使用できません。
</ParamField>

必要な権限: `images:read`.

有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

## パラメーター

<ParamField body="generationId" type="string" required>
  生成または履歴アクションが返す生成 ID。

  パターン: `^[A-Za-z0-9_-]{1,128}$`.
</ParamField>

<Accordion title="完全な入力スキーマ">
  以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "generationId": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,128}$",
        "description": "Generation ID returned by a generation or history action."
      }
    },
    "required": ["generationId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/images_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"generationId":"6224018c7635dcb933ce5c8f7804aea73738dd1c"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    generationId: '6224018c7635dcb933ce5c8f7804aea73738dd1c',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/images_get', {
    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);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/images_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。

所有するアプリ画像の公開メタデータ。現在の status、サイズ、有効期限を含みます。画像データは別途取得します。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
      "status": "completed",
      "aspectRatio": "square",
      "width": 1024,
      "height": 1024,
      "referenceImageCount": 1,
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "expiresAt": 1792749600000
    }
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.generationId` | images\_get または images\_download にそのまま渡す識別子。 |
| `data.status` | pending、completed、failed、expired のいずれか。有効期限切れは保存されたステータスより優先されます。 |
| `data.aspectRatio` | square、landscape、portrait のいずれか。 |
| `data.width` | 出力の幅（ピクセル）。サイズが利用可能になる前は null。 |
| `data.height` | 出力の高さ（ピクセル）。寸法が未取得の場合は null。 |
| `data.referenceImageCount` | 使用した参照画像数：0 または 1。 |
| `data.createdAt` | 作成時刻（Unix ミリ秒）。 |
| `data.updatedAt` | 最終更新時刻。Unix 時間のミリ秒単位。 |
| `data.expiresAt` | 生成画像をダウンロードできなくなる時刻（Unix ミリ秒）。 |

## 操作の注意事項

* images:read が必要です。generationId は ASCII の英字、数字、アンダースコア、ハイフンからなる 1–128 文字である必要があります。
* 認証情報がチームのコンテキストで接続されている場合も、このアクションは接続ユーザー自身の作成物とアップロードを使用します。
* レコードの状態には pending、completed、failed、expired があります。幅と高さを取得できない場合は null です。レコードはクリーンアップで削除されるまで expired のまま表示される場合があります。get が成功しても、ダウンロードできるとは限りません。
* expiresAt より前に images\_download でPNGバイト列を取得してください。このアクションは previewDataUrl やメディアURLを返しません。

## 使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 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` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `IMAGE_NOT_FOUND` | 生成が存在しない、別のユーザーが所有している、またはアプリ画像ではありません。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["images:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.