Përmbledhje dhe nisje e shpejtë

Sketchie e kthen një prompt ose një dokument në një video shpjeguese në tabelë dhe ju kthen si videon e renderuar ashtu edhe scene graph-un e saj të redaktueshëm. Ky është referenca për HTTP API, CLI, TypeScript SDK dhe serverin MCP.

Qasja në API përfshihet në çdo plan me pagesë. Krijoni një çelës API nga Cilësimet në aplikacion sapo të keni një plan. Gjenerimet me API tërheqin nga minutat e planit tuaj me të njëjtën normë si aplikacioni. Nuk ka çmim të veçantë API.

Vërtetimi

Çdo kërkesë vërtetohet me çelësin tuaj API si token Bearer. Krijoni një çelës në aplikacion nën Cilësimet, pastaj dërgojeni në kokën Authorization:

Koka e kërkesës 
Authorization: Bearer sk_...

Çelësi shfaqet një herë, gjatë krijimit. Mbajeni sekret. URL-ja bazë për çdo endpoint është https://sketchie.ai/api.

Nisje e shpejtë

1. Krijoni një shpjegim

Dërgoni temën tuaj si input dhe një gjatësi objektiv opsionale si length (një varg "M:SS" miqësor si "0:30" ose "1:00", në hapa 30 sekondash). Hiqni length për gjatësi automatike.

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

Thirrja kthen 202 Accepted menjëherë me një regjistrim në radhë. Renderimi zhvillohet në sfond dhe zgjat disa 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. Kërkoni rezultatin

Merrni shpjegimin sipas id derisa status i tij të arrijë një gjendje përfundimtare. Cikli i jetës është queued, pastaj generating, pastaj rendering, pastaj ready (përfunduar) ose failed.

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

Kur është ready, regjistrimi mban URL-në e videos dhe scene graph-un e redaktueshëm:

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

Emra fushash miqësorë dhe klasikë. input dhe length janë fushat miqësore të kërkesës. prompt (varg) dhe lengthSeconds (një numër, shumëfish pozitiv i 30) më të vjetra pranohen ende si pseudonime, kështu që integrimet ekzistuese vazhdojnë të funksionojnë. Kur dërgohen të dyja, fiton fusha miqësore.

Ku të shkoni më pas

  • Referenca API . Çdo endpoint, me format e kërkesës dhe përgjigjes.
  • Zërat . Tregimtari i parazgjedhur, katalogu me gjashtë zëra dhe pamjet paraprake të luajtshme.
  • Gjuhët . 34 gjuhët e mbështetura të tregimit.
  • CLI dhe SDK . Rreshti i komandës sketchie dhe klienti TypeScript @sketchie/sdk.
  • Konfigurimi MCP . Përdorni Sketchie si mjete në Claude Desktop, Claude Code dhe aplikacionin Claude.