CLI ja SDK
@sketchie/sdk TypeScript-asiakas ja sketchie-komentorivi ovat ohuita, tyypitettyjä kääreitä saman HTTP-API:n päällä. Molemmat lukevat avaimesi SKETCHIE_API_KEY:sta ja käyttävät oletuksena osoitetta https://sketchie.ai/api.
SDK ja CLI toimitetaan osana Sketchie-työkalupakettia. Jos rekisterisi ei vielä ratkaise pakettia, voit ajaa ne Sketchie-repositoriosta bun:lla. Raaka HTTP-API toimii nykyään mistä tahansa kielestä.
TypeScript SDK
Luo asiakas, luo selitys ystävällisillä kentillä ja odota renderöintiä.
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 Muokkaus- ja uudelleenrenderöintisilmukka
Muokattavuuskiila: valmis selitys palauttaa oman sceneGraph-tietonsa. Committaa se editExplainerGraph:lla lisätäksesi version käyttämättä toista ilmaista videon luontipaikkaa, tai lähetä ohje selkokielellä. Kunkin videon ensimmäinen uudelleenrenderöinti on ilmainen. Myöhemmät uudelleenrenderöinnit käyttävät maksullisen suunnitelman minuutteja.
// 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); Äänien listaaminen
const voices = await client.listVoices();
// [{ id: 'sketchie:sulafat', name: 'Nora', isDefault: true, preview_url, ... }] Muut metodit: getExplainer, listExplainers, revertExplainer, duplicateExplainer, ja deleteExplainer.
Komentorivi
# 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 Liput ja ympäristö
| Lippu | Merkitys |
|---|---|
--length <M:SS|sec> | Tavoitepituus, esim. 0:30, 1:00, tai sekunteina. Positiivinen 30:n kerrannainen. Jätä pois automaattiselle. |
--aspect <ratio> | 16:9 (oletus), 9:16, tai 1:1. |
--voice <ref> | Ääniviite (katso sketchie voices). Valinnainen; oletus Nora. |
--limit <n> | Enimmäisrivit kohteelle list, 1–100 (oletus 50). |
--wait | Kyselee kunnes renderöinti valmistuu tai epäonnistuu. |
--json | Koneluettava tuloste stdoutissa. |
--api-url <url> | API:n perus-URL sisältäen /api-etuliitteen. Env: SKETCHIE_API_URL. |
--api-key <key> | API-avaimesi. Env: SKETCHIE_API_KEY. Ei koskaan tulosteta tulosteessa. |