CLI an SDK

De @sketchie/sdk TypeScript-Client an d’sketchie Befehlszeil sinn dënn, typiséiert Ëmhëllen iwwer déiselwecht HTTP-API. Béid liesen Äre Schlëssel aus SKETCHIE_API_KEY a benotzen als Standard https://sketchie.ai/api.

De SDK an d’CLI ginn als Deel vum Sketchie-Toolkit geliwwert. Wann Äre Register de Package nach net opléist, kënnt Dir se aus dem Sketchie-Repository mat bun lafen loossen. Déi rou HTTP-API funktionéiert haut vun all Sprooch.

TypeScript SDK

Erstellt e Client, erstellt eng Erklärung mat de frëndleche Felder, a waart 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

D’Änneren- an Neirenner-Loop

De Editéierbarkeetskeil: eng fäerdeg Erklärung gëtt hiren sceneGraph zréck. Bestätegt en mat editExplainerGraph fir eng Versioun bäizefügen ouni en anert gratis Video-Erstellungsplaz ze benotzen, oder schéckt eng Instruktioun a einfacher Sprooch. Deen éischte Neirenn vun all Video ass gratis. Spéider Neirenner benotzen bezuelten Plang-Minutten.

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

Stëmme lëschten

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

Aner Methoden: getExplainer, listExplainers, revertExplainer, duplicateExplainer, an deleteExplainer.

Befehlszeil

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

Fändelen an Ëmfeld

FändelBedeitung
--length <M:SS|sec> Zil-Längt, z.B. 0:30, 1:00, oder Sekonnen. E positiivt Villfacht vun 30. Loosst ewech fir Auto.
--aspect <ratio> 16:9 (Standard), 9:16, oder 1:1.
--voice <ref> E Stëmm-Ref (kuckt sketchie voices). Optional; Standard Nora.
--limit <n> Maximal Zeilen fir list, 1 bis 100 (Standard 50).
--wait Freet of bis de Render fäerdeg ass oder feelt.
--json Maschinnlesbar Ausgab op stdout.
--api-url <url> API-Basis-URL mat der /api-Virsëlz. Env: SKETCHIE_API_URL.
--api-key <key> Äre API-Schlëssel. Env: SKETCHIE_API_KEY. Ni an der Ausgab gedréckt.