Skip to main content
The @figranium/sdk package is the official TypeScript and JavaScript client for the Figranium API. It wraps every REST and Server-Sent Events endpoint the Figranium server exposes and adds typed action helpers, structured errors, and abortable streams.

​
Highlights

TypeScript first

Complete .d.ts declarations, typed task and action shapes, and generics on execution results.

Node and browser

Works in Node.js 18+ and modern browsers with the built-in fetch. No runtime dependencies.

ESM and CommonJS

Ships parallel ESM and CommonJS builds so import and require both work out of the box.

Abortable streams

Execution and selector Server-Sent Events surface as AsyncIterable with AbortSignal support.

​
Package facts

​
What you can do with the SDK

  • Save, update, version, and roll back tasks.
  • Run tasks with runtime variables, or call scrape, agent, and headful directly.
  • Stream live execution and selector events over Server-Sent Events.
  • Manage schedules, captures, cookies, output credentials, and Cabinets.
  • Select a per-task Cabinet for intercepted downloads and build typed Upload / Finalize Uploads actions.
  • Open and inspect headful browser sessions.
  • Administer settings (API keys, AI providers, proxies, theme) with a browser session.

​
Where to go next

Installation

Install the package and confirm your Node or browser environment can reach Figranium.

Quickstart

Build, save, and run a typed task in a few minutes.

Client configuration

Configure baseUrl, timeouts, custom fetch, and default headers.

Resources

Reference for every resource exposed on the Figranium client.

​
Compatibility

The SDK includes the Cabinet API surface and the accompanying AGENT_SPEC.md task fields. Task and execution result types intentionally accept extra fields so newer server releases can add response data without breaking SDK consumers.