image_projects_retrieve_details
Check the progress of a image project. The downloads field is populated after a successful render.
Statuses
queued— waiting to startrendering— in progresscomplete— ready; seedownloadserror— a failure occurred (seeerror)canceled— user canceleddraft— not used
MCP guidance:
Use this after a create tool to poll job status. When status is
complete, surface thedownloadsURLs to the user; if status iserror, surface the error message.Each
downloads[n].urlis already the full signed download URL. Use it exactly as returned. Do not shorten it, strip query parameters, or appendexpires_atonto the URL string.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique ID of the image project. This value is returned by all of the POST APIs that create an image. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique ID of the image. Use it with the [Get image Project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch status and downloads. | |
| name | Yes | The name of the image. | |
| type | Yes | The type of the image project. Possible values are FACE_EDITOR, AI_IMAGE_EDITOR, AI_SELFIE, AI_HEADSHOT, AI_INFLUENCER, AI_IMAGE, AI_MEME, CLOTHES_CHANGER, BACKGROUND_REMOVER, FACE_SWAP, IMAGE_UPSCALER, IMAGE_ENHANCER, AI_GIF, QR_CODE, PHOTO_EDITOR, PHOTO_COLORIZER, HEAD_SWAP, BODY_SWAP, STORYBOARD, IMAGE_EXPANDER | |
| error | Yes | In the case of an error, this object will contain the error encountered during video render | |
| status | Yes | The status of the image. - `draft` - the project was created but has not been submitted for rendering - `queued` - the job is waiting for an available server - `rendering` - the job is being processed; the `image.started` webhook event fires when rendering begins - `complete` - the job finished successfully; fires `image.completed` - `error` - the job failed during processing; fires `image.errored` - `canceled` - the job was manually canceled (for example from the Magic Hour web app) **Note:** `rendering`, `complete`, and `error` have matching webhook events; `canceled` does not - a canceled job emits no webhook event, so poll this endpoint to detect cancellation. | |
| enabled | Yes | Whether this resource is active. If false, it is deleted. | |
| downloads | Yes | ||
| created_at | Yes | ||
| image_count | Yes | Number of images generated | |
| credits_charged | Yes | The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund. |