CLI او SDK
د @sketchie/sdk TypeScript پیرودونکی او د sketchie کمانډ کرښه د ورته HTTP API پر بنسټ نری، ټایپ شوي wrapper دي. دواړه ستاسو کلی د SKETCHIE_API_KEY څخه لولي او په تلواله ډول https://sketchie.ai/api ته ځي.
SDK او CLI د Sketchie وسیلو ټولګه یوه برخه په توګه لیږل کیږي. که ستاسو راجستري تر اوسه بسته حل نه کړي، تاسو کولی شئ دا د bun سره د Sketchie ذخیرې څخه اجرا کړئ. خام HTTP API نن ورځ د هرې ژبې څخه کار کوي.
TypeScript SDK
یو پیرودونکی جوړ کړئ، د دوستانه ساحو سره تشریح رامنځته کړئ، او د رینډر لپاره انتظار وباسئ.
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 د سمون او بیا-رینډر حلقه
د سمون وړتیا ویج: بشپړ شوی تشریح خپل sceneGraph بیرته راګرځوي. د بلې وړیا ویډیو رامنځته کولو ځای پرته د نسخې اضافه کولو لپاره یې د editExplainerGraph سره commit کړئ، یا په ساده ژبه لارښوونه ولیږئ. د هرې ویډیو لومړی بیا-رینډر وړیا دی. وروستي بیا-رینډرونه د تادیه شوي پلان دقیقې کاروي.
// 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); د غږونو لیست کول
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] نور میتودونه: getExplainer, listExplainers, revertExplainer, duplicateExplainer, او deleteExplainer.
کمانډ کرښه
# 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 بیرغونه او چاپیریال
| بیرغ | معنی |
|---|---|
--length <M:SS|sec> | موخه اوږدوالی، لکه 0:30, 1:00, یا ثانیې. د 30 مثبت ضرب. د اتومات لپاره یې پریږدئ. |
--aspect <ratio> | 16:9 (تلواله), 9:16, یا 1:1. |
--voice <ref> | د غږ ref (وګورئ sketchie voices). اختیاري؛ تلواله Nora. |
--limit <n> | د list لپاره اعظمي کرښې، 1 څخه 100 (تلواله 50). |
--wait | تر هغه پلټنه کوي چې رینډر بشپړ یا ناکام شي. |
--json | د stdout پر ماشین لوستل کیدونکی محصول. |
--api-url <url> | د /api مخکینۍ سره API بنسټیز URL. Env: SKETCHIE_API_URL. |
--api-key <key> | ستاسو د API کلی. Env: SKETCHIE_API_KEY. هیڅکله په محصول کې چاپ نه کیږي. |