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. Никога не се извежда в изхода.