GET
/
v1
/
image-projects
/
{id}
curl --request GET \
  --url https://api.magichour.ai/v1/image-projects/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "clx7uu86w0a5qp55yxz315r6r",
  "name": "Example Name",
  "status": "complete",
  "image_count": 1,
  "type": "AI_HEADSHOT",
  "created_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "total_frame_cost": 5,
  "downloads": [
    {
      "url": "https://videos.magichour.ai/id/output.png",
      "expires_at": "2024-10-19T05:16:19.027Z"
    }
  ],
  "error": null
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The id of the image project

Example:

"cm6pvghix03bvyz0zwash6noj"

Response

200
application/json

Success

id
string
required

Unique ID of the image. This value can be used in the get image project API to fetch additional details such as status

Example:

"clx7uu86w0a5qp55yxz315r6r"

name
string | null
required

The name of the image.

Example:

"Example Name"

status
enum<string>
required

The status of the image.

Available options:
draft,
queued,
rendering,
complete,
error,
canceled
Example:

"complete"

image_count
integer
required

Number of images generated

Example:

1

type
enum<string>
required
Available options:
AI_HEADSHOT,
AI_IMAGE,
IMAGE_UPSCALER,
FACE_SWAP,
PHOTO_EDITOR,
QR_CODE,
BACKGROUND_REMOVER,
CLOTHES_CHANGER
created_at
string
required
enabled
boolean
required

Indicates whether the resource is deleted

total_frame_cost
integer
required

The amount of frames used to generate the image.

Example:

5

downloads
object[]
required

The download url and expiration date of the image project

error
object | null
required

In the case of an error, this object will contain the error encountered during video render

Example:

null