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

एक क्लाइन्ट बनाउनुहोस्, मैत्रीपूर्ण फिल्डहरूसँग व्याख्या उत्पन्न गर्नुहोस्, र रेन्डरको प्रतीक्षा गर्नुहोस्।

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। आउटपुटमा कहिल्यै प्रिन्ट हुँदैन।