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> | एक आवाज 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. आउटपुटमध्ये कधीही मुद्रित होत नाही. |