Overzicht en snelstart

Sketchie verandert een prompt of document in een whiteboard-uitlegvideo en geeft je zowel de gerenderde video als de bewerkbare scene graph ervan terug. Dit is de referentie voor de HTTP API, de CLI, de TypeScript SDK en de MCP-server.

API-toegang is inbegrepen bij elk betaald plan. Maak een API-sleutel aan via Instellingen in de app zodra je een plan hebt. API-generaties putten uit je planminuten tegen hetzelfde tarief als de app. Er is geen aparte API-prijs.

Authenticatie

Elk verzoek wordt geauthenticeerd met je API-sleutel als Bearer-token. Maak een sleutel aan in de app onder Instellingen en stuur die dan mee in de Authorization-header:

Verzoekheader 
Authorization: Bearer sk_...

De sleutel wordt één keer getoond, bij het aanmaken. Houd hem geheim. De basis-URL voor elk endpoint is https://sketchie.ai/api.

Snelstart

1. Maak een uitlegvideo

Stuur je onderwerp als input en een optionele doellengte als length (een vriendelijke "M:SS"-string zoals "0:30" of "1:00", in stappen van 30 seconden). Laat length weg voor automatische lengte.

Terminal 
curl -X POST https://sketchie.ai/api/v1/explainer \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Explain how DNS resolves a domain name",
    "length": "0:30"
  }'

De aanroep geeft direct 202 Accepted terug met een record in de wachtrij. Het renderen draait op de achtergrond en duurt een paar minuten.

202 Accepted 
{
  "id": "10f00eee-d2d6-4a1b-b708-f0391faaa85b",
  "status": "queued",
  "prompt": "Explain how DNS resolves a domain name",
  "lengthSeconds": 30,
  "voice": "sketchie:sulafat",
  "language": "en",
  "aspect": "16:9",
  "videoUrl": null,
  "sceneGraph": null
}

2. Poll naar het resultaat

Haal de uitlegvideo op via id totdat de status een eindtoestand bereikt. De levenscyclus is queued, dan generating, dan rendering, dan ready (klaar) of failed.

Terminal 
curl https://sketchie.ai/api/v1/explainer/10f00eee-d2d6-4a1b-b708-f0391faaa85b \
  -H "Authorization: Bearer sk_..."

Wanneer het ready is, draagt het record de video-URL en de bewerkbare scene graph:

200 OK 
{
  "id": "10f00eee-d2d6-4a1b-b708-f0391faaa85b",
  "status": "ready",
  "videoUrl": "https://sketchie.ai/media/....mp4",
  "sceneGraph": { "scenes": [ ... ] }
}

Vriendelijke en klassieke veldnamen. input en length zijn de vriendelijke verzoekvelden. De oudere prompt (string) en lengthSeconds (een getal, een positief veelvoud van 30) worden nog steeds als aliassen geaccepteerd, zodat bestaande integraties blijven werken. Als beide worden verstuurd, wint het vriendelijke veld.

Waar nu naartoe

  • API-referentie . Elk endpoint, met verzoek- en antwoordvormen.
  • Stemmen . De standaardverteller, de catalogus van zes stemmen en afspeelbare previews.
  • Talen . De 34 ondersteunde vertelstemtalen.
  • CLI en SDK . De sketchie-opdrachtregel en de @sketchie/sdk TypeScript-client.
  • MCP-installatie . Gebruik Sketchie als tools in Claude Desktop, Claude Code en de Claude-app.