CLI और SDK
@sketchie/sdk TypeScript क्लाइंट और sketchie कमांड लाइन एक ही HTTP API के ऊपर पतले, टाइप किए गए रैपर हैं। दोनों 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 के साथ कमिट करें, या सादी भाषा में निर्देश भेजें। प्रत्येक वीडियो का पहला री-रेंडर मुफ़्त है। बाद के री-रेंडर सशुल्क योजना मिनट का उपयोग करते हैं।
// 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> | एक आवाज़ रेफ़ (देखें 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। आउटपुट में कभी प्रिंट नहीं होती। |