images

Initialize a image reference upload

Prepare a JPG, PNG or WebP reference upload up to 8 MiB. Use images_upload_sign_parts to get PUT URLs, upload the bytes, then call images_upload_complete and use its fileKey when generating.

post/actions/images_upload_initialize

Request

  • Base URL: https://api.voicecheap.ai/v1
  • URL: https://api.voicecheap.ai/v1/actions/images_upload_initialize
  • 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

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

filenamestring required

The image filename, with an extension matching contentType.

contentType'image/jpeg' | 'image/png' | 'image/webp' required
fileSizeinteger required

Exact file size in bytes, up to 8 MiB.

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.