CLI und SDK
Der @sketchie/sdk-TypeScript-Client und die sketchie-Kommandozeile sind dünne, typisierte Wrapper über derselben HTTP-API. Beide lesen deinen Schlüssel aus SKETCHIE_API_KEY und nutzen standardmäßig https://sketchie.ai/api.
Das SDK und die CLI werden als Teil des Sketchie-Toolkits ausgeliefert. Wenn deine Registry das Paket noch nicht auflöst, kannst du sie aus dem Sketchie-Repository mit bun ausführen. Die rohe HTTP-API funktioniert heute aus jeder Sprache.
TypeScript-SDK
Erstelle einen Client, generiere ein Erklärvideo mit den freundlichen Feldern und warte auf den Render.
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 Die Bearbeiten- und Neu-Rendern-Schleife
Der Editierbarkeits-Keil: ein fertiges Erklärvideo gibt seinen sceneGraph zurück. Bestätige ihn mit editExplainerGraph, um eine Version anzuhängen, ohne einen weiteren Gratis-Video-Erstellungsplatz zu verbrauchen, oder sende eine Anweisung in einfacher Sprache. Das erste Neu-Rendern jedes Videos ist gratis. Spätere nutzen Minuten des bezahlten Plans.
// 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); Stimmen auflisten
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Weitere Methoden: getExplainer, listExplainers, revertExplainer, duplicateExplainer und deleteExplainer.
Kommandozeile
# 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 Flags und Umgebung
| Flag | Bedeutung |
|---|---|
--length <M:SS|sec> | Ziel-Länge, z. B. 0:30, 1:00 oder Sekunden. Ein positives Vielfaches von 30. Lass weg für Auto. |
--aspect <ratio> | 16:9 (Standard), 9:16 oder 1:1. |
--voice <ref> | Eine Stimm-Ref (siehe sketchie voices). Optional; Standard Nora. |
--limit <n> | Maximale Zeilen für list, 1 bis 100 (Standard 50). |
--wait | Fragt ab, bis der Render fertig ist oder scheitert. |
--json | Maschinenlesbare Ausgabe auf stdout. |
--api-url <url> | API-Basis-URL inklusive des /api-Präfix. Env: SKETCHIE_API_URL. |
--api-key <key> | Dein API-Schlüssel. Env: SKETCHIE_API_KEY. Wird nie in der Ausgabe gedruckt. |