Get image details
Get the details of a image project. The downloads
field will be empty unless the image was successfully rendered.
The image can be one of the following status
draft
- not currently usedqueued
- the job is queued and waiting for a GPUrendering
- the generation is in progresscomplete
- the image is successful createderror
- an error occurred during renderingcanceled
- image render is canceled by the user
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The id of the image project
"cm6pvghix03bvyz0zwash6noj"
Response
Success
Unique ID of the image. This value can be used in the get image project API to fetch additional details such as status
"clx7uu86w0a5qp55yxz315r6r"
The name of the image.
"Example Name"
The status of the image.
draft
, queued
, rendering
, complete
, error
, canceled
"complete"
Number of images generated
1
AI_HEADSHOT
, AI_IMAGE
, IMAGE_UPSCALER
, FACE_SWAP
, PHOTO_EDITOR
, QR_CODE
, BACKGROUND_REMOVER
, CLOTHES_CHANGER
Indicates whether the resource is deleted
The amount of frames used to generate the image.
5
The download url and expiration date of the image project
In the case of an error, this object will contain the error encountered during video render
null
Was this page helpful?