CLI en SDK

De @sketchie/sdk TypeScript-client en de sketchie-commandoregel zijn dunne, getypeerde wrappers over dezelfde HTTP-API. Beide lezen je sleutel uit SKETCHIE_API_KEY en gaan standaard naar https://sketchie.ai/api.

De SDK en CLI worden geleverd als onderdeel van de Sketchie-toolkit. Als jouw registry het pakket nog niet oplost, kun je ze uitvoeren vanuit de Sketchie-repository met bun. De rauwe HTTP-API werkt vandaag vanuit elke taal.

TypeScript SDK

Maak een client, genereer een uitleg met de vriendelijke velden, en wacht op de render.

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

De bewerk- en her-renderlus

De bewerkbaarheidswig: een afgeronde uitleg geeft zijn sceneGraph terug. Commit deze met editExplainerGraph om een versie toe te voegen zonder een andere gratis videocreatie-slot te verbruiken, of stuur een instructie in gewone taal. De eerste her-render van elke video is gratis. Latere her-renders gebruiken betaalde-planminuten.

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

Stemmen weergeven

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

Andere methoden: getExplainer, listExplainers, revertExplainer, duplicateExplainer, en deleteExplainer.

Commandoregel

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

Vlaggen en omgeving

VlagBetekenis
--length <M:SS|sec> Doellengte, bijv. 0:30, 1:00, of seconden. Een positief veelvoud van 30. Laat weg voor automatisch.
--aspect <ratio> 16:9 (standaard), 9:16, of 1:1.
--voice <ref> Een stem-ref (zie sketchie voices). Optioneel; standaard Nora.
--limit <n> Max. rijen voor list, 1 tot 100 (standaard 50).
--wait Poll totdat de render klaar is of mislukt.
--json Machineleesbare uitvoer op stdout.
--api-url <url> API-basis-URL inclusief het /api-voorvoegsel. Env: SKETCHIE_API_URL.
--api-key <key> Jouw API-sleutel. Env: SKETCHIE_API_KEY. Nooit afgedrukt in de uitvoer.