CLI és SDK

A @sketchie/sdk TypeScript kliens és a sketchie parancssor vékony, típusos wrapperek ugyanazon HTTP API felett. Mindkettő a SKETCHIE_API_KEY-ből olvassa a kulcsot, és alapértelmezetten a https://sketchie.ai/api-t használja.

Az SDK és a CLI a Sketchie eszközkészlet részeként érkezik. Ha a registry még nem oldja fel a csomagot, futtathatja őket a Sketchie tárolóból a bun segítségével. A nyers HTTP API ma bármely nyelvből működik.

TypeScript SDK

Hozzon létre klienst, generáljon magyarázatot a barátságos mezőkkel, és várja meg a renderelést.

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

A szerkesztési és újrarenderelési hurok

A szerkeszthetőségi ék: egy kész magyarázat visszaadja saját sceneGraph-ját. Commitolja a editExplainerGraph-vel, hogy verziót adjon hozzá anélkül, hogy elhasználna egy másik ingyenes videólétrehozási helyet, vagy küldjön egyszerű nyelvű utasítást. Minden videó első újrarenderelése ingyenes. A későbbi újrarenderelések fizetős csomag perceit használják.

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);

Hangok listázása

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

Egyéb metódusok: getExplainer, listExplainers, revertExplainer, duplicateExplainer, és deleteExplainer.

Parancssor

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

Kapcsolók és környezet

KapcsolóJelentés
--length <M:SS|sec> Cél hossz, pl. 0:30, 1:00, vagy másodperc. 30 pozitív többszöröse. Hagyja el az automatikushoz.
--aspect <ratio> 16:9 (alapértelmezett), 9:16, vagy 1:1.
--voice <ref> Egy hang referencia (lásd sketchie voices). Opcionális; alapértelmezett Nora.
--limit <n> Maximum sorok a list-hoz, 1-től 100-ig (alapértelmezett 50).
--wait Lekérdez, amíg a render befejeződik vagy meghiúsul.
--json Géppel olvasható kimenet a stdout-on.
--api-url <url> API alap URL az /api előtaggal együtt. Env: SKETCHIE_API_URL.
--api-key <key> Az Ön API kulcsa. Env: SKETCHIE_API_KEY. Soha nem íródik ki a kimenetben.