Oorsig en vinnige begin

Sketchie verander 'n prompt of dokument in 'n witbord-verduidelikingsvideo, en gee jou beide die gerenderde video en sy redigeerbare scene graph terug. Dit is die verwysing vir die HTTP API, die CLI, die TypeScript SDK en die MCP-bediener.

API-toegang is by elke betaalde plan ingesluit. Skep 'n API-sleutel vanaf Instellings in die app sodra jy 'n plan het. API-generasies trek van jou planminute teen dieselfde tarief as die app. Daar is geen aparte API-prys nie.

Verifikasie

Elke versoek word met jou API-sleutel as 'n Bearer-token geverifieer. Skep 'n sleutel in die app onder Instellings, en stuur dit dan in die Authorization-kopstuk:

Versoekkopstuk 
Authorization: Bearer sk_...

Die sleutel word een keer gewys, met skepping. Hou dit geheim. Die basis-URL vir elke endpoint is https://sketchie.ai/api.

Vinnige begin

1. Skep 'n verduideliking

Stuur jou onderwerp as input en 'n opsionele teikenlengte as length ('n vriendelike "M:SS"-string soos "0:30" of "1:00", in stappe van 30 sekondes). Laat length weg vir outomatiese lengte.

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

Die oproep gee onmiddellik 202 Accepted terug met 'n rekord in die tou. Die rendering loop op die agtergrond en neem 'n paar minute.

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. Poll vir die resultaat

Haal die verduideliking op via id totdat sy status 'n eindtoestand bereik. Die lewensiklus is queued, dan generating, dan rendering, dan ready (klaar) of failed.

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

Wanneer dit ready is, dra die rekord die video-URL en die redigeerbare scene graph:

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

Vriendelike en klassieke veldname. input en length is die vriendelike versoekvelde. Die ouer prompt (string) en lengthSeconds ('n getal, 'n positiewe veelvoud van 30) word steeds as aliasse aanvaar, sodat bestaande integrasies aanhou werk. Wanneer albei gestuur word, wen die vriendelike veld.

Waarheen volgende

  • API-verwysing . Elke endpoint, met versoek- en antwoordvorme.
  • Stemme . Die verstek-verteller, die katalogus van ses stemme, en speelbare voorskoue.
  • Tale . Die 34 ondersteunde vertellingstale.
  • CLI en SDK . Die sketchie-opdraglyn en die @sketchie/sdk TypeScript-kliënt.
  • MCP-opstelling . Gebruik Sketchie as gereedskap in Claude Desktop, Claude Code en die Claude-app.