Pregled i brzi početak

Sketchie pretvara prompt ili dokument u videozapis objašnjenja na ploči i vraća vam i renderirani videozapis i njegov uredivi scene graph. Ovo je referenca za HTTP API, CLI, TypeScript SDK i MCP poslužitelj.

Pristup API-ju uključen je u svaki plaćeni plan. Izradite API ključ iz Postavki u aplikaciji kada imate plan. Generiranja putem API-ja troše minute vašeg plana po istoj stopi kao aplikacija. Nema zasebne cijene API-ja.

Autentifikacija

Svaki zahtjev autentificira se vašim API ključem kao Bearer tokenom. Izradite ključ u aplikaciji u Postavkama, a zatim ga pošaljite u zaglavlju Authorization:

Zaglavlje zahtjeva
Authorization: Bearer sk_...

Ključ se prikazuje jednom, pri izradi. Čuvajte ga u tajnosti. Osnovni URL za svaku krajnju točku je https://sketchie.ai/api.

Brzi početak

1. Izradite objašnjenje

Pošaljite svoju temu kao input i neobaveznu ciljanu duljinu kao length (prijazan niz "M:SS" poput "0:30" ili "1:00", u koracima od 30 sekundi). Izostavite length za automatsku duljinu.

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

Poziv odmah vraća 202 Accepted sa zapisom u redu. Renderiranje se izvodi u pozadini i traje nekoliko minuta.

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. Pratite rezultat

Dohvaćajte objašnjenje po id-u dok njegov status ne dosegne završno stanje. Životni ciklus je queued, zatim generating, zatim rendering, zatim ready (gotovo) ili failed.

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

Kada je ready, zapis nosi URL videozapisa i uredivi scene graph:

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

Prijazni i klasični nazivi polja. input i length prijazna su polja zahtjeva. Stariji prompt (niz) i lengthSeconds (broj, pozitivni višekratnik broja 30) i dalje se prihvaćaju kao aliasi, pa postojeće integracije nastavljaju raditi. Kada se pošalju oba, pobjeđuje prijazno polje.

Kamo dalje

  • API referenca . Svaka krajnja točka, s oblicima zahtjeva i odgovora.
  • Glasovi . Zadani pripovjedač, katalog od šest glasova i reproducibilni pregledi.
  • Jezici . 34 podržana jezika pripovijedanja.
  • CLI i SDK . Naredbeni redak sketchie i TypeScript klijent @sketchie/sdk.
  • Postavljanje MCP-a . Koristite Sketchie kao alate u Claude Desktopu, Claude Codeu i aplikaciji Claude.