CLI dhe SDK
Klienti TypeScript @sketchie/sdk dhe linja e komandës sketchie janë mbështjellës të hollë, të tipizuar mbi të njëjtin API HTTP. Të dy lexojnë çelësin tuaj nga SKETCHIE_API_KEY dhe si parazgjedhje shkojnë te https://sketchie.ai/api.
SDK dhe CLI dërgohen si pjesë e kompletit të mjeteve Sketchie. Nëse regjistri juaj ende nuk e zgjidh paketën, mund t’i ekzekutoni nga depoja Sketchie me bun. API HTTP i papërpunuar funksionon sot nga çdo gjuhë.
SDK TypeScript
Krijoni një klient, gjeneroni një shpjegim me fushat miqësore, dhe prisni renderimin.
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 Cikli i editimit dhe rirenderimit
Kunja e editueshmërisë: një shpjegim i përfunduar kthen sceneGraph e vet. Konfirmojeni me editExplainerGraph për të shtuar një version pa konsumuar një vend tjetër falas krijimi videosh, ose dërgoni një udhëzim në gjuhë të thjeshtë. Rirenderimi i parë i çdo videoje është falas. Rirenderimet e mëvonshme përdorin minuta të planit me pagesë.
// 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); Listimi i zërave
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Metoda të tjera: getExplainer, listExplainers, revertExplainer, duplicateExplainer, dhe deleteExplainer.
Linja e komandës
# 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 Flamujt dhe mjedisi
| Flamuri | Kuptimi |
|---|---|
--length <M:SS|sec> | Gjatësia e synuar, p.sh. 0:30, 1:00, ose sekonda. Një shumëfish pozitiv i 30. Lëreni bosh për automatik. |
--aspect <ratio> | 16:9 (i parazgjedhur), 9:16, ose 1:1. |
--voice <ref> | Një referencë zëri (shihni sketchie voices). Opsional; i parazgjedhur Nora. |
--limit <n> | Rreshtat maksimale për list, 1 deri 100 (i parazgjedhur 50). |
--wait | Vëzhgon derisa renderimi të përfundojë ose të dështojë. |
--json | Rezultat i lexueshëm nga makina në stdout. |
--api-url <url> | URL bazë e API-së duke përfshirë prefiksin /api. Env: SKETCHIE_API_URL. |
--api-key <key> | Çelësi juaj API. Env: SKETCHIE_API_KEY. Nuk shtypet kurrë në rezultat. |