TypeScript SDK

npm install @framelane/sdk

import Framelane from "@framelane/sdk";

const client = new Framelane({
  apiKey: process.env.FRAMELANE_API_KEY,
});

// Submit a render
const render = await client.renders.create({
  width: 1920,
  height: 1080,
  duration: 10.0,
  frameRate: 30,
  outputFormat: "mp4",
  elements: [
    {
      type: "video",
      id: "clip1",
      sourceUrl: process.env.SOURCE_URL!,
      time: 0,
      inPoint: 0,
      outPoint: 10,
    },
  ],
});

// Wait for completion (drives the server-side ?wait long-poll)
const completed = await client.renders.waitForCompletion(render.id);
console.log(completed.output?.url);

import { autoPaginate } from "@framelane/sdk";

for await (const render of autoPaginate((cursor) =>
  client.renders.list({ status: "completed", cursor }))) {
  console.log(render.id);
}

import { verifyWebhookSignature } from "@framelane/sdk";

app.post("/hooks/framelane", (req, res) => {
  const isValid = verifyWebhookSignature(
    req.body,                              // raw body string — do not re-serialize
    req.headers["x-render-signature"],
    req.headers["x-render-timestamp"],
    process.env.FRAMELANE_WEBHOOK_SECRET
  );
  if (!isValid) return res.status(400).send("Invalid signature");

  const event = JSON.parse(req.body);
  // handle event...
  res.sendStatus(200);
});

import type {
  RenderJob,
  RenderSubmission,
  TaskJob,
  Violation,
  WebhookEvent,
  JobStatus,
  TaskType,
} from "@framelane/sdk";