# Syllaby API

> REST API for AI video generation: **faceless** social-media videos (create a
> draft, add a script, configure voice/genre/captions, render asynchronously,
> poll for the mp4). JSON over HTTPS, Bearer-token auth, credit-metered.

- Base URL (production): https://api.syllaby.io/v2
- Auth: `Authorization: Bearer <token>` on every request (token-only, stateless —
  no cookies/CSRF). Tokens come from Syllaby account settings.
- Rate limit: 30 requests/minute per API token by default; `429` responses carry
  `Retry-After` and `X-RateLimit-Reset`.
- Credits: generative endpoints (faceless render/retry/export/script generation)
  charge account credits; charging responses carry
  `meta.credits` (cost + remaining).
- Envelope: success bodies are `{ message, status, data }`; errors use standard
  HTTP codes (400/401/404/422/429) with `{ message }` (+ `errors` map on 422).
- Polling rule: track renders with the faceless `id`, NOT `video_id`.

## Docs

- [Getting started & guides](https://api-docs.syllaby.io/md/getting-started.md):
  typical flow, get-your-rendered-video walkthrough, auth, credits, errors,
  rate limits
- [Account endpoints](https://api-docs.syllaby.io/md/account.md): The authenticated user — profile, per-feature credit costs, and the credit ledger.
- [Faceless Videos endpoints](https://api-docs.syllaby.io/md/faceless-videos.md): Create, configure, render, and retrieve faceless videos, their assets, and reusable presets. The typed product endpoints — **B-roll**, **AI-Visuals**, and **URL-to-Video** — are recommended shortcuts for those specific types; this generic `/faceless` surface is the advanced entry point that supports every type, including `ai-clips` (only reachable here), and lets you switch a draft's `type` before rendering.
- [Text to Video endpoints](https://api-docs.syllaby.io/md/text-to-video.md): Generate short AI video clips from a text prompt: list the models your plan allows, estimate the exact charge, create a clip, and poll it to completion.
- [B-roll endpoints](https://api-docs.syllaby.io/md/b-roll.md): Generate stock-footage videos from a narration script.
- [AI-Visuals endpoints](https://api-docs.syllaby.io/md/ai-visuals.md): Generate videos with AI-generated imagery, with per-scene upload and regeneration.
- [URL-to-Video endpoints](https://api-docs.syllaby.io/md/url-to-video.md): Turn a web page into a video: scrape images and script, then render.
- [Text-to-Scene endpoints](https://api-docs.syllaby.io/md/text-to-scene.md): A storyboard editor: generate, reorder, chain, and render scenes into a video. ## Models, formats & pricing Text-to-Scene renders clips with the same engines as Text-to-Video. Fetch the live list — with the `id` to send as `clip_engine_id` and per-engine credit pricing — from [`GET /faceless/options?only=clip_engines`](#tag/faceless-videos/GET/faceless/options). Each engine's supported aspect ratios, resolutions, and durations are listed in the `modifiers` of [`GET /text-to-video/models`](#tag/text-to-video/GET/text-to-video/models) — match entries by `slug`. Snapshot of the current lineup (the endpoints above are the live source of truth; `clip_engine_id` values vary per environment, so always take the `id` from `/faceless/options`): | Model | Slug | Aspect ratios | Resolutions | Clip duration (s) | Credits / sec | |---|---|---|---|---|---| | Veo 3.1 | `veo-3-1` | 16:9, 9:16 | 720p, 1080p | 4, 6, 8 | 6 – 11 | | Veo 3.1 Fast | `veo-3-1-fast` | 16:9, 9:16 | 720p, 1080p | 4, 6, 8 | 3 – 4 | | Veo 3 | `veo-3` | 16:9, 9:16 | 720p, 1080p | 4, 6, 8 | 6 – 11 | | Veo 3 Fast | `veo-3-fast` | 16:9, 9:16 | 720p, 1080p | 4, 6, 8 | 3 – 4 | | Seedance 2 | `seedance-2` | 16:9, 9:16, 1:1, 4:3, 3:4, 21:9, auto | 480p, 720p, 1080p | 4 – 15 | 2.28 – 12.16 | | Seedance 2 Fast | `seedance-2-fast` | 16:9, 9:16, 1:1, 4:3, 3:4, 21:9, auto | 480p, 720p | 4 – 15 | 1.82 – 3.9 | | Seedance 2 Mini | `seedance-2-mini` | 16:9, 9:16, 1:1, 4:3, 3:4, 21:9, auto | 480p, 720p | 4 – 15 | 2 – 3 | | Seedance 1.5 Pro | `seedance-1-5-pro` | 16:9, 9:16, auto | 720p, 1080p | 5, 8, 12 | 0.68 – 3.17 | | Seedance Pro | `seedance-1-pro` | 16:9, 9:16, auto | 720p, 1080p | 5, 8, 12 | 1.34 – 3.18 | | Kling 3.0 Omni | `kling-3-omni` | 16:9, 9:16, 1:1, auto | 720p, 1080p | 3 – 15 | 5 – 8 | | Kling O1 | `kling-o1` | 16:9, 9:16, 1:1, auto | 720p, 1080p | 3 – 10 | 3 – 5 | | Kling 2.6 Pro | `kling-2-6-pro` | 16:9, 9:16, 1:1, auto | 1080p | 5, 10 | 2 – 4 | | Minimax Hailuo | `minimax-hailuo-02` | 16:9, 9:16, 1:1 | 512P, 768P, 1080P | 6, 10 | 1.33 | | Minimax Hailuo 2.3 | `minimax-hailuo-2-3` | 16:9, 9:16, 1:1, auto | 768P, 1080P | 6, 10 | 1.33 – 2 | | Grok Imagine Video | `grok-imagine-video` | 16:9, 9:16, 3:4, 4:3, 1:1, 3:2, 2:3, auto | 480p, 720p | 1 – 15 | 2 | | Happy Horse | `happy-horse-1-0` | 16:9, 9:16, 1:1, 4:3, 3:4, auto | 720p, 1080p | 3 – 15 | 4 – 8 | Where a credit range is shown, the exact rate depends on the selected resolution and/or audio toggle — each engine's `cost` array in `/faceless/options?only=clip_engines` lists the exact rate per combination. The storyboard `settings.aspect_ratio` and `settings.resolution` must be values the chosen engine supports. For the exact credit total of a storyboard, call `GET /text-to-scene/{storyboard}/estimate` before rendering.
- [Voice Clones endpoints](https://api-docs.syllaby.io/md/voice-clones.md): Clone a narration voice from audio samples, manage voice-clone slots, and list, update, or delete your clones.
- [Ideas endpoints](https://api-docs.syllaby.io/md/ideas.md): Discover and rank content ideas for a keyword on a given network.
- [Characters endpoints](https://api-docs.syllaby.io/md/characters.md): Build reusable AI characters: browse genres, create from a reference photo, generate previews, and train a consistent character.
- [OpenAPI 3.1 spec (JSON)](https://api-docs.syllaby.io/openapi/v2.json)
- [Full reference as one file](https://api-docs.syllaby.io/llms-full.txt)

## Optional

- [Interactive reference (Scalar)](https://api-docs.syllaby.io/)
- [Get an API key](https://ai.syllaby.io/settings/api-tokens)