Pregled in hitri začetek

Sketchie spremeni poziv ali dokument v razlagalni video na tabli in vam vrne tako upodobljeni video kot njegov urejljivi scene graph. To je referenca za HTTP API, CLI, TypeScript SDK in strežnik MCP.

Dostop do API-ja je vključen v vsak plačljivi paket. Ustvarite ključ API v Nastavitvah v aplikaciji, ko imate paket. Generiranja prek API-ja črpajo iz minut vašega paketa po enaki stopnji kot aplikacija. Ločene cene API ni.

Overjanje

Vsaka zahteva se overi z vašim ključem API kot žeton Bearer. Ustvarite ključ v aplikaciji pod Nastavitve, nato ga pošljite v glavi Authorization:

Glava zahteve 
Authorization: Bearer sk_...

Ključ se prikaže enkrat, ob ustvarjanju. Hranite ga v tajnosti. Osnovni URL za vsako končno točko je https://sketchie.ai/api.

Hitri začetek

1. Ustvarite razlago

Pošljite svojo temo kot input in izbirno ciljno dolžino kot length (prijazen niz "M:SS", kot je "0:30" ali "1:00", v korakih po 30 sekund). Izpustite length za samodejno dolžino.

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

Klic takoj vrne 202 Accepted z zapisom v čakalni vrsti. Upodabljanje teče v ozadju in traja nekaj 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. Poizvedujte za rezultat

Pridobivajte razlago po id, dokler njen status ne doseže končnega stanja. Življenjski cikel je queued, nato generating, nato rendering, nato ready (končano) ali failed.

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

Ko je ready, zapis nosi URL videa in urejljivi scene graph:

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

Prijazna in klasična imena polj. input in length sta prijazni polji zahteve. Starejša prompt (niz) in lengthSeconds (število, pozitivni večkratnik 30) sta še vedno sprejeta kot vzdevka, tako da obstoječe integracije še naprej delujejo. Ko sta poslana oba, zmaga prijazno polje.

Kam naprej

  • Referenca API . Vsaka končna točka z oblikami zahteve in odgovora.
  • Glasovi . Privzeti pripovedovalec, katalog šestih glasov in predvajljivi predogledi.
  • Jeziki . 34 podprtih jezikov pripovedovanja.
  • CLI in SDK . Ukazna vrstica sketchie in odjemalec @sketchie/sdk v TypeScriptu.
  • Nastavitev MCP . Uporabljajte Sketchie kot orodja v Claude Desktop, Claude Code in aplikaciji Claude.