CLI اور SDK

@sketchie/sdk TypeScript کلائنٹ اور sketchie کمانڈ لائن ایک ہی HTTP API پر پتلے، ٹائپ شدہ ریپرز ہیں۔ دونوں SKETCHIE_API_KEY سے آپ کی کلید پڑھتے ہیں اور طے شدہ طور پر https://sketchie.ai/api پر جاتے ہیں۔

SDK اور CLI Sketchie ٹول کٹ کے حصے کے طور پر بھیجے جاتے ہیں۔ اگر آپ کی رجسٹری ابھی تک پیکج کو حل نہیں کرتی، تو آپ انہیں bun کے ساتھ Sketchie ریپوزٹری سے چلا سکتے ہیں۔ خام HTTP API آج کسی بھی زبان سے کام کرتا ہے۔

TypeScript SDK

ایک کلائنٹ بنائیں، دوستانہ فیلڈز کے ساتھ ایک وضاحت بنائیں، اور رینڈر کا انتظار کریں۔

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

ترمیم اور دوبارہ رینڈر لوپ

ترمیم پذیری کیل: ایک مکمل وضاحت اپنا sceneGraph واپس دیتی ہے۔ ایک اور مفت ویڈیو تخلیق سلاٹ استعمال کیے بغیر ایک ورژن شامل کرنے کے لیے editExplainerGraph کے ساتھ کمٹ کریں، یا سادہ زبان میں ہدایت بھیجیں۔ ہر ویڈیو کا پہلا دوبارہ رینڈر مفت ہے۔ بعد کے دوبارہ رینڈر ادا شدہ منصوبے کے منٹ استعمال کرتے ہیں۔

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

آوازیں فہرست کرنا

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

دیگر طریقے: getExplainer، listExplainers، revertExplainer، duplicateExplainer، اور deleteExplainer۔

کمانڈ لائن

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

فلیگز اور ماحول

فلیگمعنی
--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۔ آؤٹ پٹ میں کبھی پرنٹ نہیں ہوتی۔