Visão geral e início rápido

A Sketchie transforma um prompt ou um documento em um vídeo explicativo de lousa e devolve tanto o vídeo renderizado quanto seu scene graph editável. Esta é a referência da API HTTP, da CLI, do SDK TypeScript e do servidor MCP.

O acesso à API está incluído em todo plano pago. Crie uma chave de API em Configurações no app quando estiver em um plano. As gerações por API consomem os minutos do seu plano à mesma taxa do app. Não há um preço de API separado.

Autenticação

Cada requisição é autenticada com sua chave de API como token Bearer. Crie uma chave no app em Configurações e envie-a no cabeçalho Authorization:

Cabeçalho da requisição 
Authorization: Bearer sk_...

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

Início rápido

1. Crie um explicativo

Envie 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 retorna 202 Accepted imediatamente com um registro na fila. A renderização roda em segundo plano e leva 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

Busque o explicativo pelo id até o status chegar a um estado terminal. O ciclo de vida é queued, depois generating, depois rendering, depois ready (pronto) ou failed.

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

Quando estiver ready, o registro carrega a 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 requisição amigáveis. Os antigos prompt (string) e lengthSeconds (um número, múltiplo positivo de 30) ainda são aceitos como alias, então integrações existentes continuam funcionando. Quando ambos são enviados, o campo amigável vence.

Para onde ir depois

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