Skip to content

Developer Docs

Generate faceless videos programmatically - REST API, MCP server, webhooks and code examples.

📡

API reference

Generate videos, check status and manage renders over REST.

🔑

Authentication

API keys, Bearer tokens and key management.

📄

OAuth 2.0

Delegated, revocable account access for third-party apps - Authorization Code + PKCE.

📄

Sandbox (test mode)

Build and test your integration without spending credits.

📄

TypeScript SDK

Official typed client: generate, poll, publish, verify webhooks.

🪝

Webhooks

Get notified when a render completes or fails.

🤖

MCP server

Drive ShortLoom from AI agents via the Model Context Protocol.

📄

Use ShortLoom from Claude Code or Cursor

Connect the MCP server to Claude Code, Cursor or ChatGPT so an agent can draft, render and publish videos for you.

🚦

Rate limits

Request budgets, 429s and how to stay under the limit.

💻

Code examples

Copy-paste snippets in curl, JavaScript and Python.

⚠️

Errors

Error shape, status codes and what each means.

Quickstart

Create a key in Settings → Developer, then generate a video in one call. Every endpoint lives under https://shortloom.ai/api/v1.

curl -X POST https://shortloom.ai/api/v1/generate \
  -H "Authorization: Bearer fl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"topic": "5 facts about the ocean nobody knows"}'

# -> { "jobId": "7c9e2a1d-...", "status": "awaiting_approval" }

curl https://shortloom.ai/api/v1/status/7c9e2a1d-... \
  -H "Authorization: Bearer fl_your_api_key"
Drafts are free
A new job parks at awaiting_approval with the full script and its exact credit cost. Nothing is charged until you POST to /approve - so you can build and inspect the whole flow before spending anything.
Test keys cost nothing
A key minted in test mode carries the fl_test_ prefix and runs the entire path - auth, rate limits, validation - with a simulated render. Use one while wiring your webhook or polling loop. Series and publishing act on real schedules and real channels, so they refuse a test key with test_key_not_supported.
Growth or Pro
The API and MCP server are available on those plans, checked on every request. A key minted on Growth stops working if the account later drops below it.