Visión xeral e inicio rápido

Sketchie converte un prompt ou un documento nun vídeo explicativo de encerado e devólveche tanto o vídeo renderizado como o seu scene graph editable. Esta é a referencia para a API HTTP, a CLI, o SDK de TypeScript e o servidor MCP.

O acceso á API está incluído en todos os plans de pagamento. Crea unha clave de API desde Configuración na aplicación cando teñas un plan. As xeracións por API consumen os minutos do teu plan á mesma tarifa que a aplicación. Non hai un prezo de API á parte.

Autenticación

Cada solicitude autentícase coa túa clave de API como token Bearer. Crea unha clave na aplicación en Configuración e despois envíaa na cabeceira Authorization:

Cabeceira da solicitude 
Authorization: Bearer sk_...

A clave móstrase unha vez, ao crearla. Manténa en segredo. O URL base de cada endpoint é https://sketchie.ai/api.

Inicio rápido

1. Crea un explicativo

Envía o teu tema como input e unha duración obxectivo opcional como length (unha cadea amable "M:SS" como "0:30" ou "1:00", en pasos de 30 segundos). Omite length para duración 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"
  }'

A chamada devolve 202 Accepted de inmediato cun rexistro na cola. A renderización execútase en segundo plano e tarda uns minutos.

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. Sondea o resultado

Obtén o explicativo por id ata que o seu status chegue a un estado terminal. O ciclo de vida é queued, despois generating, despois rendering, despois ready (feito) ou failed.

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

Cando estea ready, o rexistro leva o URL do vídeo e o scene graph editable:

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

Nomes de campo amables e clásicos. input e length son os campos de solicitude amables. Os antigos prompt (cadea) e lengthSeconds (un número, múltiplo positivo de 30) aínda se aceptan como alias, así que as integracións existentes seguen funcionando. Cando se envían ambos, gaña o campo amable.

A onde ir despois

  • Referencia da API . Cada endpoint, coas formas de solicitude e resposta.
  • Voces . O narrador predeterminado, o catálogo de seis voces e as previsualizacións reproducibles.
  • Idiomas . Os 34 idiomas de narración admitidos.
  • CLI e SDK . A liña de comandos sketchie e o cliente de TypeScript @sketchie/sdk.
  • Configuración de MCP . Usa Sketchie como ferramentas en Claude Desktop, Claude Code e a aplicación Claude.