Build with Quiz.Video

Get an API key

API keys are self-serve and free. No sales call or credit card is needed.

1. Create a free account (or sign in).
2. Open Settings and choose the API Keys tab.
3. Create a key and copy it. Keys start with qv_ and are shown once.

Send the key in the x-api-key header. Building something other people sign in to, or an agent? Use OAuth instead so each user approves access to their own account.

Quickstart

The base URL is https://www.quiz.video/api/v1. Three calls take you from a topic to a finished video.

curl -X POST https://www.quiz.video/api/v1/quizzes/generate \
  -H "x-api-key: $QUIZ_VIDEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"topic": "The solar system", "numberOfQuestions": 5, "difficulty": "medium"}'

curl -X POST https://www.quiz.video/api/v1/renders \
  -H "x-api-key: $QUIZ_VIDEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quizId": "QUIZ_ID"}'

curl https://www.quiz.video/api/v1/renders/SESSION_ID \
  -H "x-api-key: $QUIZ_VIDEO_API_KEY"

Paid plans can then call POST /api/v1/renders/SESSION_ID/download for a signed MP4 URL. See the API reference for every endpoint, including creating quizzes from your own questions and building flashcard decks.

MCP server for AI agents

Claude, ChatGPT and other MCP clients can connect to the remote server at https://www.quiz.video/mcp/ (Streamable HTTP). The client registers itself and asks the user to approve access through OAuth, so there is no key to paste. The server exposes the same operations as the REST API as quiz_video_* tools.

Setup instructions for each client are in the MCP guide.

Authentication

Testing and sandbox

Rate limits

Each API key has a budget of 1,000 requests, which refills once the key has made no requests for 24 hours. Every /api/v1 response declares the policy, and API-key requests also report what is left, using the IETF RateLimit header fields plus the familiar X-RateLimit-* trio:

RateLimit-Policy: "api-key";q=1000;w=86400
RateLimit: "api-key";r=858;t=86400
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 858
X-RateLimit-Reset: 1792389600

t is how many seconds without requests restore the full budget, and X-RateLimit-Reset is the matching Unix timestamp. When the budget is spent the API returns 429 with code RATE_LIMITED and a Retry-After header. Wait that long before retrying.

Errors

Every error, including unknown paths under /api, is JSON with a stable machine-readable code. Branch on code, show error to people, and follow hint to recover.

{
  "error": "Missing credentials. Provide an API key via x-api-key or an OAuth access token via Authorization: Bearer.",
  "code": "UNAUTHORIZED",
  "hint": "Send an API key in the x-api-key header (create one at https://www.quiz.video/app/settings/) or an OAuth access token as Authorization: Bearer <token>. ...",
  "docs": "https://www.quiz.video/docs/api/#error-codes"
}

The error code reference lists every code. Retry 5xx and 429 with backoff; do not resend the same payload after other 4xx errors.

Versioning and deprecation policy

• The major version is part of the path: /api/v1. Responses also carry API-Version: 1.
• Within v1 we only make additive changes: new endpoints, new optional request fields, new response fields and new error codes. Ignore fields you do not recognise.
• Breaking changes (removing or renaming fields or endpoints, changing types, tightening validation) only ship under a new major path such as /api/v2, which runs alongside v1.
• Before an operation is removed it is marked deprecated: true in the OpenAPI spec and its responses send a Deprecation header (RFC 9745) and a Sunset header (RFC 8594) with the removal date, at least 90 days in advance.
• Every /api/v1 response links here with Link: <…/developers/#versioning>; rel="deprecation".

Current deprecations: none. Every v1 operation is supported.

Machine-readable resources

Agents and code generators can discover everything from these public documents. None of them require authentication.