Iwwerbléck a séier Start

Sketchie mécht aus engem Prompt oder engem Dokument e Whiteboard-Erklärungsvideo, a gëtt Iech souwuel de gerenderte Video wéi och säin editéierbare scene graph zréck. Dëst ass d'Referenz fir déi HTTP API, d'CLI, d'TypeScript SDK an de MCP-Server.

API-Zougang ass an all bezuelte Plang abegraff. Erstellt en API-Schlëssel aus de Astellungen an der App wann Dir e Plang hutt. API-Generatioune huelen aus de Minutte vun Ärem Plang zum selwechten Taux wéi d'App. Et gëtt kee separaten API-Präis.

Authentifikatioun

All Ufro gëtt mat Ärem API-Schlëssel als Bearer-Token authentifizéiert. Erstellt e Schlëssel an der App ënner Astellungen, a schéckt en dann am Authorization-Header:

Ufro-Header 
Authorization: Bearer sk_...

De Schlëssel gëtt eemol gewisen, beim Erstellen. Haalt en geheim. D'Basis-URL fir all Endpoint ass https://sketchie.ai/api.

Séier Start

1. Erstellt eng Erklärung

Schéckt Äert Thema als input an eng optional Ziel-Längt als length (eng frëndlech "M:SS"-String wéi "0:30" oder "1:00", an 30-Sekonne-Schrëtt). Loosst length ewech fir automatesch Längt.

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

Den Uruff gëtt direkt 202 Accepted mat engem Datesaz an der Schlaang zréck. D'Rendere leeft am Hannergrond an dauert e puer Minutten.

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. Pollt no dem Resultat

Rufft d'Erklärung iwwer id op bis säin status en Endzoustand erreecht. De Liewenszyklus ass queued, dann generating, dann rendering, dann ready (fäerdeg) oder failed.

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

Wann et ready ass, dréit den Datesaz d'Video-URL an den editéierbare scene graph:

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

Frëndlech a klassesch Feldnimm. input an length sinn déi frëndlech Ufro-Felder. Déi eeler prompt (String) an lengthSeconds (eng Zuel, e positive Villfacht vun 30) ginn nach ëmmer als Aliasen akzeptéiert, sou datt bestehend Integratioune weiderfonctionnéieren. Wa béid geschéckt ginn, gewënnt d'frëndlecht Feld.

Wou als nächst goen

  • API-Referenz . All Endpoint, mat Ufro- an Äntwertform.
  • Stëmmen . De Standard-Erzieler, de Katalog vu sechs Stëmmen an ofspillbar Virschauen.
  • Sproochen . Déi 34 ënnerstëtzte Erzielsproochen.
  • CLI a SDK . D'Kommandozeil sketchie an de @sketchie/sdk TypeScript-Client.
  • MCP-Astellung . Benotzt Sketchie als Tools an Claude Desktop, Claude Code an der Claude-App.