images

Generate an image

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.

post/actions/images_generate

Request

  • Base URL: https://api.voicecheap.ai/v1
  • URL: https://api.voicecheap.ai/v1/actions/images_generate
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Headers

Idempotency-Keystring uuid

UUID v4 shared across retries of this action. Alternatively pass requestId in the JSON body.

Request body

requestIdstring uuid required

UUID v4 for this action. Reuse the same ID with identical arguments on retries.

promptstring required
aspectRatio'square' | 'landscape' | 'portrait'
referenceImageKeystring

An uploaded JPG, PNG or WebP object key under uploads/{yourUserId}/. Remote URLs are not accepted.

Response

Completed result or saved request state.

dataunknown required
requestIdstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.