CLI ו-SDK
הלקוח TypeScript @sketchie/sdk ושורת הפקודה sketchie הם עטיפות דקות ומוקלדות מעל אותו HTTP API. שניהם קוראים את המפתח שלכם מ-SKETCHIE_API_KEY והולכים כברירת מחדל אל https://sketchie.ai/api.
ה-SDK וה-CLI נשלחים כחלק מערכת הכלים של Sketchie. אם הרישום שלכם עדיין לא פותר את החבילה, תוכלו להריץ אותם ממאגר Sketchie עם bun. ה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> | כתובת URL בסיסית של API כולל הקידומת /api. Env: SKETCHIE_API_URL. |
--api-key <key> | מפתח ה-API שלכם. Env: SKETCHIE_API_KEY. לעולם לא מודפס בפלט. |