CLI ir SDK
@sketchie/sdk TypeScript klientas ir sketchie komandinė eilutė yra ploni, tipizuoti apvalkalai virš to paties HTTP API. Abu nuskaito jūsų raktą iš SKETCHIE_API_KEY ir numatytai naudoja https://sketchie.ai/api.
SDK ir CLI pristatomi kaip Sketchie įrankių rinkinio dalis. Jei jūsų registras dar neišsprendžia paketo, galite juos paleisti iš Sketchie saugyklos naudodami bun. Neapdorotas HTTP API šiandien veikia iš bet kurios kalbos.
TypeScript SDK
Sukurkite klientą, sugeneruokite paaiškinimą su patogiais laukais ir palaukite atvaizdavimo.
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 Redagavimo ir pakartotinio atvaizdavimo ciklas
Redaguojamumo pleištas: baigtas paaiškinimas grąžina savo sceneGraph. Patvirtinkite jį su editExplainerGraph, kad pridėtumėte versiją nenaudodami dar vienos nemokamos vaizdo įrašo kūrimo vietos, arba siųskite instrukciją paprasta kalba. Pirmas kiekvieno vaizdo įrašo pakartotinis atvaizdavimas yra nemokamas. Vėlesni pakartotiniai atvaizdavimai naudoja mokamo plano minutes.
// 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); Balsų išvardijimas
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Kiti metodai: getExplainer, listExplainers, revertExplainer, duplicateExplainer, ir deleteExplainer.
Komandinė eilutė
# 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 Vėliavėlės ir aplinka
| Vėliavėlė | Reikšmė |
|---|---|
--length <M:SS|sec> | Tikslinis ilgis, pvz. 0:30, 1:00, arba sekundės. Teigiamas 30 kartotinis. Praleiskite automatiniam. |
--aspect <ratio> | 16:9 (numatytasis), 9:16, arba 1:1. |
--voice <ref> | Balso nuoroda (žr. sketchie voices). Neprivaloma; numatytasis Nora. |
--limit <n> | Maksimalios eilutės list, 1 iki 100 (numatytoji 50). |
--wait | Tikrina, kol atvaizdavimas baigsis arba nepavyks. |
--json | Kompiuteriui skaitoma išvestis stdout. |
--api-url <url> | API bazinis URL, įskaitant /api priešdėlį. Env: SKETCHIE_API_URL. |
--api-key <key> | Jūsų API raktas. Env: SKETCHIE_API_KEY. Niekada neatspausdinamas išvestyje. |