{ "openapi": "3.1.1", "info": { "title": "Simpled.ai Public API", "summary": "Read-only product facts about Simpled.ai: capabilities, pricing, solutions and guides.", "description": "Simpled.ai is an AI whiteboard animation tool that turns text prompts into hand-drawn explainer videos for training, marketing, education, and patient communication. Free tier available; plans from $29/month.\n\nThis API is public and unauthenticated. It exists so an agent can answer questions about Simpled.ai — what it does, what it costs, what it can produce — without scraping HTML.\n\n**It does not generate video.** Rendering runs on a separate, key-authenticated API at https://api.simpled.ai, described at https://api.simpled.ai/openapi.json and documented at https://api.simpled.ai/docs.\n\n## Rate limits\n\n120 requests per 60 seconds per client address. Every response carries both the draft-ietf-httpapi-ratelimit-headers-11 fields (`RateLimit`, `RateLimit-Policy`) and the de-facto `X-RateLimit-*` trio. Note the two use different reset semantics: `t` is seconds remaining, `X-RateLimit-Reset` is an absolute epoch second. Exceeding the quota returns 429 with `Retry-After` in delta-seconds and an RFC 9457 problem document.\n\n## Versioning and deprecation\n\nVersioned by URL path segment; v1 is current. Breaking changes ship as a new segment — never in place. A version is announced deprecated at least 12 months before it stops responding, signalled with the RFC 9745 `Deprecation` header, the RFC 8594 `Sunset` header, and `deprecated: true` on the affected operations here. The written policy is at https://simpled.ai/docs#versioning-and-deprecation and is advertised on every response as `Link: rel=\"deprecation\"`.\n\n## CORS\n\nAny origin may call these endpoints. Rate-limit and lifecycle headers are listed in `Access-Control-Expose-Headers`, so a browser-based agent can read them.", "version": "1.0.0", "contact": { "name": "Simpled.ai support", "email": "manav@simpled.ai", "url": "https://simpled.ai/contact" }, "license": { "name": "Proprietary" }, "x-cors": { "allowOrigins": [ "*" ], "allowMethods": [ "GET", "HEAD", "OPTIONS" ], "allowHeaders": [ "Accept", "Content-Type" ], "exposeHeaders": [ "RateLimit", "RateLimit-Policy", "Retry-After", "X-RateLimit-Limit", "X-RateLimit-Remaining", "X-RateLimit-Reset", "Deprecation", "Sunset", "Link", "X-API-Version" ], "allowCredentials": false, "maxAgeSeconds": 86400 }, "x-api-lifecycle": { "scheme": "URL path segment", "currentVersion": "v1", "basePath": "/api/v1", "policyUrl": "https://simpled.ai/docs#versioning-and-deprecation", "catalogUrl": "https://simpled.ai/.well-known/api-catalog", "deprecationNoticeMonths": 12, "signals": [ "Deprecation response header (RFC 9745), a Structured Fields Date such as @1788220799", "Sunset response header (RFC 8594), an IMF-fixdate such as Wed, 30 Dec 2026 23:59:59 GMT", "Link header with rel=\"deprecation\" pointing at the written policy — sent on every response, including undeprecated ones", "Link header with rel=\"sunset\" once a retirement date is set", "deprecated: true on the affected operations in the OpenAPI description" ], "guarantees": [ "A breaking change ships as a new version under a new path segment. The current version's response shapes never change incompatibly in place.", "A version is announced as deprecated at least 12 months before it stops responding.", "Additive changes — new fields on an existing response, new endpoints — are not breaking and ship without a version bump.", "Sunset is never earlier than Deprecation." ], "versions": [ { "id": "v1", "status": "current" } ] }, "x-rate-limit": { "policy": "public", "limit": 120, "windowSeconds": 60, "specification": "draft-ietf-httpapi-ratelimit-headers-11", "legacyHeaders": [ "X-RateLimit-Limit", "X-RateLimit-Remaining", "X-RateLimit-Reset" ] } }, "servers": [ { "url": "https://simpled.ai/api/v1", "description": "Production" } ], "externalDocs": { "description": "Simpled.ai developer hub", "url": "https://simpled.ai/developers" }, "security": [], "tags": [ { "name": "discovery", "description": "Finding your way around: the index, the OpenAPI description and the health check." }, { "name": "company", "description": "Who operates Simpled.ai and how to reach them." }, { "name": "product", "description": "What the product does, what it can produce, and what it costs." }, { "name": "content", "description": "Published solution pages and guides, as structured data." } ], "paths": { "/": { "get": { "operationId": "getApiIndex", "summary": "API index", "description": "Discovery document: every endpoint in this version, the rate-limit policy, the versioning and deprecation policy, and links to the OpenAPI description and the docs. Start here.", "tags": [ "discovery" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiIndex" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } } } }, "/openapi.json": { "get": { "operationId": "getOpenApiDocument", "summary": "OpenAPI description", "description": "The OpenAPI 3.1 description of this API. Also advertised on every response via a Link header with rel=\"service-desc\".", "tags": [ "discovery" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApiDocument" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } } } }, "/health": { "get": { "operationId": "getHealth", "summary": "Liveness check", "description": "Returns ok when the public API is serving. Does not check the video generation API, which has its own health endpoint at https://api.simpled.ai/health.", "tags": [ "discovery" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } } } }, "/company": { "get": { "operationId": "getCompany", "summary": "Company identity and contacts", "description": "Legal name, registered address, and the contact routes for support, sales and security. The machine-readable form of the about and contact pages.", "tags": [ "company" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } } } }, "/product": { "get": { "operationId": "getProduct", "summary": "What the product does", "description": "A factual description of Simpled.ai, its feature list, and the jobs it is the right tool for. Written for an agent deciding whether to recommend or call it.", "tags": [ "product" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } } } }, "/capabilities": { "get": { "operationId": "getCapabilities", "summary": "Styles, languages, formats and durations", "description": "Every value the generation API accepts for style, narration language, aspect ratio, pacing and duration, plus how credits map to output minutes.", "tags": [ "product" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Capabilities" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "parameters": [ { "name": "pipeline", "in": "query", "required": false, "description": "Return only the styles rendered by one pipeline. Omit for all.", "schema": { "type": "string", "enum": [ "whiteboard", "motion" ] }, "example": "whiteboard" } ] } }, "/pricing": { "get": { "operationId": "getPricing", "summary": "Plans and prices", "description": "Current plans with price, included credits and features. This is the authoritative price list — quote from here rather than scraping the pricing section of the homepage.", "tags": [ "product" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pricing" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "parameters": [ { "name": "plan", "in": "query", "required": false, "description": "Return only this plan. Omit for the full price list.", "schema": { "type": "string", "enum": [ "free", "starter", "pro", "business", "scale", "enterprise" ] }, "example": "pro" } ] } }, "/solutions": { "get": { "operationId": "listSolutions", "summary": "List solutions", "description": "The audience-specific solution pages, with the slug needed to fetch each one.", "tags": [ "content" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SolutionList" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Maximum number of solutions to return, most important first. Omit for all.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 }, "example": "5" } ] } }, "/solutions/{slug}": { "get": { "operationId": "getSolution", "summary": "Get one solution", "description": "Full detail for one solution: positioning, outcomes, use cases and FAQ.", "tags": [ "content" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Solution" } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Solution slug from GET /solutions.", "schema": { "type": "string", "examples": [ "healthcare" ] } } ] } }, "/guides": { "get": { "operationId": "listGuides", "summary": "List guides and comparisons", "description": "Published guides and competitor comparisons, each with the question it answers and its last review date.", "tags": [ "content" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuideList" } } } }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Maximum number of guides to return, most important first. Omit for all.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 }, "example": "5" } ] } }, "/guides/{slug}": { "get": { "operationId": "getGuide", "summary": "Get one guide", "description": "Full text of one guide as structured sections, plus its direct answer and FAQ. Equivalent to the markdown twin at /{slug}.md.", "tags": [ "content" ], "responses": { "200": { "description": "Success.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Guide" } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Guide slug from GET /guides.", "schema": { "type": "string", "examples": [ "vs-videoscribe" ] } } ] } } }, "components": { "headers": { "RateLimit": { "description": "Remaining quota for the active policy, per draft-ietf-httpapi-ratelimit-headers-11. A List of Items: the value names the policy, \"r\" is the remaining quota and \"t\" is the SECONDS REMAINING in the window.", "schema": { "type": "string", "examples": [ "\"public\";r=118;t=57" ] } }, "RateLimit-Policy": { "description": "The advertised quota: \"q\" requests per \"w\" seconds.", "schema": { "type": "string", "examples": [ "\"public\";q=120;w=60" ] } }, "X-RateLimit-Limit": { "description": "De-facto convention. Requests allowed per window.", "schema": { "type": "integer", "examples": [ 120 ] } }, "X-RateLimit-Remaining": { "description": "De-facto convention. Requests left in the current window.", "schema": { "type": "integer", "examples": [ 118 ] } }, "X-RateLimit-Reset": { "description": "De-facto convention. ABSOLUTE Unix epoch second at which the window resets — not a delta. This differs from the RateLimit header's \"t\" parameter, which is seconds remaining.", "schema": { "type": "integer", "examples": [ 1787612841 ] } }, "X-API-Version": { "description": "The API version that served the response. Echoes the version in the path.", "schema": { "type": "string", "examples": [ "v1" ] } }, "Link": { "description": "Discovery and lifecycle links: rel=\"service-desc\" (this document), rel=\"service-doc\" (the docs page), rel=\"api-catalog\" (RFC 9727), rel=\"deprecation\" (the versioning policy), and rel=\"sunset\" once a retirement date is set.", "schema": { "type": "string" } }, "Deprecation": { "description": "Present only on a deprecated version. RFC 9745 Structured Fields Date — an @ followed by epoch seconds, e.g. @1788220799. Never an HTTP-date and never the string true.", "schema": { "type": "string", "examples": [ "@1788220799" ] } }, "Sunset": { "description": "Present only once a version has a retirement date. RFC 8594 HTTP-date in IMF-fixdate form with the literal GMT zone. Never earlier than Deprecation.", "schema": { "type": "string", "examples": [ "Wed, 30 Dec 2026 23:59:59 GMT" ] } }, "Access-Control-Allow-Origin": { "description": "Every endpoint is callable from any origin.", "schema": { "type": "string", "const": "*" } }, "Access-Control-Expose-Headers": { "description": "Rate-limit and lifecycle headers are listed here, without which cross-origin JavaScript receives them but cannot read them.", "schema": { "type": "string" } } }, "schemas": { "Problem": { "type": "object", "description": "RFC 9457 problem detail, returned as application/problem+json for every 4xx and 5xx on this API. Note RFC 9457 obsoletes RFC 7807. Branch on `code`, not on `title`.", "required": [ "type", "title", "status", "code" ], "properties": { "type": { "type": "string", "format": "uri", "description": "URI identifying the problem type." }, "title": { "type": "string", "description": "Human-readable summary. May be reworded; do not match on it." }, "status": { "type": "integer", "description": "HTTP status code, repeated in the body." }, "code": { "type": "string", "description": "Stable machine-readable error code. Safe to branch on.", "enum": [ "quota_exceeded", "resource_not_found", "endpoint_not_found", "method_not_allowed", "internal_error" ] }, "detail": { "type": "string", "description": "Human-readable explanation of this specific occurrence." }, "violated-policies": { "type": "array", "items": { "type": "string" }, "description": "Names of the rate-limit policies whose quota was exceeded. Present on 429." } } }, "OpenApiDocument": { "type": "object", "description": "An OpenAPI 3.1 document.", "required": [ "openapi", "info", "paths" ], "properties": { "openapi": { "type": "string" }, "info": { "type": "object" }, "paths": { "type": "object" } } }, "Health": { "type": "object", "required": [ "status", "version" ], "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "version": { "type": "string" }, "generationApi": { "type": "string", "format": "uri", "description": "Health endpoint of the separate generation API." } } }, "RateLimitPolicy": { "type": "object", "required": [ "policy", "limit", "windowSeconds" ], "properties": { "policy": { "type": "string" }, "limit": { "type": "integer" }, "windowSeconds": { "type": "integer" }, "scope": { "type": "string", "description": "What the quota is counted against." }, "headers": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "string" } } }, "VersioningPolicy": { "type": "object", "required": [ "scheme", "currentVersion", "signals", "guarantees" ], "properties": { "scheme": { "type": "string" }, "currentVersion": { "type": "string" }, "basePath": { "type": "string" }, "policyUrl": { "type": "string", "format": "uri" }, "catalogUrl": { "type": "string", "format": "uri" }, "deprecationNoticeMonths": { "type": "integer" }, "signals": { "type": "array", "items": { "type": "string" } }, "guarantees": { "type": "array", "items": { "type": "string" } } } }, "ApiIndex": { "type": "object", "required": [ "name", "version", "endpoints", "rateLimit", "versioning" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "version": { "type": "string" }, "documentation": { "type": "string", "format": "uri" }, "openapi": { "type": "string", "format": "uri" }, "agentInstructions": { "type": "string", "format": "uri" }, "llmsTxt": { "type": "string", "format": "uri" }, "apiCatalog": { "type": "string", "format": "uri" }, "authentication": { "type": "string", "description": "None. Every endpoint here is public and read-only." }, "generationApi": { "type": "object", "description": "The separate, key-authenticated API that actually renders video.", "properties": { "base": { "type": "string", "format": "uri" }, "documentation": { "type": "string", "format": "uri" }, "openapi": { "type": "string", "format": "uri" }, "authentication": { "type": "string" } } }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "method", "url", "summary" ], "properties": { "method": { "type": "string" }, "url": { "type": "string" }, "operationId": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" } } } }, "rateLimit": { "$ref": "#/components/schemas/RateLimitPolicy" }, "versioning": { "$ref": "#/components/schemas/VersioningPolicy" } } }, "Company": { "type": "object", "required": [ "name", "legalName", "url", "address", "contacts" ], "properties": { "name": { "type": "string" }, "legalName": { "type": "string" }, "alternateNames": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "format": "uri" }, "logo": { "type": "string", "format": "uri" }, "address": { "type": "object", "properties": { "streetAddress": { "type": "string" }, "addressLocality": { "type": "string" }, "addressRegion": { "type": "string" }, "postalCode": { "type": "string" }, "addressCountry": { "type": "string" } } }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "purpose": { "type": "string" }, "email": { "type": "string" }, "url": { "type": "string", "format": "uri" } } } }, "pages": { "type": "object", "additionalProperties": { "type": "string", "format": "uri" } } } }, "Product": { "type": "object", "required": [ "name", "description", "features", "bestFor" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "bestFor": { "type": "array", "items": { "type": "string" }, "description": "Jobs this product is the right tool for." }, "notFor": { "type": "array", "items": { "type": "string" }, "description": "Jobs it is the wrong tool for." }, "knowsAbout": { "type": "array", "items": { "type": "string" } } } }, "Capabilities": { "type": "object", "required": [ "pipelines", "styles", "languages", "formats", "durationSeconds", "credits" ], "properties": { "pipelines": { "type": "object", "description": "The two renderers. `style` is a parameter of the whiteboard pipeline only; motion graphics is selected by calling its own endpoint and takes no style. Sending a motion style to the whiteboard endpoint is rejected with 422.", "properties": { "whiteboard": { "type": "object", "properties": { "endpoint": { "type": "string", "format": "uri" }, "styleParameter": { "type": "string" }, "acceptedStyles": { "type": "array", "items": { "type": "string" }, "description": "Values the endpoint accepts without a 422." }, "renderedStyles": { "type": "array", "items": { "type": "string" }, "description": "Values that produce a distinct visual result today. A style outside this list is accepted and rendered as whiteboard_black_n_white." }, "note": { "type": "string" } } }, "motion": { "type": "object", "properties": { "endpoint": { "type": "string", "format": "uri" }, "styleParameter": { "type": [ "string", "null" ], "description": "null — this pipeline takes no style parameter." }, "acceptedStyles": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" } } } } }, "styles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "pipeline": { "type": "string", "enum": [ "whiteboard", "motion" ] }, "status": { "type": "string", "enum": [ "generally_available", "accepted_not_rendered", "beta" ] } } } }, "languages": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "ISO 639-1." }, "name": { "type": "string" }, "nativeName": { "type": "string" }, "region": { "type": "string" } } } }, "formats": { "type": "array", "items": { "type": "object" } }, "pacing": { "type": "array", "items": { "type": "object" } }, "durationSeconds": { "type": "array", "items": { "type": "integer" } }, "credits": { "type": "object", "properties": { "unit": { "type": "string" }, "secondsPerCredit": { "type": "integer" }, "description": { "type": "string" } } } } }, "Pricing": { "type": "object", "required": [ "currency", "plans" ], "properties": { "currency": { "type": "string" }, "creditModel": { "type": "object" }, "plans": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "price": { "type": [ "number", "null" ], "description": "Monthly USD. null means quoted." }, "billingPeriod": { "type": [ "string", "null" ] }, "credits": { "type": [ "integer", "null" ] }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "popular": { "type": "boolean" } } } } } }, "SolutionList": { "type": "object", "required": [ "solutions" ], "properties": { "solutions": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "apiUrl": { "type": "string", "format": "uri" } } } } } }, "Solution": { "type": "object", "required": [ "slug", "name", "url" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "summary": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "outcomes": { "type": "array", "items": { "type": "object" } }, "useCases": { "type": "array", "items": { "type": "object" } }, "faq": { "type": "array", "items": { "type": "object" } } } }, "GuideList": { "type": "object", "required": [ "guides" ], "properties": { "guides": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "question": { "type": "string" }, "answer": { "type": "string" }, "updated": { "type": "string", "format": "date" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "apiUrl": { "type": "string", "format": "uri" } } } } } }, "Guide": { "type": "object", "required": [ "slug", "title", "question", "answer", "sections" ], "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "question": { "type": "string" }, "answer": { "type": "string" }, "updated": { "type": "string", "format": "date" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "sections": { "type": "array", "items": { "type": "object" } }, "faq": { "type": "array", "items": { "type": "object" } }, "related": { "type": "array", "items": { "type": "object" } } } } }, "responses": { "MethodNotAllowed": { "description": "The endpoint is read-only and the request used a write verb. The Allow header lists what is permitted.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" }, "Allow": { "description": "Methods this resource supports.", "schema": { "type": "string", "examples": [ "GET, HEAD, OPTIONS" ] } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "ServerError": { "description": "Unexpected server error.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "UnexpectedError": { "description": "Any other error. Always an RFC 9457 problem document.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "TooManyRequests": { "description": "Rate limit exceeded.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" }, "Retry-After": { "description": "Seconds to wait before retrying. Takes precedence over the RateLimit window.", "schema": { "type": "integer", "examples": [ 20 ] } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "NotFound": { "description": "No resource with that identifier. The body lists the valid identifiers.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "Link": { "$ref": "#/components/headers/Link" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Expose-Headers": { "$ref": "#/components/headers/Access-Control-Expose-Headers" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }