Oversigt og hurtig start

Sketchie forvandler en prompt eller et dokument til en whiteboard-forklaringsvideo og giver dig både den renderede video og dens redigerbare scene graph tilbage. Dette er referencen for HTTP-API, CLI, TypeScript-SDK og MCP-serveren.

API-adgang er inkluderet i hver betalt plan. Opret en API-nøgle fra Indstillinger i appen, når du har en plan. API-genereringer trækker fra dine planminutter med samme takst som appen. Der er ingen separat API-pris.

Godkendelse

Hver anmodning godkendes med din API-nøgle som Bearer-token. Opret en nøgle i appen under Indstillinger, og send den derefter i Authorization-headeren:

Anmodningsheader 
Authorization: Bearer sk_...

Nøglen vises én gang, ved oprettelsen. Hold den hemmelig. Basis-URL for hvert endpoint er https://sketchie.ai/api.

Hurtig start

1. Opret en forklaring

Send dit emne som input og en valgfri mållængde som length (en venlig "M:SS"-streng som "0:30" eller "1:00", i trin på 30 sekunder). Udelad length for automatisk længde.

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

Kaldet returnerer straks 202 Accepted med en post i køen. Renderingen kører i baggrunden og tager et par minutter.

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

Hent forklaringen via id, indtil dens status når en sluttilstand. Livscyklussen er queued, derefter generating, derefter rendering, derefter ready (færdig) eller failed.

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

Når den er ready, bærer posten video-URL og den redigerbare scene graph:

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

Venlige og klassiske feltnavne. input og length er de venlige anmodningsfelter. De ældre prompt (streng) og lengthSeconds (et tal, et positivt multiplum af 30) accepteres stadig som aliasser, så eksisterende integrationer bliver ved med at virke. Når begge sendes, vinder det venlige felt.

Hvor du skal gå videre

  • API-reference . Hvert endpoint, med anmodnings- og svarformer.
  • Stemmer . Standardfortælleren, kataloget med seks stemmer og afspillelige forhåndsvisninger.
  • Sprog . De 34 understøttede fortællesprog.
  • CLI og SDK . sketchie-kommandolinjen og @sketchie/sdk TypeScript-klienten.
  • MCP-opsætning . Brug Sketchie som værktøjer i Claude Desktop, Claude Code og Claude-appen.