Video Errored

curl --request POST \
  --url https://your-webhook.com/video.errored \
  --header 'Content-Type: application/json' \
  --header 'magic-hour-event-signature: <magic-hour-event-signature>' \
  --header 'magic-hour-event-timestamp: <magic-hour-event-timestamp>' \
  --data '
{
  "type": "video.errored",
  "payload": {
    "id": "cuid-example",
    "name": "Example Name",
    "status": "complete",
    "type": "FACE_SWAP",
    "created_at": "2023-11-07T05:31:56Z",
    "width": 512,
    "height": 960,
    "enabled": true,
    "start_seconds": 0,
    "end_seconds": 15,
    "total_frame_cost": 450,
    "credits_charged": 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"
    }
  }
}
'

{
  "message": "Success message from your endpoint"
}

POST

video.errored

Video Errored

curl --request POST \
  --url https://your-webhook.com/video.errored \
  --header 'Content-Type: application/json' \
  --header 'magic-hour-event-signature: <magic-hour-event-signature>' \
  --header 'magic-hour-event-timestamp: <magic-hour-event-timestamp>' \
  --data '
{
  "type": "video.errored",
  "payload": {
    "id": "cuid-example",
    "name": "Example Name",
    "status": "complete",
    "type": "FACE_SWAP",
    "created_at": "2023-11-07T05:31:56Z",
    "width": 512,
    "height": 960,
    "enabled": true,
    "start_seconds": 0,
    "end_seconds": 15,
    "total_frame_cost": 450,
    "credits_charged": 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"
    }
  }
}
'

{
  "message": "Success message from your endpoint"
}

Headers

magic-hour-event-signature

string

required

A signatured created with the webhook secret key and a signed_payload, using HMAC with SHA-256

Example:

"3e771b50c..."

magic-hour-event-timestamp

string

required

Time in seconds since the epoch. Use this value to check whether the request is within a reasonable window of the current time. Usually less than 5 minutes.

Example:

"1730742038"

Body

application/json

Body

type

enum<string>

required

Available options:

video.errored

payload

object

required

Success

Show child attributes

payload.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:

"cuid-example"

payload.name

string | null

required

The name of the video.

Example:

"Example Name"

payload.status

enum<string>

required

The status of the video.

Available options:

draft,

queued,

rendering,

complete,

error,

canceled

Example:

"complete"

payload.type

string

required

The type of the video project. Possible values are ANIMATION, IMAGE_TO_VIDEO, VIDEO_TO_VIDEO, TEXT_TO_VIDEO, FACE_SWAP, LIP_SYNC, AUTO_SUBTITLE, TALKING_PHOTO

Example:

"FACE_SWAP"

payload.created_at

string<date-time>

required

payload.width

integer

required

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

Example:

512

payload.height

integer

required

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

Example:

960

payload.enabled

boolean

required

Indicates whether the resource is deleted

payload.start_seconds

number<float>

required

The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.

Required range: x >= 0

Example:

0

payload.end_seconds

number<float>

required

The end time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_seconds.

Required range: x >= 0.1

Example:

15

payload.total_frame_cost

integer

required

deprecated

Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.

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

payload.credits_charged

integer

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.

Example:

450

payload.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

payload.error

object

required

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

Show child attributes

payload.error.message

string

required

Details on the reason why a failure happened.

Example:

"Please use an image with a detectable face"

payload.error.code

string

required

An error code to indicate why a failure happened.

Example:

"no_source_face"

Example:

null

payload.downloads

object[]

required

Show child attributes

payload.downloads.url

string<uri>

required

Example:

"https://videos.magichour.ai/id/output.mp4"

payload.downloads.expires_at

string<date-time>

required

Example:

"2024-10-19T05:16:19.027Z"

payload.download

object

required

deprecated

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

Show child attributes

payload.download.url

string<uri>

required

Example:

"https://videos.magichour.ai/id/output.mp4"

payload.download.expires_at

string<date-time>

required

Example:

"2024-10-19T05:16:19.027Z"

Response

Success

message

string

required

Example:

"Success message from your endpoint"

Video Completed Image Started

⌘I

Video Events

Image Events

Audio Events

Video Errored

Headers

Body

Response