Yleiskatsaus ja pika-aloitus

Sketchie muuttaa kehotteen tai asiakirjan valkotaulun selitysvideoksi ja palauttaa sinulle sekä renderöidyn videon että sen muokattavan scene graphin. Tämä on viite HTTP-API:lle, CLI:lle, TypeScript-SDK:lle ja MCP-palvelimelle.

API-käyttö sisältyy jokaiseen maksulliseen tilaukseen. Luo API-avain sovelluksen Asetuksista, kun sinulla on tilaus. API-luonnit kuluttavat tilauksesi minuutteja samalla hinnalla kuin sovellus. Erillistä API-hintaa ei ole.

Todennus

Jokainen pyyntö todennetaan API-avaimellasi Bearer-tunnisteena. Luo avain sovelluksessa Asetuksissa ja lähetä se sitten Authorization-otsakkeessa:

Pyynnön otsake 
Authorization: Bearer sk_...

Avain näytetään kerran, luonnin yhteydessä. Pidä se salassa. Jokaisen päätepisteen perus-URL on https://sketchie.ai/api.

Pika-aloitus

1. Luo selitys

Lähetä aiheesi arvona input ja valinnainen tavoitepituus arvona length (ystävällinen "M:SS"-merkkijono kuten "0:30" tai "1:00", 30 sekunnin askelin). Jätä length pois automaattista pituutta varten.

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

Kutsu palauttaa 202 Accepted heti jonossa olevan tietueen kanssa. Renderöinti tapahtuu taustalla ja kestää muutaman minuutin.

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. Pollaa tulosta

Nouda selitys id:llä, kunnes sen status saavuttaa lopputilan. Elinkaari on queued, sitten generating, sitten rendering, sitten ready (valmis) tai failed.

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

Kun se on ready, tietue kantaa videon URL:n ja muokattavan scene graphin:

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

Ystävälliset ja klassiset kenttänimet. input ja length ovat ystävälliset pyyntökentät. Vanhemmat prompt (merkkijono) ja lengthSeconds (luku, positiivinen 30:n monikerta) hyväksytään yhä aliaksina, joten olemassa olevat integraatiot toimivat edelleen. Kun molemmat lähetetään, ystävällinen kenttä voittaa.

Minne mennä seuraavaksi

  • API-viite . Jokainen päätepiste pyyntö- ja vastausmuotoineen.
  • Äänet . Oletuskertoja, kuuden äänen luettelo ja toistettavat esikatselut.
  • Kielet . 34 tuettua kerrontakieltä.
  • CLI ja SDK . sketchie-komentorivi ja @sketchie/sdk TypeScript-asiakas.
  • MCP-asennus . Käytä Sketchietä työkaluina Claude Desktopissa, Claude Codessa ja Claude-sovelluksessa.