Kinatibuk-ang panglantaw ug quickstart

Ang Sketchie mohimo sa usa ka prompt o dokumento nga usa ka whiteboard explainer video, ug ibalik kanimo ang gi-render nga video ug ang ma-edit niini nga scene graph. Kini ang reperensya alang sa HTTP API, sa CLI, sa TypeScript SDK, ug sa MCP server.

Ang API access apil sa matag bayad nga plano. Paghimo og API key gikan sa Settings sa app kung naa na kay plano. Ang mga API generation mokuha gikan sa mga minuto sa imong plano sa samang rate sa app. Walay lahi nga presyo sa API.

Authentication

Ang matag hangyo gi-authenticate gamit ang imong API key isip Bearer token. Paghimo og key sa app ubos sa Settings, dayon ipadala kini sa Authorization header:

Request header 
Authorization: Bearer sk_...

Ang key gipakita kausa, sa paghimo. Tipigi kini nga sekreto. Ang base URL alang sa matag endpoint mao ang https://sketchie.ai/api.

Quickstart

1. Paghimo og explainer

Ipadala ang imong topiko isip input ug usa ka opsyonal nga target nga gitas-on isip length (usa ka mahigalaon nga "M:SS" string sama sa "0:30" o "1:00", sa 30-segundo nga mga lakang). I-omit ang length alang sa awtomatikong gitas-on.

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

Ang tawag mobalik og 202 Accepted dayon uban sa usa ka naka-queue nga record. Ang rendering modagan sa background ug mokabat og pipila ka 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

Kuhaa ang explainer pinaagi sa id hangtod nga ang status niini moabot sa usa ka terminal nga kahimtang. Ang lifecycle mao ang queued, dayon generating, dayon rendering, dayon ready (nahuman) o failed.

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

Kung kini ready, ang record magdala sa video URL ug sa ma-edit nga scene graph:

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

Mahigalaon ug klasiko nga mga ngalan sa field. Ang input ug length mao ang mahigalaon nga mga field sa hangyo. Ang mas daan nga prompt (string) ug lengthSeconds (usa ka numero, positibo nga multiplo sa 30) gidawat gihapon isip mga alias, mao nga ang naglungtad nga mga integration nagpadayon sa pagtrabaho. Kung parehong gipadala, ang mahigalaon nga field modaog.

Asa moadto sunod

  • API reference . Matag endpoint, uban sa mga porma sa hangyo ug tubag.
  • Mga tingog . Ang default nga tigsaysay, ang katalogo sa unom ka tingog, ug mga mapatokar nga preview.
  • Mga pinulongan . Ang 34 ka gisuportahan nga mga pinulongan sa pagsaysay.
  • CLI ug SDK . Ang sketchie command line ug ang @sketchie/sdk TypeScript client.
  • MCP setup . Gamita ang Sketchie isip mga tool sa Claude Desktop, Claude Code, ug sa Claude app.