Преглед и брзи почетак

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 и TypeScript клијент @sketchie/sdk.
  • Подешавање MCP-а . Користите Sketchie као алате у Claude Desktop, Claude Code и апликацији Claude.