Prezentare generală și pornire rapidă

Sketchie transformă un prompt sau un document într-un videoclip explicativ pe tablă și vă returnează atât videoclipul redat, cât și scene graph-ul său editabil. Aceasta este referința pentru API-ul HTTP, CLI, SDK-ul TypeScript și serverul MCP.

Accesul la API este inclus în fiecare plan plătit. Creați o cheie API din Setări în aplicație odată ce aveți un plan. Generările prin API consumă din minutele planului la aceeași rată ca aplicația. Nu există un preț API separat.

Autentificare

Fiecare cerere este autentificată cu cheia dvs. API ca token Bearer. Creați o cheie în aplicație în Setări, apoi trimiteți-o în antetul Authorization:

Antet cerere 
Authorization: Bearer sk_...

Cheia este afișată o dată, la creare. Păstrați-o secretă. URL-ul de bază pentru fiecare endpoint este https://sketchie.ai/api.

Pornire rapidă

1. Creați un explicativ

Trimiteți subiectul dvs. ca input și o lungime țintă opțională ca length (un șir "M:SS" prietenos precum "0:30" sau "1:00", în pași de 30 de secunde). Omiteți length pentru lungime automată.

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

Apelul returnează imediat 202 Accepted cu o înregistrare în coadă. Redarea rulează în fundal și durează câteva 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. Interogați rezultatul

Preluați explicativul după id până când status-ul său ajunge la o stare finală. Ciclul de viață este queued, apoi generating, apoi rendering, apoi ready (gata) sau failed.

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

Când este ready, înregistrarea poartă URL-ul videoclipului și scene graph-ul editabil:

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

Nume de câmpuri prietenoase și clasice. input și length sunt câmpurile de cerere prietenoase. Vechile prompt (șir) și lengthSeconds (un număr, multiplu pozitiv al lui 30) sunt încă acceptate ca alias-uri, astfel încât integrările existente continuă să funcționeze. Când sunt trimise ambele, câștigă câmpul prietenos.

Unde să mergeți în continuare

  • Referință API . Fiecare endpoint, cu formele de cerere și răspuns.
  • Voci . Naratorul implicit, catalogul de șase voci și previzualizările redabile.
  • Limbi . Cele 34 de limbi de naratiune acceptate.
  • CLI și SDK . Linia de comandă sketchie și clientul TypeScript @sketchie/sdk.
  • Configurare MCP . Folosiți Sketchie ca instrumente în Claude Desktop, Claude Code și aplicația Claude.