Skip to main content
POST

Overview

Scrolling Video opens a web page, records it while it scrolls and returns that recording as a video. There is no avatar, voiceover or captions: only the page, in the size you choose, with your logo and a background track (musicId, from List Music) if you want them. Use it as a screen capture of a landing page, a store or an article. The request returns a projectId right away. The recording and the render run in the background.

Only scrollingVideoSettings.websiteUrl is required. The size and the logo go inside videoSettings; the background music is the top-level musicId.


What happens next

  1. Keep the projectId.
  2. Either poll GET /v1/project/{projectId} until video.status is COMPLETED (or the project status is failed), or pass a webhook and wait for the call.
  3. Download the file from video.url (or data.url in the webhook).
The webhook receives { "status": "COMPLETED", "message": "Video completed", "data": { "videoId", "projectId", "status": "COMPLETED", "url", "metadata" } }. A project that fails before it has a video sends "status": "FAILED" with videoId: null. See Webhooks.

Credits and your own keys

Teams on Hooked’s keys (managed): 13 credits plus 4 credits per started 30 seconds of targetDuration (a 30-second video is 17 credits, a 60-second one 21). The balance is checked when you create the project (402 INSUFFICIENT_CREDITS if it is short) and the credits are taken when the recording starts. If the project fails, they are refunded automatically. Teams on their own keys (BYOK): no credits are charged. The team needs an OpenRouter key in Settings → AI keys (the project name is generated with it). Without it the request answers 402 missing_credentials before anything is created.

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.

Next Steps

Get Project

Follow the project until the video is ready

Webhooks

Payloads and delivery rules

Hook + Demo

Open the recording with a reaction hook

UGC Studio: App Demo

An avatar presenting your site or app

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
scrollingVideoSettings
object
required

What to record and how it scrolls.

name
string

Project name (max 100 characters). Generated from the URL when omitted.

Maximum string length: 100
videoSettings
object

Output settings. A flat top-level aspectRatio is still accepted; this one wins. No voice or captions are added; background music comes from musicId.

musicId
string

Background music ID from /v1/music/list, played under the whole recording. An unknown ID answers 400. Omit it for a silent video.

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