CLI en SDK
Die @sketchie/sdk TypeScript-kliënt en die sketchie-opdraglyn is dun, getipte omhulsels oor dieselfde HTTP-API. Albei lees jou sleutel uit SKETCHIE_API_KEY en gaan verstek na https://sketchie.ai/api.
Die SDK en CLI word gelewer as deel van die Sketchie-gereedskapstel. As jou register nog nie die pakket oplos nie, kan jy dit vanuit die Sketchie-bewaarplek met bun uitvoer. Die rou HTTP-API werk vandag vanuit enige taal.
TypeScript SDK
Skep ’n kliënt, genereer ’n verduideliking met die vriendelike velde, en wag vir die rendering.
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 wysig- en herrendering-lus
Die redigeerbaarheidswig: ’n voltooide verduideliking gee sy eie sceneGraph terug. Commit dit met editExplainerGraph om ’n weergawe by te voeg sonder om nog ’n gratis video-skeppingsgleuf te verbruik, of stuur ’n instruksie in gewone taal. Die eerste herrendering van elke video is gratis. Latere herrenderings gebruik betaalde-plan-minute.
// 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); Stemme lys
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Ander metodes: getExplainer, listExplainers, revertExplainer, duplicateExplainer, en deleteExplainer.
Opdraglyn
# 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 Vlae en omgewing
| Vlag | Betekenis |
|---|---|
--length <M:SS|sec> | Teikenlengte, bv. 0:30, 1:00, of sekondes. ’n Positiewe veelvoud van 30. Laat weg vir outomaties. |
--aspect <ratio> | 16:9 (verstek), 9:16, of 1:1. |
--voice <ref> | ’n Stemverwysing (sien sketchie voices). Opsioneel; verstek Nora. |
--limit <n> | Maks. rye vir list, 1 tot 100 (verstek 50). |
--wait | Poll totdat die rendering klaar is of misluk. |
--json | Masjienleesbare uitvoer op stdout. |
--api-url <url> | API-basis-URL insluitend die /api-voorvoegsel. Env: SKETCHIE_API_URL. |
--api-key <key> | Jou API-sleutel. Env: SKETCHIE_API_KEY. Word nooit in uitvoer gedruk nie. |