Prehľad a rýchly štart

Sketchie premení prompt alebo dokument na vysvetľujúce video na tabuli a vráti vám tak vyrenderované video, ako aj jeho upraviteľný scene graph. Toto je referencia pre HTTP API, CLI, TypeScript SDK a server MCP.

Prístup k API je súčasťou každého plateného plánu. Vytvorte kľúč API v Nastaveniach v aplikácii, keď máte plán. Generovania cez API čerpajú z minút vášho plánu rovnakou sadzbou ako aplikácia. Neexistuje žiadna samostatná cena API.

Overenie

Každá požiadavka sa overuje vaším kľúčom API ako tokenom Bearer. Vytvorte kľúč v aplikácii v Nastaveniach a potom ho odošlite v hlavičke Authorization:

Hlavička požiadavky 
Authorization: Bearer sk_...

Kľúč sa zobrazí raz, pri vytvorení. Uchovávajte ho v tajnosti. Základná URL pre každý endpoint je https://sketchie.ai/api.

Rýchly štart

1. Vytvorte vysvetlenie

Odošlite svoju tému ako input a voliteľnú cieľovú dĺžku ako length (priateľský reťazec "M:SS" ako "0:30" alebo "1:00", v krokoch po 30 sekundách). Vynechajte length pre automatickú dĺžku.

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

Volanie okamžite vráti 202 Accepted so záznamom vo fronte. Rendering beží na pozadí a trvá niekoľko minút.

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. Dopytujte sa na výsledok

Načítavajte vysvetlenie podľa id, kým jeho status nedosiahne koncový stav. Životný cyklus je queued, potom generating, potom rendering, potom ready (hotovo) alebo failed.

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

Keď je ready, záznam nesie URL videa a upraviteľný scene graph:

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

Priateľské a klasické názvy polí. input a length sú priateľské polia požiadavky. Staršie prompt (reťazec) a lengthSeconds (číslo, kladný násobok 30) sa stále prijímajú ako aliasy, takže existujúce integrácie fungujú ďalej. Keď sa odošlú obe, vyhráva priateľské pole.

Kam pokračovať

  • Referencia API . Každý endpoint s tvarmi požiadavky a odpovede.
  • Hlasy . Predvolený rozprávač, katalóg šiestich hlasov a prehrateľné ukážky.
  • Jazyky . 34 podporovaných jazykov rozprávania.
  • CLI a SDK . Príkazový riadok sketchie a klient @sketchie/sdk v TypeScripte.
  • Nastavenie MCP . Používajte Sketchie ako nástroje v Claude Desktop, Claude Code a aplikácii Claude.