Pārskats un ātrā sākšana

Sketchie pārvērš uzvedni vai dokumentu par tāfeles skaidrojošo video un atdod jums gan renderēto video, gan tā rediģējamo scene graph. Šī ir atsauce HTTP API, CLI, TypeScript SDK un MCP serverim.

API piekļuve ir iekļauta katrā maksas plānā. Izveidojiet API atslēgu lietotnes Iestatījumos, kad jums ir plāns. API ģenerēšana izmanto jūsu plāna minūtes ar tādu pašu likmi kā lietotne. Atsevišķas API cenas nav.

Autentifikācija

Katrs pieprasījums tiek autentificēts ar jūsu API atslēgu kā Bearer marķieri. Izveidojiet atslēgu lietotnē sadaļā Iestatījumi, pēc tam nosūtiet to galvenē Authorization:

Pieprasījuma galvene
Authorization: Bearer sk_...

Atslēga tiek parādīta vienreiz, izveides laikā. Turiet to slepenībā. Katra galapunkta bāzes URL ir https://sketchie.ai/api.

Ātrā sākšana

1. Izveidojiet skaidrojumu

Nosūtiet savu tēmu kā input un neobligātu mērķa garumu kā length (draudzīga "M:SS" virkne, piemēram, "0:30" vai "1:00", ar 30 sekunžu soļiem). Izlaidiet length automātiskam garumam.

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

Izsaukums nekavējoties atgriež 202 Accepted ar ierakstu rindā. Renderēšana notiek fonā un aizņem dažas minūtes.

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. Aptaujājiet rezultātu

Iegūstiet skaidrojumu pēc id, līdz tā status sasniedz galīgo stāvokli. Dzīves cikls ir queued, tad generating, tad rendering, tad ready (pabeigts) vai failed.

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

Kad tas ir ready, ieraksts nes video URL un rediģējamo scene graph:

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

Draudzīgi un klasiski lauku nosaukumi. input un length ir draudzīgie pieprasījuma lauki. Vecākie prompt (virkne) un lengthSeconds (skaitlis, pozitīvs 30 daudzkārtnis) joprojām tiek pieņemti kā aizstājvārdi, tāpēc esošās integrācijas turpina darboties. Kad tiek nosūtīti abi, uzvar draudzīgais lauks.

Kurp doties tālāk

  • API atsauce . Katrs galapunkts ar pieprasījuma un atbildes formām.
  • Balsis . Noklusējuma stāstītājs, sešu balsu katalogs un atskaņojami priekšskatījumi.
  • Valodas . 34 atbalstītās stāstījuma valodas.
  • CLI un SDK . sketchie komandrinda un @sketchie/sdk TypeScript klients.
  • MCP iestatīšana . Izmantojiet Sketchie kā rīkus Claude Desktop, Claude Code un Claude lietotnē.