Преглед и бърз старт

Sketchie превръща подкана или документ в обяснително видео на бяла дъска и ви връща както рендираното видео, така и неговия редактируем scene graph. Това е справочникът за HTTP API, CLI, TypeScript SDK и сървъра MCP.

Достъпът до API е включен във всеки платен план. Създайте API ключ от Настройки в приложението, щом имате план. Генерациите чрез API черпят от минутите на вашия план със същата ставка като приложението. Няма отделна цена за API.

Удостоверяване

Всяка заявка се удостоверява с вашия API ключ като Bearer токен. Създайте ключ в приложението в Настройки, след което го изпращайте в хедъра Authorization:

Хедър на заявката 
Authorization: Bearer sk_...

Ключът се показва веднъж, при създаването. Пазете го в тайна. Базовият URL за всяка крайна точка е https://sketchie.ai/api.

Бърз старт

1. Създайте обяснение

Изпратете темата си като input и незадължителна целева дължина като length (удобен низ "M:SS" като "0:30" или "1:00", на стъпки от 30 секунди). Пропуснете length за автоматична дължина.

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

Извикването връща 202 Accepted веднага със запис в опашката. Рендирането се изпълнява на заден план и отнема няколко минути.

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. Запитвайте за резултата

Извличайте обяснението по id, докато неговият status достигне крайно състояние. Жизненият цикъл е queued, после generating, после rendering, после ready (готово) или failed.

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

Когато е ready, записът носи URL на видеото и редактируемия scene graph:

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

Удобни и класически имена на полета. input и length са удобните полета на заявката. По-старите prompt (низ) и lengthSeconds (число, положително кратно на 30) все още се приемат като псевдоними, така че съществуващите интеграции продължават да работят. Когато се изпратят и двете, печели удобното поле.

Накъде оттук нататък

  • Справочник за API . Всяка крайна точка с формите на заявка и отговор.
  • Гласове . Разказвачът по подразбиране, каталогът от шест гласа и възпроизводимите визуализации.
  • Езици . 34-те поддържани езика за разказ.
  • CLI и SDK . Командният ред sketchie и клиентът @sketchie/sdk на TypeScript.
  • Настройка на MCP . Използвайте Sketchie като инструменти в Claude Desktop, Claude Code и приложението Claude.