Install the Figranium JavaScript SDK

The Figranium JavaScript SDK installs from npm as @figranium/sdk. It ships parallel ESM and CommonJS builds with bundled TypeScript declarations, so most projects need no additional configuration.

Requirements

Node.js 18 or newer (for the built-in global fetch), or a modern browser.
A running Figranium server that the client can reach at its baseUrl. Local installs default to http://localhost:11345.

Install

npm install @figranium/sdk

pnpm add @figranium/sdk

yarn add @figranium/sdk

bun add @figranium/sdk

The package has no runtime dependencies, so it adds nothing to your dependency tree beyond itself.

Use Node.js 18 or newer so the SDK can rely on the built-in global fetch. Older Node versions require a polyfill.

Import styles

The SDK works with both import and require.

import { Figranium } from "@figranium/sdk";

const figranium = new Figranium({ apiKey: process.env.FIGRANIUM_API_KEY! });

const { Figranium } = require("@figranium/sdk");

const figranium = new Figranium({ apiKey: process.env.FIGRANIUM_API_KEY });

Verify the install

Call health.check() to confirm the SDK can reach your Figranium server.

verify.ts

import { Figranium } from "@figranium/sdk";

const figranium = new Figranium({
  baseUrl: "http://localhost:11345",
  apiKey: process.env.FIGRANIUM_API_KEY!,
});

const status = await figranium.health.check();
console.log(status);

A healthy Figranium instance returns a JSON object with status: "ok".

Browsers and bundlers

The SDK is sideEffects: false, so bundlers like Vite, webpack, esbuild, and Rollup tree-shake unused resources. See Authentication for how to pass an API key.

Next steps

Quickstart

Save and run your first task with the SDK.

Client configuration

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

Introduction

JavaScript SDK

Python SDK

Swift SDK

Kotlin SDK

Install the Figranium JavaScript SDK

Requirements

Install

Import styles

Verify the install

Browsers and bundlers

Next steps

Quickstart

Client configuration

​Requirements

​Install

​Import styles

​Verify the install

​Browsers and bundlers

​Next steps

Quickstart

Client configuration

Requirements

Install

Import styles

Verify the install

Browsers and bundlers

Next steps