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 সম্পাদনা এবং পুনঃরেন্ডার লুপ
সম্পাদনাযোগ্যতা wedge: একটি সমাপ্ত এক্সপ্লেইনার তার 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। আউটপুটে কখনও প্রিন্ট হয় না। |