CLI og SDK
@sketchie/sdk TypeScript biðlarinn og sketchie skipanalínan eru þunn, tegundagreind vefjur yfir sama HTTP API. Bæði lesa lykilinn þinn úr SKETCHIE_API_KEY og fara sjálfgefið á https://sketchie.ai/api.
SDK og CLI eru afhent sem hluti af Sketchie verkfærakistunni. Ef skráin þín leysir ekki pakkann enn, geturðu keyrt þau frá Sketchie geymslunni með bun. Hráa HTTP API virkar í dag frá hvaða tungumáli sem er.
TypeScript SDK
Búðu til biðlara, búðu til útskýringu með vinalegu reitunum, og bíddu eftir myndgerð.
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 Breytinga- og endurmyndgerðarlykkjan
Breytanleikafleygurinn: fullbúin útskýring skilar sinni eigin sceneGraph. Staðfestu hana með editExplainerGraph til að bæta við útgáfu án þess að nota annað ókeypis myndbandssköpunarpláss, eða sendu leiðbeiningu á einföldu máli. Fyrsta endurmyndgerð hvers myndbands er ókeypis. Síðari endurmyndgerðir nota mínútur greidda áætlunarinnar.
// 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); Að skrá raddir
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Aðrar aðferðir: getExplainer, listExplainers, revertExplainer, duplicateExplainer, og deleteExplainer.
Skipanalína
# 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 Flögg og umhverfi
| Flagg | Merking |
|---|---|
--length <M:SS|sec> | Markmiðslengd, t.d. 0:30, 1:00, eða sekúndur. Jákvætt margfeldi af 30. Sleppa fyrir sjálfvirkt. |
--aspect <ratio> | 16:9 (sjálfgefið), 9:16, eða 1:1. |
--voice <ref> | Raddartilvísun (sjá sketchie voices). Valfrjálst; sjálfgefið Nora. |
--limit <n> | Hámarksraðir fyrir list, 1 til 100 (sjálfgefið 50). |
--wait | Kannar þar til myndgerð lýkur eða mistekst. |
--json | Vélarlesanleg úttak á stdout. |
--api-url <url> | Grunn-URL API þar með talið /api forskeytið. Env: SKETCHIE_API_URL. |
--api-key <key> | API lykillinn þinn. Env: SKETCHIE_API_KEY. Aldrei prentaður í úttaki. |