Áttekintés és gyors kezdés

A Sketchie egy promptot vagy dokumentumot táblás magyarázó videóvá alakít, és visszaadja neked mind a renderelt videót, mind annak szerkeszthető scene graph-ját. Ez a hivatkozás a HTTP API-hoz, a CLI-hez, a TypeScript SDK-hoz és az MCP szerverhez.

Az API-hozzáférés minden fizetős csomagban benne van. Hozz létre egy API-kulcsot az alkalmazás Beállításaiból, amint van csomagod. Az API-generálások a csomagod perceiből fogyasztanak, ugyanolyan díjszabással, mint az alkalmazás. Nincs külön API-ár.

Hitelesítés

Minden kérést az API-kulcsoddal hitelesítünk Bearer tokenként. Hozz létre egy kulcsot az alkalmazásban a Beállításokban, majd küldd az Authorization fejlécben:

Kérés fejléce 
Authorization: Bearer sk_...

A kulcs egyszer, létrehozáskor jelenik meg. Tartsd titokban. Minden végpont alap URL-je a https://sketchie.ai/api.

Gyors kezdés

1. Hozz létre egy magyarázót

Küldd el a témádat input néven és egy opcionális célhosszt length néven (egy barátságos "M:SS" karakterlánc, például "0:30" vagy "1:00", 30 másodperces lépésekben). Hagyd el a length mezőt az automatikus hosszhoz.

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 hívás azonnal 202 Accepted választ ad egy sorba állított rekorddal. A renderelés a háttérben fut, és néhány percet vesz igénybe.

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. Kérdezd le az eredményt

Kérd le a magyarázót az id alapján, amíg a status el nem ér egy végállapotot. Az életciklus: queued, majd generating, majd rendering, majd ready (kész) vagy failed.

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

Amikor ready, a rekord hordozza a videó URL-jét és a szerkeszthető scene graph-ot:

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

Barátságos és klasszikus mezőnevek. Az input és a length a barátságos kérésmezők. A régebbi prompt (karakterlánc) és lengthSeconds (szám, a 30 pozitív többszöröse) továbbra is elfogadott aliasként, így a meglévő integrációk működnek. Ha mindkettőt elküldöd, a barátságos mező nyer.

Hová menj tovább

  • API-hivatkozás . Minden végpont, a kérés és válasz formáival.
  • Hangok . Az alapértelmezett narrátor, a hat hangból álló katalógus és a lejátszható előnézetek.
  • Nyelvek . A 34 támogatott narrációs nyelv.
  • CLI és SDK . A sketchie parancssor és a @sketchie/sdk TypeScript kliens.
  • MCP beállítás . Használd a Sketchie-t eszközként a Claude Desktopban, a Claude Code-ban és a Claude alkalmazásban.