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

# Download a generated image

> Retrieve an owned, unexpired image. Returns a PNG as base64 in data with its mimeType, or native image content over MCP. Images up to 8 MiB are supported.

Retrieve an owned, unexpired image. Returns a PNG as base64 in data with its mimeType, or native image content over MCP. Images up to 8 MiB are supported.

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

## Authentication and permissions

**x-api-key** `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.

Required permissions: `images:read`.

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

## Parameters

**generationId** `string` *required*

Generation ID returned by a generation or history action.

Pattern: `^[A-Za-z0-9_-]{1,128}$`.

> [accordion] 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": {
>     "generationId": {
>       "type": "string",
>       "pattern": "^[A-Za-z0-9_-]{1,128}$",
>       "description": "Generation ID returned by a generation or history action."
>     }
>   },
>   "required": ["generationId"],
>   "additionalProperties": false
> }
> ```

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

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_download' \
  --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_download', {
  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_download",
    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)
```

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

The generated PNG returned as a base64 string in data, accompanied by generationId and mimeType. This is a JSON object, not a binary HTTP body or download URL.

```json HTTP 200 theme={null}
{
  "data": {
    "generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
    "mimeType": "image/png",
    "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAACXBIWXMAAAPoAAAD6AG1e1JrAAAADElEQVQImWP4+vUrAAXCAuD7W1s+AAAAAElFTkSuQmCC"
  }
}
```

## Result fields

| Field | Description |
| - | - |
| `data.generationId` | Identifier of the downloaded generation. |
| `data.mimeType` | image/png. |
| `data.data` | Base64-encoded PNG bytes with no data: URL prefix. |

## Operation notes

* Requires images:read. generationId must contain 1–128 ASCII letters, digits, underscores, or hyphens.
* This action uses the connected user’s own creations and uploads, including when the credential is connected in a team context.
* Only a completed, owned app image with a stored file and expiresAt in the future is downloadable. Account images expire seven days after creation.
* The decoded PNG must be at most 8 MiB (8,388,608 bytes). Base64 encoding makes the JSON string larger than the binary file.
* Decode data as base64 to save the PNG. There is no data: URL prefix. Over MCP the server emits native image content and a text block containing generationId instead of this ordinary JSON result.

## 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 | `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. |
| 404 | `IMAGE_NOT_FOUND` | The image is missing, unowned, unfinished, failed, expired, or has no stored file. |
| 413 | `IMAGE_DOWNLOAD_TOO_LARGE` | The generated image exceeds the 8 MiB integration download limit. |
| 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 | `INTERNAL_ERROR` | The stored image could not be retrieved or decoded. Retry the download later. |
| 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.