Skip to main content
POST

Overview

Every create endpoint renders its project on its own once generation finishes, so you do not need this call to get a first video. Use it to render a project again:
  • after editing it in the Hooked editor, or through Edit Project (captions, music, logo);
  • after a render failed (video.status is FAILED).
The render uses the project’s current editor timeline and the aspect ratio set in the editor. It does not generate anything new: no script, voice or clips. The project must have finished generating. Each call creates a new video and answers its videoId. Follow it with Get Video Details, or pass a webhook: the project’s original webhook is not reused, so pass it again if you want a call for this render. Get Project shows the latest video under video.
Rendering costs no credits, for every team.

Errors

Each successful call starts a new render. Before retrying after a timeout or a 5xx, check Get Project to see whether a render already started.

Get Project

Project status and its latest video

Get Video Details

Follow the render by video ID

Webhooks

Payloads Hooked sends when a render ends

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Makes the request safe to retry. 1-255 printable ASCII characters, one per operation (your job id, or a UUID you store), reused on every retry. Within 24 hours the same key with the same body answers with the first response and the header Idempotent-Replayed: true, without running or charging again. Keys are scoped to your team and the endpoint. 5xx answers and refusals before anything ran (401, 402, 403, 409, 429) are not kept. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$

Body

application/json
projectId
string
required

A project of your team (the projectId a create endpoint answered). It must have finished generating.

Example:

"cm4x9k2p10001ab12cd34ef56"

webhook
string<uri>

HTTPS URL on a public host, called when this render completes or fails. The project's original webhook is not reused: pass it again to be called for this render. Requests are signed: verify the Hooked-Signature header (HMAC-SHA256 of ".") with the signing secret from Settings → Webhooks; Hooked-Event and Hooked-Delivery headers name the event and the delivery. No redirects are followed; 10 s timeout; 3 immediate attempts. See the Webhooks guide for the payload.

Response

Render started

success
boolean
message
string
data
object