> ## 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.

# List generated images

> List the connected account’s generated images, newest first. Includes status, dimensions and expiration; use nextCursor for the next page.

List the connected account’s generated images, newest first. Includes status, dimensions and expiration; use nextCursor for the next page.

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

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `images:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

<ParamField body="limit" type="integer">
  Integer value.

  Minimum: 1. Maximum: 100. Default: 20.
</ParamField>

<ParamField body="cursor" type="string">
  The nextCursor from the previous page.

  Minimum length: 1. Maximum length: 512.
</ParamField>

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

  ```json theme={null}
  {
    "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
  }
  ```
</Accordion>

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

<RequestExample>
  ```bash cURL theme={null}
  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}'
  ```

  ```javascript JavaScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</RequestExample>

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

A page of the connected user’s app-generated image metadata, newest first. An empty history returns items: \[] and nextCursor: null.

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

## Result fields

| Field | Description |
| - | - |
| `data.items` | Array of image metadata objects. |
| `data.items[].generationId` | Identifier to pass unchanged to images\_get or images\_download. |
| `data.items[].status` | pending, completed, failed, or expired. Expiry takes precedence over the stored status. |
| `data.items[].aspectRatio` | square, landscape, or portrait. |
| `data.items[].width` | Output width in pixels, or null before dimensions are available. |
| `data.items[].height` | Output height in pixels, or null before dimensions are available. |
| `data.items[].referenceImageCount` | Number of reference images used: 0 or 1. |
| `data.items[].createdAt` | Creation time in Unix milliseconds. |
| `data.items[].updatedAt` | Last update time in Unix milliseconds. |
| `data.items[].expiresAt` | Time in Unix milliseconds after which the generated image cannot be downloaded. |
| `data.nextCursor` | Opaque next-page cursor, or null when no additional page is available. |

## Operation notes

* Requires images:read. limit defaults to 20 and must be an integer from 1 to 100. cursor is optional and is limited to 512 characters.
* Pass nextCursor unchanged as cursor for the next page. nextCursor is null at the end; ordering uses creation time and generation identifier in descending order.
* This action uses the connected user’s own creations and uploads, including when the credential is connected in a team context.
* Records expose pending, completed, failed, or expired status. Dimensions can be null for unfinished or failed generations. Metadata may report expired before cleanup removes a record; it does not make the image downloadable.
* Only app-generated images belong to this history. Use images\_download for the image data; histories do not embed image bytes or preview URLs.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `INVALID_CURSOR` | cursor is not a valid history cursor; use the nextCursor returned by the previous page. |
| 400 | `VALIDATION_ERROR` | An argument is missing, has an unsupported value, exceeds its limit, or is not part of the strict input schema. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

```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.