CLI და SDK
@sketchie/sdk TypeScript კლიენტი და 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> | API საბაზისო URL, /api პრეფიქსის ჩათვლით. Env: SKETCHIE_API_URL. |
--api-key <key> | თქვენი API გასაღები. Env: SKETCHIE_API_KEY. არასდროს იბეჭდება გამომავალში. |