Огляд і швидкий старт

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.