v47

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01360485.4 KB

Video Projects

Get video details

Check the progress of a video project. The downloads field is populated after a successful render.

Statuses

queued — waiting to start
rendering — in progress
complete — ready; see downloads
error — a failure occurred (see error)
canceled — user canceled
draft — not used

get/v1/video-projects/{id}

Path parameters

idstring required

Example:cuid-example

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

Response

Success

idstring required

Unique ID of the video. Use it with the Get video Project API to fetch status and downloads.

namestring nullable required

The name of the video.

The status of the video.

typestring required

The type of the video project. Possible values are ANIMATION, AUTO_SUBTITLE, VIDEO_TO_VIDEO, FACE_SWAP, TEXT_TO_VIDEO, IMAGE_TO_VIDEO, LIP_SYNC, TALKING_PHOTO, VIDEO_UPSCALER, VIDEO_EDITOR, CHARACTER_REPLACE, VIDEO_COLORIZER, EXTEND, AUDIO_TO_VIDEO, VIDEO_EXPANDER, UGC_AD

created_atstring date-time required

widthinteger required

The width of the final output video. A value of -1 indicates the width can be ignored.

heightinteger required

The height of the final output video. A value of -1 indicates the height can be ignored.

enabledboolean required

Whether this resource is active. If false, it is deleted.

start_secondsnumber float required

Start time of your clip (seconds). Must be ≥ 0.

end_secondsnumber float required

End time of your clip (seconds). Must be greater than start_seconds.

credits_chargedinteger required

The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video.

If video generation fails, credits will be refunded, and this field will be updated to include the refund.

fpsnumber 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 response

{
  "id": "cuid-example",
  "name": "Example Name",
  "status": "complete",
  "type": "FACE_SWAP",
  "width": 512,
  "height": 960,
  "end_seconds": 15,
  "credits_charged": 450,
  "fps": 30,
  "error": {
    "message": "Please use an image with a detectable face",
    "code": "no_source_face"
  },
  "downloads": [
    {
      "url": "https://videos.magichour.ai/id/output.mp4",
      "expires_at": "2024-10-19T05:16:19.027Z"
    }
  ]
}