Обзор и быстрый старт

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.