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

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.