curl -X POST "https://api.hooked.so/v1/project/create/pdf-to-video" \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"pdfUrl": "https://example.com/reports/annual-report-2025.pdf",
"voiceId": "1004",
"summaryType": "summarize",
"targetDuration": 60,
"customPrompt": "Focus on the three biggest numbers",
"mediaType": "ai-images",
"presetSettings": { "preset": "cinematic" },
"aspectRatio": "ratio_9_16",
"caption": { "preset": "tiktok" },
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": { "reportId": "2025-annual" }
}'
const response = await fetch("https://api.hooked.so/v1/project/create/pdf-to-video", {
method: "POST",
headers: {
"x-api-key": "your_api_key_here",
"Content-Type": "application/json",
},
body: JSON.stringify({
pdfUrl: "https://example.com/reports/annual-report-2025.pdf",
voiceId: "1004",
summaryType: "summarize",
targetDuration: 60,
customPrompt: "Focus on the three biggest numbers",
mediaType: "ai-images",
presetSettings: { preset: "cinematic" },
aspectRatio: "ratio_9_16",
caption: { preset: "tiktok" },
webhook: "https://example.com/hooked/webhook?token=YOUR_SECRET",
metadata: { reportId: "2025-annual" },
}),
});
const { data } = await response.json();
console.log(data.projectId, data.status); // "processing"
import requests
response = requests.post(
"https://api.hooked.so/v1/project/create/pdf-to-video",
headers={"x-api-key": "your_api_key_here"},
json={
"pdfUrl": "https://example.com/reports/annual-report-2025.pdf",
"voiceId": "1004",
"summaryType": "summarize",
"targetDuration": 60,
"customPrompt": "Focus on the three biggest numbers",
"mediaType": "ai-images",
"presetSettings": {"preset": "cinematic"},
"aspectRatio": "ratio_9_16",
"caption": {"preset": "tiktok"},
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": {"reportId": "2025-annual"},
},
)
print(response.json()["data"]["projectId"])
{
"success": true,
"data": {
"projectId": "cm4x9k2p10001ab12cd34ef56",
"status": "processing"
},
"message": "PDF to Video successfully created"
}
{
"success": false,
"message": "pdf: The PDF has no readable text. Scanned or image-only PDFs are not supported: export it with a text layer (OCR) first."
}
{
"code": "not_authenticated",
"message": "Not authenticated",
"errorCode": "NOT_AUTHENTICATED",
"details": { "x-api-key": "Header not provided or API Key invalid" }
}
{
"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": {}
}
{
"success": false,
"errorCode": "INSUFFICIENT_CREDITS",
"message": "Not enough credits. Needed: 80, Available: 45",
"creditsNeeded": 80,
"creditsAvailable": 45
}
{
"code": "entitlement_required",
"error": "entitlement_required",
"message": "This endpoint requires the \"app\" product.",
"product": "app"
}
PDF to Video
Turn a report, paper or guide in PDF into a narrated video
curl -X POST "https://api.hooked.so/v1/project/create/pdf-to-video" \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"pdfUrl": "https://example.com/reports/annual-report-2025.pdf",
"voiceId": "1004",
"summaryType": "summarize",
"targetDuration": 60,
"customPrompt": "Focus on the three biggest numbers",
"mediaType": "ai-images",
"presetSettings": { "preset": "cinematic" },
"aspectRatio": "ratio_9_16",
"caption": { "preset": "tiktok" },
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": { "reportId": "2025-annual" }
}'
const response = await fetch("https://api.hooked.so/v1/project/create/pdf-to-video", {
method: "POST",
headers: {
"x-api-key": "your_api_key_here",
"Content-Type": "application/json",
},
body: JSON.stringify({
pdfUrl: "https://example.com/reports/annual-report-2025.pdf",
voiceId: "1004",
summaryType: "summarize",
targetDuration: 60,
customPrompt: "Focus on the three biggest numbers",
mediaType: "ai-images",
presetSettings: { preset: "cinematic" },
aspectRatio: "ratio_9_16",
caption: { preset: "tiktok" },
webhook: "https://example.com/hooked/webhook?token=YOUR_SECRET",
metadata: { reportId: "2025-annual" },
}),
});
const { data } = await response.json();
console.log(data.projectId, data.status); // "processing"
import requests
response = requests.post(
"https://api.hooked.so/v1/project/create/pdf-to-video",
headers={"x-api-key": "your_api_key_here"},
json={
"pdfUrl": "https://example.com/reports/annual-report-2025.pdf",
"voiceId": "1004",
"summaryType": "summarize",
"targetDuration": 60,
"customPrompt": "Focus on the three biggest numbers",
"mediaType": "ai-images",
"presetSettings": {"preset": "cinematic"},
"aspectRatio": "ratio_9_16",
"caption": {"preset": "tiktok"},
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": {"reportId": "2025-annual"},
},
)
print(response.json()["data"]["projectId"])
{
"success": true,
"data": {
"projectId": "cm4x9k2p10001ab12cd34ef56",
"status": "processing"
},
"message": "PDF to Video successfully created"
}
{
"success": false,
"message": "pdf: The PDF has no readable text. Scanned or image-only PDFs are not supported: export it with a text layer (OCR) first."
}
{
"code": "not_authenticated",
"message": "Not authenticated",
"errorCode": "NOT_AUTHENTICATED",
"details": { "x-api-key": "Header not provided or API Key invalid" }
}
{
"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": {}
}
{
"success": false,
"errorCode": "INSUFFICIENT_CREDITS",
"message": "Not enough credits. Needed: 80, Available: 45",
"creditsNeeded": 80,
"creditsAvailable": 45
}
{
"code": "entitlement_required",
"error": "entitlement_required",
"message": "This endpoint requires the \"app\" product.",
"product": "app"
}
Overview
PDF to Video extracts the text of a PDF, turns it into a narration split into scenes, reads it with a voice and puts a visual under each scene. It works like Article to Video, with a PDF instead of a web page. Sending the PDF. Send one of:pdfUrl: a publichttps://link to the file, up to 20 MB. Hooked downloads it itself: a private or local address (or a redirect to one), a file over 20 MB or anything that is not a PDF answers400.pdfBase64: the file itself, base64-encoded, up to 10 MB once decoded (adata:application/pdf;base64,prefix is accepted). AddpdfFileNameto name the project after the file.
400 before anything is charged. Run it through OCR first.
The narration. summaryType is summarize (default: a short summary, steered by customPrompt), summarize_long (a detailed narration) or key_as_is (the document as close to the original as possible; the video is as long as it needs). With the first two, targetDuration sets the length (default 30 seconds). The narration is written in the document’s own language.
The visuals. mediaType as in Script to Video: ai-images (default), ai-videos, media (your own library files) or gameplay. Motion graphics are not available for this format. For gameplay only, see PDF to Brainrot.
projectId and status processing: the PDF is downloaded and its text checked in the request, and splitting it into scenes and making the video happen after that. What can be refused up front (an invalid body, a link that is not a PDF, a PDF without a text layer, missing keys, too few credits) is still answered with a 400 or 402 and nothing is created. If the scenes cannot be written later, the project becomes failed with the reason in message, the credits come back and your webhook gets the failure.POST https://api.hooked.so/v1/project/create/pdf-to-video
curl -X POST "https://api.hooked.so/v1/project/create/pdf-to-video" \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"pdfUrl": "https://example.com/reports/annual-report-2025.pdf",
"voiceId": "1004",
"summaryType": "summarize",
"targetDuration": 60,
"customPrompt": "Focus on the three biggest numbers",
"mediaType": "ai-images",
"presetSettings": { "preset": "cinematic" },
"aspectRatio": "ratio_9_16",
"caption": { "preset": "tiktok" },
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": { "reportId": "2025-annual" }
}'
const response = await fetch("https://api.hooked.so/v1/project/create/pdf-to-video", {
method: "POST",
headers: {
"x-api-key": "your_api_key_here",
"Content-Type": "application/json",
},
body: JSON.stringify({
pdfUrl: "https://example.com/reports/annual-report-2025.pdf",
voiceId: "1004",
summaryType: "summarize",
targetDuration: 60,
customPrompt: "Focus on the three biggest numbers",
mediaType: "ai-images",
presetSettings: { preset: "cinematic" },
aspectRatio: "ratio_9_16",
caption: { preset: "tiktok" },
webhook: "https://example.com/hooked/webhook?token=YOUR_SECRET",
metadata: { reportId: "2025-annual" },
}),
});
const { data } = await response.json();
console.log(data.projectId, data.status); // "processing"
import requests
response = requests.post(
"https://api.hooked.so/v1/project/create/pdf-to-video",
headers={"x-api-key": "your_api_key_here"},
json={
"pdfUrl": "https://example.com/reports/annual-report-2025.pdf",
"voiceId": "1004",
"summaryType": "summarize",
"targetDuration": 60,
"customPrompt": "Focus on the three biggest numbers",
"mediaType": "ai-images",
"presetSettings": {"preset": "cinematic"},
"aspectRatio": "ratio_9_16",
"caption": {"preset": "tiktok"},
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": {"reportId": "2025-annual"},
},
)
print(response.json()["data"]["projectId"])
Sending the file itself
For a PDF that is not online (up to 10 MB), send it base64-encoded:# The JSON body is written to a file: a PDF is too long for the command line
printf '{"pdfBase64":"%s","pdfFileName":"handbook.pdf","voiceId":"1004","summaryType":"key_as_is"}' \
"$(base64 -w0 handbook.pdf)" > body.json
curl -X POST "https://api.hooked.so/v1/project/create/pdf-to-video" \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
--data-binary @body.json
import { readFileSync } from "node:fs";
const body = {
pdfBase64: readFileSync("handbook.pdf").toString("base64"),
pdfFileName: "handbook.pdf",
voiceId: "1004",
summaryType: "key_as_is",
};
const response = await fetch("https://api.hooked.so/v1/project/create/pdf-to-video", {
method: "POST",
headers: { "x-api-key": "your_api_key_here", "Content-Type": "application/json" },
body: JSON.stringify(body),
});
import base64
import requests
with open("handbook.pdf", "rb") as f:
pdf_base64 = base64.b64encode(f.read()).decode()
body = {"pdfBase64": pdf_base64, "pdfFileName": "handbook.pdf", "voiceId": "1004", "summaryType": "key_as_is"}
response = requests.post(
"https://api.hooked.so/v1/project/create/pdf-to-video",
headers={"x-api-key": "your_api_key_here"},
json=body,
)
More request bodies
{
"pdfUrl": "https://example.com/papers/ocean-currents.pdf",
"voiceId": "1004",
"summaryType": "summarize_long",
"targetDuration": 90,
"mediaType": "ai-videos",
"presetSettings": { "preset": "realistic", "quality": "pro" }
}
{
"pdfUrl": "https://example.com/catalog/spring-2026.pdf",
"voiceId": "1004",
"mediaType": "media",
"media": ["cm4x9k2p10001ab12cd34ef56", "cm4x9k2p10002ab12cd34ef56"],
"aspectRatio": "ratio_1_1"
}
{
"success": true,
"data": {
"projectId": "cm4x9k2p10001ab12cd34ef56",
"status": "processing"
},
"message": "PDF to Video successfully created"
}
{
"success": false,
"message": "pdf: The PDF has no readable text. Scanned or image-only PDFs are not supported: export it with a text layer (OCR) first."
}
{
"code": "not_authenticated",
"message": "Not authenticated",
"errorCode": "NOT_AUTHENTICATED",
"details": { "x-api-key": "Header not provided or API Key invalid" }
}
{
"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": {}
}
{
"success": false,
"errorCode": "INSUFFICIENT_CREDITS",
"message": "Not enough credits. Needed: 80, Available: 45",
"creditsNeeded": 80,
"creditsAvailable": 45
}
{
"code": "entitlement_required",
"error": "entitlement_required",
"message": "This endpoint requires the \"app\" product.",
"product": "app"
}
What happens next
- Keep the
projectId. The project starts asprocessingwhile the text is split into scenes; if that fails it becomesfailed, with the reason inmessageand the credits refunded. - Either poll
GET /v1/project/{projectId}untilvideo.statusisCOMPLETED(or the projectstatusisfailed), or pass awebhookand wait for the call. - Download the file from
video.url(ordata.urlin the webhook).
pdfUrl it came from. See Webhooks for every payload.
Credits and your own keys
Teams on Hooked’s keys (managed): the project is priced fromtargetDuration, the media type and the quality or model. The PDF is read first, so a file that cannot be read costs nothing; then the credits are taken. If the balance is short, the request answers 402 INSUFFICIENT_CREDITS with creditsNeeded and creditsAvailable and nothing is created. If the project fails later, the credits are refunded automatically.
Teams on their own keys (BYOK): no credits are charged. The team needs these keys in Settings → AI keys:
- OpenRouter: always (summary, images, video clips, captions).
- ElevenLabs: for the voiceover. Not needed in
speakingmode (ai-videoswith a talking preset), where the video model speaks. - Gemini: when
presetSettings.aiModelisgemini_omni_flash.
402 missing_credentials with the list in missingProviders, before anything is created.
Errors
| Status | Body | When |
|---|---|---|
400 | { "success": false, "message": "<field>: <reason>" } | Validation failed. The PDF: pdfUrl: Required: the https URL of the PDF (or the file itself in pdfBase64), pdfUrl: Send either pdfUrl or pdfBase64, not both, pdfUrl: Must be an https URL, pdfUrl: Must be a public https URL (…) (a private or local address, or a redirect to one), pdfUrl: The PDF is larger than 20 MB, pdfUrl: The PDF could not be downloaded (HTTP 404), pdfUrl: The file at this URL is not a PDF, pdfBase64: The PDF is larger than 10 MB …, pdfBase64: The file is not a PDF, pdf: The PDF has no readable text … (scanned), pdf: The PDF is password-protected …. The rest as in Article to Video: summaryType, customPrompt, voiceId, musicId, mediaType, media, presetSettings, gameplaySettings, caption, webhook: Must be a valid HTTPS URL, Invalid JSON body. |
401 | not_authenticated | Missing or invalid x-api-key. |
402 | missing_credentials | BYOK team without the keys listed above. |
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": "Failed to create PDF to Video project: …" } | The text could not be summarised, or an unexpected error; the credits taken are refunded. |
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
PDF to Video example
PDF to Brainrot
Article to Video
Authorizations
Headers
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.
1 - 255^[\x20-\x7E]+$Body
The narrator: a library voice from /v1/voice/list or one of your team's custom voices. An ID that is neither answers 400 (voiceId: Voice "<id>" not found.).
1 - 30A public https link to the PDF (up to 20 MB). Hooked downloads it: private or local addresses, redirects to them, files over 20 MB and anything that is not a PDF answer 400. Send this or pdfBase64, not both.
2000The PDF file itself, base64-encoded (up to 10 MB once decoded; a data:application/pdf;base64, prefix is accepted). For bigger files use pdfUrl. Send this or pdfUrl, not both.
The file name, used to name the project. Taken from pdfUrl when omitted.
500How the text becomes the narration:
summarize: a short summary of the key points, abouttargetDurationseconds long.summarize_long: a detailed narration with supporting details, abouttargetDurationseconds long.key_as_is: the text as close to the original as possible, adapted for speech. The video is as long as the text needs;targetDurationis ignored.
summarize, summarize_long, key_as_is Approximate length of the video in seconds (10-600). Not used with key_as_is. It also sets the price of the project.
10 <= x <= 600summarize only: extra instructions for the summary, e.g. the angle or the audience (max 2,000 characters). Sent with another summaryType, it answers 400.
2000Where the visuals come from:
ai-images(default): one AI image per scene (presetSettings:preset,aiModel,characterIds,useCharacterReferenceImage).ai-videos: one AI video clip per scene (presetSettings:preset,quality,aiModel,isContinuous,characterIds,characterMode,voiceProfile).media: your own images and videos from the media library (mediarequired).gameplay: a gameplay clip in the background (gameplaySettings).
motion-graphics is not available for this format (400).
ai-images, ai-videos, media, gameplay Visual settings for ai-images and ai-videos; not used by media and gameplay. Each field says which media types read it.
Show child attributes
Show child attributes
mediaType: "gameplay" only: the background clip.
Show child attributes
Show child attributes
IDs of images or videos in your team's media library (max 50). Required for mediaType: "media"; ignored for the other media types. An ID that is not in your library answers 400 (media: Media "<id>" not found), and so does a media that is not COMPLETED yet.
50Media ID from your library
Project name (max 100 characters). Generated from the source when omitted.
100Background music: a track from /v1/music/list or your team's own uploaded music. An ID that is neither answers 400 (musicId: Music "<id>" not found.).
30Vertical, horizontal or square.
ratio_9_16, ratio_16_9, ratio_1_1 Two-letter ISO 639-1 code of the narration. The narration is written in the document's own language, detected when omitted; this does not translate it.
Burned-in captions of the narration. Not used with motion-graphics (it typesets its own copy) or a speaking cast.
Show child attributes
Show child attributes
Narrator voice settings (ElevenLabs). Any field you leave out keeps its default. Not used by a speaking cast.
Show child attributes
Show child attributes
Add emoji/GIF stickers anchored to the captions. Not used with motion-graphics or a speaking cast.
Branding.
Show child attributes
Show child attributes
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.
500Any JSON object of your own (max 5 KB). Stored on the project and sent back in the webhook payload. The key automationId is reserved for dashboard automations and is removed.