Översikt och snabbstart

Sketchie förvandlar en prompt eller ett dokument till en whiteboard-förklaringsvideo och ger dig tillbaka både den renderade videon och dess redigerbara scene graph. Detta är referensen för HTTP-API:et, CLI:et, TypeScript-SDK:et och MCP-servern.

API-åtkomst ingår i varje betald plan. Skapa en API-nyckel från Inställningar i appen när du har en plan. API-genereringar dras från dina planminuter med samma takt som appen. Det finns inget separat API-pris.

Autentisering

Varje begäran autentiseras med din API-nyckel som Bearer-token. Skapa en nyckel i appen under Inställningar och skicka den sedan i Authorization-huvudet:

Begäranshuvud 
Authorization: Bearer sk_...

Nyckeln visas en gång, vid skapandet. Håll den hemlig. Bas-URL:en för varje endpoint är https://sketchie.ai/api.

Snabbstart

1. Skapa en förklaring

Skicka ditt ämne som input och en valfri mållängd som length (en vänlig "M:SS"-sträng som "0:30" eller "1:00", i steg om 30 sekunder). Utelämna length för automatisk längd.

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

Anropet returnerar 202 Accepted direkt med en köad post. Renderingen körs i bakgrunden och tar några minuter.

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. Polla efter resultatet

Hämta förklaringen via id tills dess status når ett slutläge. Livscykeln är queued, sedan generating, sedan rendering, sedan ready (klar) eller failed.

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

När den är ready bär posten video-URL:en och den redigerbara scene graph-en:

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

Vänliga och klassiska fältnamn. input och length är de vänliga begäransfälten. De äldre prompt (sträng) och lengthSeconds (ett tal, en positiv multipel av 30) accepteras fortfarande som alias, så befintliga integrationer fortsätter att fungera. När båda skickas vinner det vänliga fältet.

Vart du ska gå härnäst

  • API-referens . Varje endpoint, med begärans- och svarsformer.
  • Röster . Standardberättaren, katalogen med sex röster och spelbara förhandsvisningar.
  • Språk . De 34 språk som stöds för berättarröst.
  • CLI och SDK . Kommandoraden sketchie och TypeScript-klienten @sketchie/sdk.
  • MCP-installation . Använd Sketchie som verktyg i Claude Desktop, Claude Code och Claude-appen.