Skip to main content
POST

Overview

Add Captions transcribes one video from your team’s media library and renders it again with animated captions on top. The output keeps the source video’s aspect ratio. Captions are on unless you send caption.disabled: true; you can also add background music with musicId.
media is the id of a video in your team’s media library. Add one with Upload Media or Import Media from URL, or find it with List Media; it must be COMPLETED.


What happens next

The video is transcribed, the captions are laid out and the project is rendered. Either:
  • poll GET /v1/project/{projectId} until data.video is present and data.video.status is COMPLETED, then download data.video.url; or
  • pass webhook and wait for the COMPLETED (or FAILED) call described in Webhooks:

Credits and your own keys

  • Managed teams (Hooked’s provider keys) pay in credits: a base of 4 credits plus 4 credits per started 30 seconds of video. The balance is checked when you create the project and the credits are taken when processing starts. If the project fails, they are refunded automatically.
  • Teams on their own provider keys (BYOK) are not charged credits. They need an OpenRouter key in Settings → AI keys (transcription runs on it). Without it the request answers 402 missing_credentials before anything is created or charged.

Errors

Send an Idempotency-Key header to retry safely: if a request times out or answers 5xx, sending it again with the same key and body returns the first answer instead of creating (and charging) the project twice.

Project details

Follow the project until its video is ready

Webhooks

Payloads and delivery rules

Remove Background

Cut the person out of a video

List Music

Background music ids

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
media
string
required

ID of a video in your team's library (add one with POST /v1/media/upload or POST /v1/media/import). The output keeps its aspect ratio. An unknown ID or another team's media answers 400 Media not found; an image answers 400 Media is not a video. A media that is not COMPLETED yet (an import or upload in progress) answers 400 media: Media "<id>" is not ready (status PROCESSING).

name
string

Project name (max 100 characters). Generated when omitted.

Maximum string length: 100
language
string
default:en

Language spoken in the video, used to transcribe it. 2-letter ISO 639-1 code, e.g. en, es.

caption
object

Burned-in captions.

musicId
string

Background music ID from /v1/music/list, or one of your team's own uploaded tracks. An unknown ID answers 400.

Maximum string length: 30
webhook
string<uri>

HTTPS URL on a public host, called when the video is ready or the project fails (max 500 characters). 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.

Maximum string length: 500
metadata
object

Any JSON object of your own (max 5 KB). Sent back in the webhook payload. The key automationId is reserved for dashboard automations and is removed.

Response

Project created. Follow it with GET /v1/project/{projectId} or wait for the webhook.

success
enum<boolean>
required
Available options:
true
data
object
required
message
string
required