Skip to main content
POST
Generate an image for the connected account. Uses the same media allowance and safeguards as the web app. Save the returned generationId and use images_download to retrieve the image. Reuse requestId when retrying the same request.

​
Authentication and permissions

​
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:write. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

​
Parameters

​
string
Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.Format: “uuid”. Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
​
string
required
Text value.Minimum length: 10. Maximum length: 1200.
​
string
Text value.Allowed values: “square”, “landscape”, “portrait”. Default: “square”.
​
string
An uploaded JPG, PNG or WebP object key under uploads/{yourUserId}/. Remote URLs are not accepted.Minimum length: 1. Maximum length: 512.
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.

​
Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically. Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

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

​
Response

This operation returns HTTP 202 while running. Save requestId and poll action_request_get with that identifier and the original operation name. Polling states are running, completed, failed, and interrupted. A completed result can point to a separate media job; continue with the operation-specific status or output action. Final generation metadata returned by the handler after image generation finishes. No image bytes, previewDataUrl, or download URL are included.

​
Result fields

​
Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.
HTTP 200

​
Operation notes

  • Requires images:write. The prompt is trimmed and must contain 10–1200 characters; it is also normalized before generation. aspectRatio is square by default and also accepts landscape or portrait. At most one referenceImageKey is accepted.
  • This is a long-running action. The initial API/MCP response normally reports running; poll action_request_get with operation images_generate and the same requestId to obtain the final result shown here.
  • Uses the account’s normal daily image-generation allowance. Generated account images expire seven days after creation; download the result before expiresAt.
  • This action uses the connected user’s own creations and uploads, including when the credential is connected in a team context.
  • Reference keys must point to completed uploads under uploads/{yourUserId}/ and end in .jpg, .jpeg, .png, or .webp. Remote URLs, other users’ keys, traversal segments, backslashes, percent escapes, query strings, fragments, and control characters are rejected.
  • Each reference must be non-empty, at most 8 MiB (8,388,608 bytes), decode as the image type identified by its extension, and measure 128–4096 pixels on each side. Decoded pixel counts are bounded as well. An uploaded reference remains reusable; these generation actions do not consume or delete its uploaded file.
  • Use a UUID v4 requestId, or the HTTP Idempotency-Key header, and reuse it with identical inputs when retrying. The integration layer records each mutation and returns its recorded state or result without rerunning it. A failed or interrupted request is not automatically retried.
  • Only one image may be generated for this user at a time. Use images_list and images_get to inspect creation state, and images_download for PNG bytes. The generation identifier is an opaque string; do not replace it with requestId.

​
Usage

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

​
Errors