CLI и SDK

Клиент TypeScript @sketchie/sdk и командная строка sketchie — это тонкие типизированные обёртки над одним и тем же HTTP API. Оба читают ваш ключ из SKETCHIE_API_KEY и по умолчанию используют https://sketchie.ai/api.

SDK и CLI поставляются как часть набора инструментов Sketchie. Если ваш реестр ещё не разрешает пакет, вы можете запустить их из репозитория Sketchie с помощью bun. Необработанный HTTP API сегодня работает из любого языка.

TypeScript SDK

Создайте клиент, сгенерируйте объясняющее видео с дружелюбными полями и дождитесь рендера.

sketchie.ts
import { SketchieClient } from '@sketchie/sdk';

const client = new SketchieClient({
  apiKey: process.env.SKETCHIE_API_KEY, // Bearer sk_...
  // baseUrl defaults to https://sketchie.ai/api
});

// Friendly fields: input (the topic) and length ("M:SS", a multiple of 30).
const created = await client.createExplainer({
  input: 'Explain how DNS resolves a domain name',
  length: '0:30',
  aspect: '16:9',
});

// Poll until the render finishes (or fails).
const done = await client.waitForExplainer(created.id, {
  onUpdate: (e) => console.log(e.status),
});

console.log(done.videoUrl);   // the rendered MP4
console.log(done.sceneGraph); // the editable scene graph

Цикл редактирования и перерендера

Клин редактируемости: готовое объясняющее видео возвращает свой sceneGraph. Зафиксируйте его с помощью editExplainerGraph, чтобы добавить версию без расходования ещё одного слота бесплатного создания видео, или отправьте инструкцию на простом языке. Первый перерендер каждого видео бесплатный. Последующие используют минуты платного плана.

edit.ts
// After a video is ready you get back its editable sceneGraph.
// Edit it, then append a new version to the existing explainer.
const edited = editScenes(done.sceneGraph!); // your UI edits the graph
const rerender = await client.editExplainerGraph(done.id, edited);
await client.waitForVersion(done.id, rerender.id);

// Or apply a plain-language instruction (a targeted re-render):
const version = await client.editExplainer(done.id, 'make scene 2 shorter');
await client.waitForVersion(done.id, version.id);

Список голосов

voices.ts
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }]

Другие методы: getExplainer, listExplainers, revertExplainer, duplicateExplainer и deleteExplainer.

Командная строка

Terminal
# Discover voices
sketchie voices

# Generate (returns the queued record immediately)
sketchie generate "Explain how DNS resolves a domain name" --length 0:30 --aspect 16:9

# Generate and wait for the finished render
sketchie generate "Explain how DNS resolves" --length 1:00 --wait

# Status of an existing explainer
sketchie status <id>

# Conversational edit (a targeted re-render)
sketchie edit <id> "make the title scene shorter" --wait

# List your explainers
sketchie list --limit 20

Флаги и окружение

ФлагЗначение
--length <M:SS|sec> Целевая длина, напр. 0:30, 1:00 или секунды. Положительное кратное 30. Опустите для авто.
--aspect <ratio> 16:9 (по умолчанию), 9:16, или 1:1.
--voice <ref> Ссылка на голос (см. sketchie voices). Необязательно; по умолчанию Nora.
--limit <n> Максимум строк для list, от 1 до 100 (по умолчанию 50).
--wait Опрашивает, пока рендер не завершится или не завершится ошибкой.
--json Машиночитаемый вывод в stdout.
--api-url <url> Базовый URL API включая префикс /api. Env: SKETCHIE_API_URL.
--api-key <key> Ваш API-ключ. Env: SKETCHIE_API_KEY. Никогда не выводится.