Přehled a rychlý start

Sketchie promění prompt nebo dokument ve vysvětlující video na tabuli a vrátí vám jak vyrenderované video, tak jeho upravitelný scene graph. Toto je reference pro HTTP API, CLI, TypeScript SDK a server MCP.

Přístup k API je součástí každého placeného plánu. Vytvořte klíč API v Nastavení v aplikaci, jakmile máte plán. Generování přes API čerpá z minut vašeho plánu stejnou sazbou jako aplikace. Neexistuje žádná samostatná cena API.

Ověření

Každý požadavek je ověřen vaším klíčem API jako tokenem Bearer. Vytvořte klíč v aplikaci v Nastavení a poté jej odešlete v hlavičce Authorization:

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

Klíč se zobrazí jednou, při vytvoření. Uchovejte jej v tajnosti. Základní URL pro každý endpoint je https://sketchie.ai/api.

Rychlý start

1. Vytvořte vysvětlení

Odešlete své téma jako input a volitelnou cílovou délku jako length (přívětivý řetězec "M:SS" jako "0:30" nebo "1:00", v krocích po 30 sekundách). Vynechte length pro automatickou délku.

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

Volání okamžitě vrátí 202 Accepted se záznamem ve frontě. Rendering běží na pozadí a trvá několik minut.

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. Dotazujte se na výsledek

Načítejte vysvětlení podle id, dokud jeho status nedosáhne koncového stavu. Životní cyklus je queued, poté generating, poté rendering, poté ready (hotovo) nebo failed.

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

Když je ready, záznam nese URL videa a upravitelný scene graph:

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

Přívětivé a klasické názvy polí. input a length jsou přívětivá pole požadavku. Starší prompt (řetězec) a lengthSeconds (číslo, kladný násobek 30) jsou stále přijímány jako aliasy, takže stávající integrace nadále fungují. Když jsou odeslána obě, vyhrává přívětivé pole.

Kam pokračovat

  • Reference API . Každý endpoint s tvary požadavku a odpovědi.
  • Hlasy . Výchozí vypravěč, katalog šesti hlasů a přehratelné náhledy.
  • Jazyky . 34 podporovaných jazyků vyprávění.
  • CLI a SDK . Příkazová řádka sketchie a klient @sketchie/sdk v TypeScriptu.
  • Nastavení MCP . Používejte Sketchie jako nástroje v Claude Desktop, Claude Code a aplikaci Claude.