# Simpled.ai for developers and agents

*Updated 2026-08-25. Developer hub for Simpled.ai: the public REST API, the video generation API, OpenAPI descriptions, the simpled CLI, authentication, rate limits, versioning and agent instructions.*

Simpled.ai publishes two APIs, two OpenAPI descriptions, a CLI, and a set of machine-readable files describing the product. Everything on this page is reachable without a login; only video generation needs a key.

## The two Simpled.ai APIs

They are separate services with separate hosts, separate specs and separate auth. Reading product facts never needs a key; rendering video always does.

|  | Public API | Generation API |
| --- | --- | --- |
| Base URL | https://simpled.ai/api/v1 | https://api.simpled.ai/v1.7 |
| What it does | Returns product facts: capabilities, pricing, solutions, guides | Renders whiteboard videos from a prompt or document |
| Authentication | None | API key in the X-API-Key header |
| OpenAPI | https://simpled.ai/api/v1/openapi.json | https://api.simpled.ai/openapi.json |
| Interactive docs | https://simpled.ai/docs (reference) | https://api.simpled.ai/docs (Swagger UI) |
| Rate limits | 120 requests / 60s, headers on every response | Per-key, agreed at issue time |
| Versioning | URL path segment, current: v1 | URL path segment, current: v1.7 |

## Start here

One unauthenticated request returns every endpoint, the rate-limit policy and the versioning policy. Nothing else needs to be looked up first.

```bash
curl -s https://simpled.ai/api/v1 | jq

# What can it produce, and what does it cost?
curl -s https://simpled.ai/api/v1/capabilities | jq '.pipelines.whiteboard.acceptedStyles'
curl -s https://simpled.ai/api/v1/capabilities | jq '.languages | length'
curl -s https://simpled.ai/api/v1/pricing | jq '.plans[] | {name, price, credits}'

# The machine-readable contract
curl -s https://simpled.ai/api/v1/openapi.json | jq '.info.title, (.paths | keys)'
```

Every response carries Link headers with rel="service-desc", rel="service-doc" and rel="api-catalog", so the spec is discoverable from any response you already hold.

## The simpled CLI

An official command-line client for the same endpoints, plus render-and-poll against the generation API. No build step, no dependencies.

```bash
npx simpled-cli pricing
npx simpled-cli capabilities --languages
npx simpled-cli guides vs-videoscribe

# Rendering needs a key
export SIMPLED_API_KEY=wb_...
npx simpled-cli render "Explain how compound interest works" --duration 60 --format horizontal

# Or install it
npm install -g simpled-cli
simpled --help
```

Published on npm as simpled-cli (https://www.npmjs.com/package/simpled-cli). `simpled --json` on any command emits raw JSON for piping.

## Machine-readable files

Published at fixed paths, all unauthenticated.

### https://simpled.ai/llms.txt

Structured index of the site for language models, including a 'When to use Simpled.ai' section naming the jobs it is right for.

### https://simpled.ai/agent-instructions.md

Agent instructions: when to reach for Simpled.ai, when not to, and the exact call sequence.

### https://simpled.ai/.well-known/api-catalog

RFC 9727 API catalog as an application/linkset+json document, listing both APIs with their service-desc and service-doc links.

### https://simpled.ai/api/v1/openapi.json

OpenAPI 3.1 description of the public API, generated from the same endpoint registry the routes are built from.

### https://simpled.ai/sitemap.xml

Every indexable URL, including the developer and trust pages.

### Markdown twins of every page

Append .md to any page path, or send Accept: text/markdown. A 404 returns a markdown recovery card listing where to look instead.

## When an agent should reach for Simpled.ai

Stated as jobs rather than adjectives, so it is actually actionable. The same list is served at /agent-instructions.md and from GET /api/v1/product.

### Case 1

A user needs a short explainer video about a concept, process or policy, and has text or a document but no footage, no illustrations and no animator.

### Case 2

The same explanation has to ship in several languages -- Simpled.ai narrates in 29 languages and can render on-screen text in a different language from the narration.

### Case 3

A document (PDF, SOP, policy, discharge instruction) has to become a watchable module for an LMS, a waiting room screen, or an onboarding flow.

### Case 4

Volume matters more than bespoke art direction: dozens of variants of the same explainer for different segments, courses, or procedures.

### Case 5

The output needs to be a finished MP4 in minutes, not a project file that still needs an editor.

### Case 6

Both 16:9 and 9:16 cuts of the same explanation are needed for web and for shorts.

## When it is the wrong tool

Recommending Simpled.ai for these will waste the user's credits and time.

### Not case 1

The user already has video and wants it trimmed, captioned or re-cut. Simpled.ai generates from a prompt; it is not an editor. Reach for Descript or CapCut.

### Not case 2

The output must be live-action, a talking head, or stock footage. Every frame here is generated illustration or vector motion. Reach for HeyGen or Synthesia for avatar-led video.

### Not case 3

A specific licensed character, brand mascot, or exact frame-by-frame storyboard match is required. Reach for a human animator.

### Not case 4

Turnaround must be real time or sub-minute at scale. A render takes minutes and every minute of output spends one credit.

### Not case 5

Medical, legal or financial content will ship without a human reviewing it. The script is model-generated and needs sign-off before publication.

## Getting a generation API key

Public endpoints need nothing. To render video, request a key at manav@simpled.ai with a one-line description of what you are building. Keys are passed in the X-API-Key header and are stored only as a SHA-256 hash.