Pangkalahatang-ideya at quickstart

Ginagawa ng Sketchie ang isang prompt o dokumento na whiteboard explainer video, at ibinabalik sa iyo kapwa ang na-render na video at ang na-e-edit na scene graph nito. Ito ang reperensya para sa HTTP API, ang CLI, ang TypeScript SDK, at ang MCP server.

Kasama ang API access sa bawat bayad na plano. Gumawa ng API key mula sa Settings sa app kapag nasa isang plano ka na. Ang mga API generation ay kumukuha mula sa mga minuto ng iyong plano sa parehong rate ng app. Walang hiwalay na presyo ng API.

Authentication

Bawat kahilingan ay napapatunayan gamit ang iyong API key bilang Bearer token. Gumawa ng key sa app sa ilalim ng Settings, pagkatapos ay ipadala ito sa Authorization header:

Request header 
Authorization: Bearer sk_...

Ipinapakita ang key nang isang beses, sa paggawa. Ilihim ito. Ang base URL para sa bawat endpoint ay https://sketchie.ai/api.

Quickstart

1. Gumawa ng explainer

Ipadala ang iyong paksa bilang input at isang opsyonal na target na haba bilang length (isang madaling "M:SS" string tulad ng "0:30" o "1:00", sa 30-segundong hakbang). Alisin ang length para sa awtomatikong haba.

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

Agad na nagbabalik ang tawag ng 202 Accepted kasama ang isang naka-queue na record. Tumatakbo sa background ang pag-render at umaabot ng ilang minuto.

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. I-poll ang resulta

Kunin ang explainer sa pamamagitan ng id hanggang maabot ng status nito ang isang terminal na estado. Ang lifecycle ay queued, tapos generating, tapos rendering, tapos ready (tapos na) o failed.

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

Kapag ito ay ready, dala ng record ang video URL at ang na-e-edit na scene graph:

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

Madali at klasikong mga pangalan ng field. Ang input at length ang madaling request field. Ang mas lumang prompt (string) at lengthSeconds (isang numero, positibong multiplo ng 30) ay tinatanggap pa rin bilang mga alias, kaya patuloy na gumagana ang mga umiiral na integration. Kapag pinadala ang dalawa, nananalo ang madaling field.

Saan susunod pupunta

  • API reference . Bawat endpoint, kasama ang mga hugis ng request at response.
  • Mga boses . Ang default na tagasalaysay, ang katalogo ng anim na boses, at mga naipapatugtog na preview.
  • Mga wika . Ang 34 na sinusuportahang wika ng pagsasalaysay.
  • CLI at SDK . Ang sketchie command line at ang @sketchie/sdk TypeScript client.
  • MCP setup . Gamitin ang Sketchie bilang mga tool sa Claude Desktop, Claude Code, at ang Claude app.