Quickstart

AUTH="Authorization: Bearer $LAVENDLY_API_KEY"

# 1. Describe the video as shots (free). Returns the workflow id.
WF=$(curl -s -X POST $LAVENDLY_API/v1/workflows -H "$AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Bookshop fox",
    "shots": [
      { "prompt": "a sleepy fox in a bookshop discovering an old map",
        "duration": 6 }
    ]
  }' | jq -r .id)

# 2. Price it (free).
PRICE=$(curl -s $LAVENDLY_API/v1/workflows/$WF/cost-estimate -H "$AUTH" | jq .remaining)
echo "costs $PRICE credits"

# 3. Render, capped at that price, and poll until done.
JOB=$(curl -s -X POST $LAVENDLY_API/v1/workflows/$WF/renders -H "$AUTH" \
  -H "Content-Type: application/json" -H "Idempotency-Key: fox-render-1" \
  -d "{\"max_credits\": $PRICE}" | jq -r .job_id)
while :; do
  STATUS=$(curl -s $LAVENDLY_API/v1/workflows/$WF/renders/$JOB -H "$AUTH" | jq -r .status)
  echo "$STATUS"
  [[ $STATUS == "done" || $STATUS == "failed" ]] && break
  sleep 4
done
curl -s $LAVENDLY_API/v1/workflows/$WF/renders/$JOB -H "$AUTH" | jq -r .result.video_url

import { Lavendly } from '@lavendly/sdk';
const vs = new Lavendly({ apiKey: process.env.LAVENDLY_API_KEY });

const wf = await vs.workflows.create({
  name: "Bookshop fox",
  shots: [{ prompt: "a sleepy fox in a bookshop", duration: 6 }],
});

const price = await vs.workflows.estimate(wf.id);
console.log(`costs ${price.remaining} credits`);
// creates the render, then polls until done
const video = await vs.renders.run(wf.id, { max_credits: price.remaining, idempotencyKey: "fox-render-1" });
console.log(video.url);

import os
from lavendly import Lavendly
vs = Lavendly(api_key=os.environ["LAVENDLY_API_KEY"])

wf = vs.workflows.create(
    name="Bookshop fox",
    shots=[{"prompt": "a sleepy fox in a bookshop", "duration": 6}],
)

price = vs.workflows.estimate(wf["id"])
print(f"costs {price['remaining']} credits")
video = vs.renders.run(wf["id"], max_credits=price["remaining"], idempotency_key="fox-render-1")
print(video.url)