> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hooked.so/llms.txt
> Use this file to discover all available pages before exploring further.
# Scrolling Video
> Record a website scrolling as a video
## 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](/api-reference/music/list)) 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.
```
POST https://api.hooked.so/v1/project/create/scrolling-video
```
***
Only `scrollingVideoSettings.websiteUrl` is required. The size and the logo go inside `videoSettings`; the background music is the top-level `musicId`.
***
```bash cURL theme={null}
curl -X POST "https://api.hooked.so/v1/project/create/scrolling-video" \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"scrollingVideoSettings": {
"websiteUrl": "https://example.com",
"targetDuration": 20,
"scrollMode": "once"
},
"videoSettings": { "aspectRatio": "ratio_16_9" },
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET"
}'
```
```javascript JavaScript theme={null}
const response = await fetch("https://api.hooked.so/v1/project/create/scrolling-video", {
method: "POST",
headers: {
"x-api-key": "your_api_key_here",
"Content-Type": "application/json",
},
body: JSON.stringify({
scrollingVideoSettings: {
websiteUrl: "https://example.com",
targetDuration: 20,
scrollMode: "once",
},
videoSettings: { aspectRatio: "ratio_16_9" },
webhook: "https://example.com/hooked/webhook?token=YOUR_SECRET",
}),
});
const { data } = await response.json();
console.log(data.projectId);
```
```python Python theme={null}
import requests
response = requests.post(
"https://api.hooked.so/v1/project/create/scrolling-video",
headers={"x-api-key": "your_api_key_here"},
json={
"scrollingVideoSettings": {
"websiteUrl": "https://example.com",
"targetDuration": 20,
"scrollMode": "once",
},
"videoSettings": {"aspectRatio": "ratio_16_9"},
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
},
)
print(response.json()["data"]["projectId"])
```
***
```json 200 theme={null}
{
"success": true,
"data": {
"projectId": "cm4x9k2p10001ab12cd34ef56",
"status": "processing"
},
"message": "Scrolling Video successfully created"
}
```
```json 400 theme={null}
{
"success": false,
"message": "scrollingVideoSettings.websiteUrl: Invalid website URL"
}
```
```json 401 theme={null}
{
"code": "not_authenticated",
"message": "Not authenticated",
"errorCode": "NOT_AUTHENTICATED",
"details": { "x-api-key": "Header not provided or API Key invalid" }
}
```
```json 402 missing keys theme={null}
{
"success": false,
"code": "missing_credentials",
"errorCode": "MISSING_CREDENTIALS",
"missingProviders": ["openrouter"],
"message": "Your team uses its own provider keys (BYOK) and these are missing or invalid: OpenRouter. Add them in Settings → AI keys."
}
```
```json 402 subscription theme={null}
{
"success": false,
"code": "subscription_required",
"errorCode": "SUBSCRIPTION_REQUIRED",
"message": "Your team generates with Hooked's keys, which are paid by your plan. Subscribe to keep generating."
}
```
```json 402 credits theme={null}
{
"success": false,
"errorCode": "INSUFFICIENT_CREDITS",
"message": "Not enough credits for Scrolling Video creation. Estimated: 17, Available: 5",
"creditsNeeded": 17,
"creditsAvailable": 5
}
```
```json 403 theme={null}
{
"code": "entitlement_required",
"error": "entitlement_required",
"message": "This endpoint requires the \"app\" product.",
"product": "app"
}
```
***
## What happens next
1. Keep the `projectId`.
2. Either poll [`GET /v1/project/{projectId}`](/api-reference/project/details) 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](/guides/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
| Status | Body | When |
| - | - | - |
| `400` | `{ "success": false, "message": ": " }` | Validation failed. Examples: `Invalid JSON body`, `scrollingVideoSettings.websiteUrl: Required`, `scrollingVideoSettings.websiteUrl: Invalid website URL`, `scrollingVideoSettings.targetDuration: Number must be less than or equal to 120`, `videoSettings.caption.preset: Invalid caption preset "…". Allowed values are: …` (`caption.preset: …` when sent as the flat `caption`), `webhook: Must be a valid HTTPS URL`. |
| `401` | `not_authenticated` | Missing or invalid `x-api-key`. |
| `402` | `missing_credentials` | BYOK team without an OpenRouter key. |
| `402` | `subscription_required` | Managed team without an active plan. |
| `402` | `INSUFFICIENT_CREDITS` | Managed team without enough credits. |
| `403` | `entitlement_required` | The team does not have the product this endpoint needs. |
| `500` | `{ "success": false, "message": "..." }` | Unexpected error. |
Send an [`Idempotency-Key`](/guides/idempotency) 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
Follow the project until the video is ready
Payloads and delivery rules
Open the recording with a reaction hook
An avatar presenting your site or app
## OpenAPI
````yaml POST /v1/project/create/scrolling-video
openapi: 3.0.0
info:
title: Hooked API
version: 1.0.0
description: AI Video Generation API
servers:
- url: https://api.hooked.so
security:
- ApiKeyAuth: []
tags:
- name: Videos
description: Create projects, follow them and render videos
- name: Account Analysis
description: Analyze TikTok and YouTube accounts
- name: Channels
description: Connected social accounts you publish to
- name: Publish
description: Schedule videos to your connected accounts
- name: Images
description: 'Image editing: background removal and expansion'
- name: Media
description: 'Your media library: list, import from a URL, upload a file'
- name: Avatars
description: Your team's own avatars (Actors) and their Hook + Demo reactions
paths:
/v1/project/create/scrolling-video:
post:
tags:
- Videos
summary: Create Scrolling Video
description: >-
Records a website scrolling, without avatar or voiceover, with optional
background music (`musicId`).
Create endpoints are not idempotent: do not retry a POST on a timeout or
5xx without first checking your projects, or you may create (and pay
for) the video twice.
operationId: createScrollingVideo
parameters:
- $ref: '#/components/parameters/IdempotencyKey'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- scrollingVideoSettings
properties:
scrollingVideoSettings:
type: object
required:
- websiteUrl
description: What to record and how it scrolls.
properties:
websiteUrl:
type: string
format: uri
maxLength: 500
description: 'The page to record: a full URL (max 500 characters).'
scrollInterval:
type: number
minimum: 1
maximum: 10
default: 3
description: >-
Seconds paused between scrolls (1-10). Not used with
scrollMode `fixed`.
scrollDuration:
type: number
minimum: 500
maximum: 5000
default: 1500
description: >-
Milliseconds each scroll takes (500-5000). Not used with
scrollMode `fixed`.
scrollMode:
type: string
enum:
- restart
- loop
- once
- fixed
default: restart
description: >-
`restart`: scroll down and jump back to the top at the
bottom. `loop`: scroll down, then up, then down again.
`once`: scroll down and stay at the bottom. `fixed`: no
scrolling, the first screen is held for the whole video.
targetDuration:
type: number
minimum: 5
maximum: 120
default: 30
description: >-
Length of the video, in seconds (5-120). It also sets
the price.
name:
type: string
maxLength: 100
description: >-
Project name (max 100 characters). Generated from the URL
when omitted.
videoSettings:
type: object
description: >-
Output settings. A flat top-level `aspectRatio` is still
accepted; this one wins. No voice or captions are added;
background music comes from `musicId`.
properties:
aspectRatio:
type: string
enum:
- ratio_9_16
- ratio_16_9
- ratio_1_1
default: ratio_9_16
description: Size of the recording
content:
type: object
description: Branding.
properties:
brandingLogo:
type: object
description: >-
Your logo over the video. Drawn only with `enabled:
true` and a `url`.
properties:
enabled:
type: boolean
default: false
url:
type: string
description: >-
Public https image URL of the logo (PNG with
transparency works best)
position:
type: string
enum:
- top-left
- top-right
- bottom-left
- bottom-right
default: bottom-right
size:
type: number
minimum: 20
maximum: 200
default: 100
description: Logo size (20-200)
musicId:
type: string
maxLength: 30
description: >-
Background music ID from /v1/music/list, played under the
whole recording. An unknown ID answers 400. Omit it for a
silent video.
webhook:
type: string
maxLength: 500
format: uri
description: >-
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.
metadata:
type: object
additionalProperties: true
description: >-
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.
example:
name: Landing page tour
scrollingVideoSettings:
websiteUrl: https://yoursite.com
scrollMode: once
targetDuration: 20
videoSettings:
aspectRatio: ratio_9_16
webhook: https://yoursite.com/webhook?token=YOUR_SECRET
responses:
'200':
description: >-
Project created. Follow it with GET /v1/project/{projectId} or wait
for the webhook.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreateResponse'
example:
success: true
data:
projectId: clx9p2k4m0001abcd1234efgh
status: processing
message: Scrolling Video successfully created
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/PaymentRequired'
'403':
$ref: '#/components/responses/EntitlementRequired'
'409':
$ref: '#/components/responses/IdempotencyInProgress'
'422':
$ref: '#/components/responses/IdempotencyMismatch'
'429':
$ref: '#/components/responses/RateLimited429'
'500':
$ref: '#/components/responses/InternalError'
security:
- ApiKeyAuth: []
components:
parameters:
IdempotencyKey:
name: Idempotency-Key
in: header
required: false
description: >-
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](/guides/idempotency).
schema:
type: string
minLength: 1
maxLength: 255
pattern: ^[\x20-\x7E]+$
example: order-1042-video
schemas:
ProjectCreateResponse:
type: object
properties:
success:
type: boolean
enum:
- true
data:
type: object
properties:
projectId:
type: string
description: Follow it with GET /v1/project/{projectId}
status:
type: string
enum:
- draft
- processing
- completed
- failed
description: >-
The project status right after creation, usually `draft` or
`processing`. Follow it with GET /v1/project/{projectId}.
required:
- projectId
- status
message:
type: string
required:
- success
- data
- message
ValidationError400:
type: object
description: >-
The request is invalid. `message` is `: ` when a field is
to blame.
properties:
success:
type: boolean
enum:
- false
message:
type: string
required:
- success
- message
example:
success: false
message: 'webhook: Must be a valid HTTPS URL'
Error401:
type: object
description: Missing or invalid `x-api-key`.
properties:
code:
type: string
enum:
- not_authenticated
message:
type: string
example: Not authenticated
errorCode:
type: string
enum:
- NOT_AUTHENTICATED
details:
type: object
additionalProperties:
type: string
example:
code: not_authenticated
message: Not authenticated
errorCode: NOT_AUTHENTICATED
details:
x-api-key: Header not provided or API Key invalid
MissingCredentials402:
type: object
description: >-
BYOK team without the provider keys this request uses. Nothing was
created or charged. Add the keys in Settings → AI keys.
properties:
success:
type: boolean
enum:
- false
description: Present when raised by the spend check
code:
type: string
enum:
- missing_credentials
errorCode:
type: string
enum:
- MISSING_CREDENTIALS
missingProviders:
type: array
items:
type: string
enum:
- openrouter
- elevenlabs
- gemini
- bria
- firecrawl
message:
type: string
details:
type: object
required:
- code
- errorCode
- missingProviders
- message
example:
code: missing_credentials
message: >-
Your team uses its own provider keys (BYOK) and these are missing or
invalid: OpenRouter, ElevenLabs. Add them in Settings → AI keys.
errorCode: MISSING_CREDENTIALS
missingProviders:
- openrouter
- elevenlabs
details: {}
SubscriptionRequired402:
type: object
description: Managed team (generates with Hooked's keys) without a live subscription.
properties:
success:
type: boolean
enum:
- false
code:
type: string
enum:
- subscription_required
errorCode:
type: string
enum:
- SUBSCRIPTION_REQUIRED
message:
type: string
required:
- success
- code
- errorCode
- message
example:
success: false
code: subscription_required
errorCode: SUBSCRIPTION_REQUIRED
message: >-
Your team generates with Hooked's keys, which are paid by your plan.
Subscribe to keep generating.
InsufficientCredits402:
type: object
description: >-
Not enough credits for this request. `creditsNeeded` /
`creditsAvailable` are included when the estimate is known.
properties:
success:
type: boolean
enum:
- false
errorCode:
type: string
enum:
- INSUFFICIENT_CREDITS
message:
type: string
creditsNeeded:
type: number
creditsAvailable:
type: number
required:
- success
- errorCode
- message
example:
success: false
errorCode: INSUFFICIENT_CREDITS
message: Not enough credits to perform this action
creditsNeeded: 40
creditsAvailable: 12
EntitlementRequired403:
type: object
description: >-
Valid key, but the team does not have the product this endpoint belongs
to.
properties:
code:
type: string
enum:
- entitlement_required
error:
type: string
enum:
- entitlement_required
message:
type: string
product:
type: string
example: app
required:
- code
- error
- message
- product
example:
code: entitlement_required
error: entitlement_required
message: This endpoint requires the "app" product.
product: app
Error500:
type: object
properties:
success:
type: boolean
enum:
- false
message:
type: string
error:
type: string
description: Present on some endpoints
example:
success: false
message: Internal server error
responses:
ValidationError:
description: Validation error (also `Invalid JSON body`)
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError400'
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
PaymentRequired:
description: >-
Payment required: a BYOK team is missing provider keys (nothing was
created or charged), a managed team has no live subscription, or there
are not enough credits.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/MissingCredentials402'
- $ref: '#/components/schemas/SubscriptionRequired402'
- $ref: '#/components/schemas/InsufficientCredits402'
examples:
missingCredentials:
value:
code: missing_credentials
message: >-
Your team uses its own provider keys (BYOK) and these are
missing or invalid: OpenRouter, ElevenLabs. Add them in
Settings → AI keys.
errorCode: MISSING_CREDENTIALS
missingProviders:
- openrouter
- elevenlabs
details: {}
subscriptionRequired:
value:
success: false
code: subscription_required
errorCode: SUBSCRIPTION_REQUIRED
message: >-
Your team generates with Hooked's keys, which are paid by your
plan. Subscribe to keep generating.
insufficientCredits:
value:
success: false
errorCode: INSUFFICIENT_CREDITS
message: Not enough credits to perform this action
creditsNeeded: 40
creditsAvailable: 12
EntitlementRequired:
description: The team does not have the product this endpoint needs
content:
application/json:
schema:
$ref: '#/components/schemas/EntitlementRequired403'
IdempotencyInProgress:
description: >-
A request with the same `Idempotency-Key` is still running. Retry in a
few seconds.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
code:
type: string
message:
type: string
details:
type: object
additionalProperties: true
required:
- success
- code
- message
example:
success: false
code: idempotency_conflict
message: A request with this Idempotency-Key is still in progress
details: {}
IdempotencyMismatch:
description: >-
The `Idempotency-Key` was already used with a different body. Use a new
key for a new request.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
code:
type: string
message:
type: string
details:
type: object
additionalProperties: true
required:
- success
- code
- message
example:
success: false
code: idempotency_mismatch
message: Idempotency-Key was used with a different request
details: {}
RateLimited429:
description: >-
Your team is over a rate limit: 30 POST requests per minute, 120 other
requests per minute, or 3 downloads of your URLs running at once.
Nothing ran and nothing was charged: wait `Retry-After` seconds and send
the request again. See [Rate
limits](/guides/error-handling#rate-limits-429).
headers:
Retry-After:
description: Seconds to wait before sending again.
schema:
type: integer
X-RateLimit-Limit:
description: The limit of the bucket you hit (not sent for the download cap).
schema:
type: integer
X-RateLimit-Remaining:
description: 'Requests left in this window: 0 (not sent for the download cap).'
schema:
type: integer
X-RateLimit-Reset:
description: >-
When the window ends, in Unix seconds (not sent for the download
cap).
schema:
type: integer
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
errorCode:
type: string
enum:
- RATE_LIMITED
message:
type: string
retryAfterSeconds:
type: integer
required:
- success
- errorCode
- message
- retryAfterSeconds
example:
success: false
errorCode: RATE_LIMITED
message: >-
Rate limit exceeded: 30 POST requests per minute per team. Retry
after 12 s.
retryAfterSeconds: 12
InternalError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error500'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.