Oversikt og hurtigstart

Sketchie gjør en prompt eller et dokument om til en tavleforklaringsvideo, og gir deg tilbake både den gjengitte videoen og dens redigerbare scene graph. Dette er referansen for HTTP-API-et, CLI-et, TypeScript-SDK-et og MCP-serveren.

API-tilgang er inkludert i hvert betalt abonnement. Opprett en API-nøkkel fra Innstillinger i appen når du har et abonnement. API-genereringer trekker fra abonnementsminuttene dine med samme takst som appen. Det er ingen egen API-pris.

Autentisering

Hver forespørsel autentiseres med API-nøkkelen din som Bearer-token. Opprett en nøkkel i appen under Innstillinger, og send den deretter i Authorization-headeren:

Forespørselsheader 
Authorization: Bearer sk_...

Nøkkelen vises én gang, ved opprettelse. Hold den hemmelig. Basis-URL-en for hvert endepunkt er https://sketchie.ai/api.

Hurtigstart

1. Opprett en forklaring

Send temaet ditt som input og en valgfri mållengde som length (en vennlig "M:SS"-streng som "0:30" eller "1:00", i trinn på 30 sekunder). Utelat length for automatisk lengde.

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 umiddelbart med en post i kø. Gjengivelsen kjører i bakgrunnen og tar noen 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 etter resultatet

Hent forklaringen via id til status når en 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 den er ready, bærer 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": [ ... ] }
}

Vennlige og klassiske feltnavn. input og length er de vennlige forespørselsfeltene. De eldre prompt (streng) og lengthSeconds (et tall, et positivt multiplum av 30) godtas fortsatt som aliaser, så eksisterende integrasjoner fortsetter å fungere. Når begge sendes, vinner det vennlige feltet.

Hvor du skal gå videre

  • API-referanse . Hvert endepunkt, med forespørsels- og svarformer.
  • Stemmer . Standardfortelleren, katalogen med seks stemmer og spillbare forhåndsvisninger.
  • Språk . De 34 støttede fortellerspråkene.
  • CLI og SDK . sketchie-kommandolinjen og @sketchie/sdk TypeScript-klienten.
  • MCP-oppsett . Bruk Sketchie som verktøy i Claude Desktop, Claude Code og Claude-appen.