Visió general i inici ràpid

Sketchie converteix un prompt o un document en un vídeo explicatiu de pissarra i et retorna tant el vídeo renderitzat com el seu scene graph editable. Aquesta és la referència per a l'API HTTP, la CLI, el SDK de TypeScript i el servidor MCP.

L'accés a l'API està inclòs en tots els plans de pagament. Crea una clau d'API des de Configuració a l'aplicació quan tinguis un pla. Les generacions per API consumeixen els minuts del teu pla a la mateixa tarifa que l'aplicació. No hi ha un preu d'API a part.

Autenticació

Cada petició s'autentica amb la teva clau d'API com a token Bearer. Crea una clau a l'aplicació a Configuració i després envia-la a la capçalera Authorization:

Capçalera de la petició 
Authorization: Bearer sk_...

La clau es mostra una vegada, en crear-la. Mantén-la en secret. L'URL base de cada endpoint és https://sketchie.ai/api.

Inici ràpid

1. Crea un explicatiu

Envia el teu tema com a input i una durada objectiu opcional com a length (una cadena amable "M:SS" com ara "0:30" o "1:00", en passos de 30 segons). Omet length per a durada automàtica.

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

La crida retorna 202 Accepted immediatament amb un registre a la cua. La renderització s'executa en segon pla i triga uns minuts.

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. Sondeja el resultat

Obtén l'explicatiu per id fins que el seu status arribi a un estat terminal. El cicle de vida és queued, després generating, després rendering, després ready (fet) o failed.

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

Quan estigui ready, el registre porta l'URL del vídeo i el scene graph editable:

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

Noms de camp amables i clàssics. input i length són els camps de petició amables. Els antics prompt (cadena) i lengthSeconds (un nombre, múltiple positiu de 30) encara s'accepten com a àlies, de manera que les integracions existents continuen funcionant. Quan s'envien tots dos, guanya el camp amable.

On anar després

  • Referència de l'API . Cada endpoint, amb les formes de petició i resposta.
  • Veus . El narrador per defecte, el catàleg de sis veus i les previsualitzacions reproduïbles.
  • Idiomes . Els 34 idiomes de narració admesos.
  • CLI i SDK . La línia d'ordres sketchie i el client de TypeScript @sketchie/sdk.
  • Configuració de MCP . Fes servir Sketchie com a eines a Claude Desktop, Claude Code i l'aplicació Claude.