Überblick und Schnellstart

Sketchie verwandelt einen Prompt oder ein Dokument in ein Whiteboard-Erklärvideo und gibt dir sowohl das gerenderte Video als auch seinen editierbaren Scene Graph zurück. Dies ist die Referenz für die HTTP-API, die CLI, das TypeScript-SDK und den MCP-Server.

API-Zugang ist in jedem bezahlten Plan enthalten. Erstelle einen API-Schlüssel in den Einstellungen der App, sobald du einen Plan hast. API-Generierungen ziehen deine Planminuten zur gleichen Rate wie die App. Es gibt keinen separaten API-Preis.

Authentifizierung

Jede Anfrage wird mit deinem API-Schlüssel als Bearer-Token authentifiziert. Erstelle einen Schlüssel in der App unter Einstellungen und sende ihn dann im Authorization-Header:

Anfrage-Header 
Authorization: Bearer sk_...

Der Schlüssel wird einmal bei der Erstellung angezeigt. Halte ihn geheim. Die Basis-URL für jeden Endpunkt ist https://sketchie.ai/api.

Schnellstart

1. Erstelle ein Erklärvideo

Sende dein Thema als input und eine optionale Ziel-Länge als length (ein freundlicher "M:SS"-String wie "0:30" oder "1:00", in 30-Sekunden-Schritten). Lass length für automatische Länge weg.

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"
  }'

Der Aufruf gibt sofort 202 Accepted mit einem eingereihten Datensatz zurück. Das Rendering läuft im Hintergrund und dauert ein 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. Frage das Ergebnis ab

Rufe das Erklärvideo per id ab, bis sein status einen Endzustand erreicht. Der Lebenszyklus ist queued, dann generating, dann rendering, dann ready (fertig) oder failed.

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

Wenn es ready ist, trägt der Datensatz die Video-URL und den editierbaren Scene Graph:

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

Freundliche und klassische Feldnamen. input und length sind die freundlichen Anfrage-Felder. Die älteren prompt (String) und lengthSeconds (eine Zahl, ein positives Vielfaches von 30) werden weiterhin als Aliase akzeptiert, sodass bestehende Integrationen weiterlaufen. Wenn beide gesendet werden, gewinnt das freundliche Feld.

Wohin als Nächstes

  • API-Referenz . Jeder Endpunkt, mit Anfrage- und Antwortformen.
  • Stimmen . Die Standard-Erzählstimme, der Sechs-Stimmen-Katalog und abspielbare Vorschauen.
  • Sprachen . Die 34 unterstützten Erzählsprachen.
  • CLI und SDK . Die sketchie-Kommandozeile und der @sketchie/sdk-TypeScript-Client.
  • MCP-Einrichtung . Nutze Sketchie als Tools in Claude Desktop, Claude Code und der Claude-App.