Images

Upload a reference image

Changed on

Uploads a PNG, JPEG or WebP image (up to 20 MB) to use as a reference when generating images or videos. Returns an image_id to pass in reference_image_ids (or as a video start/end frame). Requires a valid X-API-KEY header.

Throws:

  • 400 if the file is not a PNG, JPEG or WebP image, or its dimensions are too large
  • 413 if the file is larger than 20 MB
post/image/upload

Request

Request body multipart/form-data

imagestring binary required

PNG, JPEG or WebP image, up to 20 MB

Response

Successful Response

image_idstring uuid required

Pass this ID in reference_image_ids when generating

widthinteger required

Image width in pixels

heightinteger required

Image height in pixels

Changes