Visão geral e início rápido

A Sketchie transforma um prompt ou um documento num vídeo explicativo de quadro branco e devolve-lhe tanto o vídeo renderizado como o seu scene graph editável. Esta é a referência para a API HTTP, a CLI, o SDK TypeScript e o servidor MCP.

O acesso à API está incluído em todos os planos pagos. Crie uma chave de API nas Definições da aplicação quando tiver um plano. As gerações por API consomem os minutos do seu plano à mesma taxa que a aplicação. Não há um preço de API à parte.

Autenticação

Cada pedido é autenticado com a sua chave de API como token Bearer. Crie uma chave na aplicação em Definições e depois envie-a no cabeçalho Authorization:

Cabeçalho do pedido 
Authorization: Bearer sk_...

A chave é mostrada uma vez, na criação. Mantenha-a em segredo. O URL base de cada endpoint é https://sketchie.ai/api.

Início rápido

1. Crie um explicativo

Envie o seu tema como input e uma duração-alvo opcional como length (uma string amigável "M:SS" como "0:30" ou "1:00", em passos de 30 segundos). Omita length para duração 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 imediato com um registo em fila. A renderização corre em segundo plano e demora alguns 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. Faça polling do resultado

Obtenha o explicativo pelo id até o seu status chegar a um estado terminal. O ciclo de vida é queued, depois generating, depois rendering, depois ready (concluído) ou failed.

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

Quando estiver ready, o registo carrega o URL do vídeo e o scene graph editável:

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

Nomes de campo amigáveis e clássicos. input e length são os campos de pedido amigáveis. Os antigos prompt (string) e lengthSeconds (um número, múltiplo positivo de 30) continuam a ser aceites como alias, portanto as integrações existentes continuam a funcionar. Quando ambos são enviados, o campo amigável vence.

Para onde ir a seguir

  • Referência da API . Cada endpoint, com os formatos de pedido e resposta.
  • Vozes . O narrador predefinido, o catálogo de seis vozes e as pré-visualizações reproduzíveis.
  • Idiomas . Os 34 idiomas de narração suportados.
  • CLI e SDK . A linha de comandos sketchie e o cliente TypeScript @sketchie/sdk.
  • Configuração do MCP . Use a Sketchie como ferramentas no Claude Desktop, Claude Code e na aplicação Claude.