Video Started

POST

video.started

curl --request POST \
  --url https://your-webhook.com/video.started \
  --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.started",
  "payload": {
    "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"
    }
  }
}'

{
  "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.started

payload

object

required

Success

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:

"clx7uu86w0a5qp55yxz315r6r"

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

enum<string>

required

Available options:

ANIMATION,

IMAGE_TO_VIDEO,

VIDEO_TO_VIDEO,

TEXT_TO_VIDEO,

FACE_SWAP,

LIP_SYNC,

AUTO_SUBTITLE

payload.created_at

string

required

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

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

payload.enabled

boolean

required

Indicates whether the resource is deleted

payload.start_seconds

number

required

The start time of the input video in seconds

Required range: x >= 0

Example:

0

payload.end_seconds

number

required

The end time of the input video in seconds

Required range: x >= 0.1

Example:

15

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

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 | null

required

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

Example:

null

payload.downloads

object[]

required

The download url and expiration date of the image project

payload.download

object | null

requireddeprecated

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

Response

200

application/json

Success

message

string

required

Example:

"Success message from your endpoint"

Was this page helpful?

Image Errored Video Completed

curl --request POST \
  --url https://your-webhook.com/video.started \
  --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.started",
  "payload": {
    "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"
    }
  }
}'

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

Image Events

Video Events

Headers

Body

Response