// DOCS · INDEX
Documentation.
Async job API for short-form video analysis. Default VideoAnalysis or 24 optional workflow formats. TikTok, Instagram Reels, YouTube Shorts.
// ASYNC JOB MODEL
Submit a supported video URL to create a job. The API enqueues processing and returns a job ID. Poll the job endpoint until status is success or failed. While pending or processing, responses include Retry-After: 5.
TikTok photo/slideshow URLs are not supported. Jobs expire after 24 hours.
// WORKFLOW FORMATS
Optional format on POST /v1/jobs selects one of 24 typed output templates — e.g. recipe turns a cooking Short into ingredients and steps. Same price; caches are per format.
API reference
POST /v1/jobs, GET /v1/jobs/{jobId}, GET /healthz with curl, JS, Python, and Go samples.
Response schema
VideoAnalysis (default) plus 24 workflow formats — recipe, creator-brief, tutorials, e-commerce, health, education, news, music, sports, travel.
Error responses
Every 4xx/5xx the API returns, including 402 Payment Required and 410 Gone.
OpenAPI 3.1 spec↗
Machine-readable spec covering paths, schemas, and error shapes. Drop into your client generator.