Oversikt og snøggstart

Sketchie gjer ein prompt eller eit dokument om til ein tavleforklaringsvideo, og gjev deg tilbake både den gjengjevne videoen og den redigerbare scene graph-en hans. Dette er referansen for HTTP-API-et, CLI-et, TypeScript-SDK-et og MCP-tenaren.

API-tilgang er inkludert i kvart betalt abonnement. Lag ein API-nøkkel frå Innstillingar i appen når du har eit abonnement. API-genereringar trekkjer frå abonnementsminutta dine med same takst som appen. Det finst ingen eigen API-pris.

Autentisering

Kvar førespurnad blir autentisert med API-nøkkelen din som Bearer-token. Lag ein nøkkel i appen under Innstillingar, og send han deretter i Authorization-headeren:

Førespurnadheader 
Authorization: Bearer sk_...

Nøkkelen blir vist éin gong, ved oppretting. Hald han hemmeleg. Basis-URL-en for kvart endepunkt er https://sketchie.ai/api.

Snøggstart

1. Lag ei forklaring

Send temaet ditt som input og ei valfri mållengd som length (ein vennleg "M:SS"-streng som "0:30" eller "1:00", i steg på 30 sekund). Utelat length for automatisk lengd.

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

Kallet returnerer 202 Accepted med ein gong med ein post i kø. Gjengjevinga køyrer i bakgrunnen og tek nokre minutt.

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

Hent forklaringa via id til status når ein slutt-tilstand. Livssyklusen er queued, så generating, så rendering, så ready (ferdig) eller failed.

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

Når ho er ready, ber posten video-URL-en og den redigerbare scene graph-en:

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

Vennlege og klassiske feltnamn. input og length er dei vennlege førespurnadfelta. Dei eldre prompt (streng) og lengthSeconds (eit tal, eit positivt multiplum av 30) blir framleis godtekne som aliasar, så eksisterande integrasjonar held fram med å verke. Når begge blir sende, vinn det vennlege feltet.

Kvar du skal gå vidare

  • API-referanse . Kvart endepunkt, med førespurnad- og svarformer.
  • Stemmer . Standardforteljaren, katalogen med seks stemmer og spelbare førehandsvisingar.
  • Språk . Dei 34 støtta forteljarspråka.
  • CLI og SDK . sketchie-kommandolinja og @sketchie/sdk TypeScript-klienten.
  • MCP-oppsett . Bruk Sketchie som verktøy i Claude Desktop, Claude Code og Claude-appen.