Panoramica e avvio rapido

Sketchie trasforma un prompt o un documento in un video esplicativo a lavagna e ti restituisce sia il video renderizzato sia il suo scene graph modificabile. Questo è il riferimento per l’API HTTP, la CLI, l’SDK TypeScript e il server MCP.

L’accesso all’API è incluso in ogni piano a pagamento. Crea una chiave API dalle Impostazioni nell’app quando hai un piano. Le generazioni via API attingono ai minuti del tuo piano alla stessa tariffa dell’app. Non c’è un prezzo API separato.

Autenticazione

Ogni richiesta è autenticata con la tua chiave API come token Bearer. Crea una chiave nell’app in Impostazioni, poi inviala nell’header Authorization:

Header della richiesta 
Authorization: Bearer sk_...

La chiave viene mostrata una volta, alla creazione. Tienila segreta. L’URL base di ogni endpoint è https://sketchie.ai/api.

Avvio rapido

1. Crea un esplicativo

Invia il tuo argomento come input e una durata target opzionale come length (una stringa comoda "M:SS" come "0:30" o "1:00", a passi di 30 secondi). Ometti length per la durata automatica.

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 chiamata restituisce 202 Accepted subito con un record in coda. Il rendering gira in background e richiede qualche minuto.

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. Interroga il risultato

Recupera l’esplicativo per id finché il suo status raggiunge uno stato terminale. Il ciclo di vita è queued, poi generating, poi rendering, poi ready (fatto) o failed.

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

Quando è ready, il record porta l’URL del video e lo scene graph modificabile:

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

Nomi di campo comodi e classici. input e length sono i campi di richiesta comodi. I vecchi prompt (stringa) e lengthSeconds (un numero, un multiplo positivo di 30) sono ancora accettati come alias, così le integrazioni esistenti continuano a funzionare. Quando si inviano entrambi, vince il campo comodo.

Dove andare dopo

  • Riferimento API . Ogni endpoint, con le forme di richiesta e risposta.
  • Voci . Il narratore predefinito, il catalogo di sei voci e le anteprime riproducibili.
  • Lingue . Le 34 lingue di narrazione supportate.
  • CLI e SDK . La riga di comando sketchie e il client TypeScript @sketchie/sdk.
  • Configurazione MCP . Usa Sketchie come strumenti in Claude Desktop, Claude Code e l’app Claude.