GET
/
v1
/
video-projects
/
{id}
curl --request GET \
  --url https://api.magichour.ai/v1/video-projects/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "clx7uu86w0a5qp55yxz315r6r",
  "name": "Example Name",
  "status": "complete",
  "type": "ANIMATION",
  "created_at": "2023-11-07T05:31:56Z",
  "width": 512,
  "height": 960,
  "enabled": true,
  "start_seconds": 0,
  "end_seconds": 15,
  "total_frame_cost": 450,
  "fps": 30,
  "error": null,
  "downloads": [
    {
      "url": "https://videos.magichour.ai/id/output.mp4",
      "expires_at": "2024-10-19T05:16:19.027Z"
    }
  ],
  "download": {
    "url": "https://videos.magichour.ai/id/output.mp4",
    "expires_at": "2024-10-19T05:16:19.027Z"
  }
}

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 video

Example:

"cm6pvghix03bvyz0zwash6noj"

Response

200
application/json

Success

​
id
string
required

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

Example:

"clx7uu86w0a5qp55yxz315r6r"

​
name
string | null
required

The name of the video.

Example:

"Example Name"

​
status
enum<string>
required

The status of the video.

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

"complete"

​
type
enum<string>
required
Available options:
ANIMATION,
IMAGE_TO_VIDEO,
VIDEO_TO_VIDEO,
TEXT_TO_VIDEO,
FACE_SWAP,
LIP_SYNC,
AUTO_SUBTITLE
​
created_at
string
required
​
width
integer
required

The width of the final output video. The maximum width depends on your subscription. Please refer to our pricing page for more details

Required range: x >= 64
Example:

512

​
height
integer
required

The height of the final output video. The maximum height depends on your subscription. Please refer to our pricing page for more details

Required range: x >= 64
Example:

960

​
enabled
boolean
required

Indicates whether the resource is deleted

​
start_seconds
number
required

The start time of the input video in seconds

Required range: x >= 0
Example:

0

​
end_seconds
number
required

The end time of the input video in seconds

Required range: x >= 0.1
Example:

15

​
total_frame_cost
integer
required

The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.

Example:

450

​
fps
number
required

Frame rate of the video. If the status is not 'complete', the frame rate is an estimate and will be adjusted when the video completes.

Example:

30

​
error
object | null
required

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

Example:

null

​
downloads
object[]
required

The download url and expiration date of the image project

​
download
object | null
requireddeprecated

Deprecated: Please use .downloads instead. The download url and expiration date of the video project

Was this page helpful?

Upload Asset URLsDelete video