Node SDK

npm i @lavendly/sdk

import { Lavendly } from '@lavendly/sdk';

const vs = new Lavendly({
  apiKey: process.env.LAVENDLY_API_KEY,
  // optional, defaults to https://api.lavendly.ai
  baseURL: process.env.LAVENDLY_API,
});

const wf = await vs.workflows.create({
  name: "Fox in a bookshop",
  shots: [{ prompt: "a sleepy fox in a bookshop discovering an old map",
            duration: 5 }],
});

// .run() creates a render and polls until done. Returns the result.
const { video_url } = await vs.renders.run(wf.id);
console.log(video_url);

const wf = await vs.workflows.create({
  name: "Barista at dawn",
  shots: [{ prompt: "a barista pulling an espresso shot at dawn",
            duration: 6 }],
});

await vs.audio.attachTrack(wf.id, "shot_1", {
  kind: "voiceover",
  script: "Forty seconds. The whole café holds its breath.",
  subtitleStyle: "tiktok",
  idempotencyKey: `vo-${wf.id}`,
});

await vs.audio.attachTrack(wf.id, "shot_1", {
  kind: "music",
  mood: "warm low jazz piano",
  ducking: true,
  volume: 0.4,
  idempotencyKey: `music-${wf.id}`,
});

await vs.audio.setClipNativeAudio(wf.id, "shot_1", {
  mode: "mix",
  volume: 0.6,
});

const { video_url } = await vs.renders.run(wf.id, {
  idempotencyKey: `render-${wf.id}`,
});

const character = "A weathered explorer, mid-40s, dusty leather jacket, sunburnt skin.";
const palette   = "Amber and deep teal, golden-hour cinematic lighting.";

const wf = await vs.workflows.create({
  name: "Cave sequence",
  shots: [
    { prompt: `${character}\n${palette}\nEnters a cave mouth, torch in hand.`,
      duration: 3 },
    { prompt: `${character}\n${palette}\nFinds a glowing crystal embedded in rock.`,
      duration: 3 },
    { prompt: `${character}\n${palette}\nSteps back in awe, eyes wide.`,
      duration: 3 },
  ],
});

// One voiceover bridging the whole sequence
await vs.audio.attachTrack(wf.id, "shot_1", {
  kind: "voiceover",
  script: "He had been searching for years. He did not expect to find it here.",
  subtitleStyle: "cinematic",
  idempotencyKey: `vo-${wf.id}`,
});

const { video_url } = await vs.renders.run(wf.id);

const job = await vs.renders.create(wf.id, {
  idempotencyKey: `render-${wf.id}`,
});

for (;;) {
  const status = await vs.renders.get(wf.id, job.job_id);
  console.log(`${status.status}, ${Math.round(status.progress * 100)}%`);
  if (status.status === "done")   return status.result.video_url;
  if (status.status === "failed") throw new Error(status.error);
  await new Promise((r) => setTimeout(r, 4000));
}

const { available, plan_pool } = await vs.ledger.get();
if (available < 20) throw new Error(`Budget too low: ${available} credits`);

const { fraction_used } = await vs.usage.monthly();
if (fraction_used > 0.85) {
  console.warn("Monthly budget over 85% used, pausing");
  return;
}

try {
  await vs.workflows.create({ name: "huge", shots: bigArray });
} catch (err) {
  console.error(err.code);    // 'workflow_too_large'
  console.error(err.message); // human-readable
  console.error(err.status);  // 413
}

const key = `render-${wf.id}-${dateBucket()}`;
await vs.renders.create(wf.id, { idempotencyKey: key });