GET
/
v1
/
image-projects
/
{id}
Python
from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.image_projects.get(id="cuid-example")
{
  "id": "cuid-example",
  "name": "Example Name",
  "status": "complete",
  "image_count": 1,
  "type": "AI_IMAGE",
  "created_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "total_frame_cost": 5,
  "credits_charged": 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 <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Path Parameters

​
id
string
required

Unique ID of the image project. This value is returned by all of the POST APIs that create an image.

Example:

"cuid-example"

Response

200
application/json

Success