Configure the Figranium SDK Client

The Figranium class takes a single options object. Every option is optional; the SDK falls back to sensible defaults so a local install works with new Figranium({ apiKey }).

Constructor options

string

Absolute URL of your Figranium server. Must use http or https. Trailing slashes are trimmed. Defaults to http://localhost:11345.

string

API key sent as Authorization: Bearer <key> by default. Create keys from the Figranium web UI.

string

Header name for the API key. Either "authorization" (default) or "x-api-key".

number

Client-wide default timeout for non-stream requests, in milliseconds. Defaults to 30_000 (30 seconds). Streams have no default timeout.

function

Any fetch-compatible implementation. Useful for tracing, retries, cookie jars, test doubles, or proxying through instrumented HTTP clients.

HeadersInit

Default headers merged into every request. Per-call headers override these.

Option details

`baseUrl`

new Figranium({ baseUrl: "https://figranium.example" });

`apiKey` and `apiKeyHeader`

Pass apiKey to authenticate every request with an API key. By default the key is sent as Authorization: Bearer <key>. Set apiKeyHeader: "x-api-key" if your deployment expects that header.

new Figranium({ apiKey: "fig_...", apiKeyHeader: "x-api-key" });

See Authentication for how to create and manage API keys.

`timeoutMs`

Client-wide default timeout for non-stream requests, in milliseconds. Defaults to 30_000 (30 seconds). Streams have no default timeout; set a per-call timeoutMs if you want a terminal deadline.

new Figranium({ apiKey: "fig_...", timeoutMs: 60_000 });

Individual requests can override this per call with { timeoutMs }. See Request options.

`fetch`

Provide any fetch-compatible implementation. Useful for tracing, retries, cookie jars, test doubles, or proxying through instrumented HTTP clients.

const figranium = new Figranium({
  apiKey: "fig_...",
  fetch: instrumentedFetch,
});

`headers`

Default headers merged into every request. Per-call headers override these.

new Figranium({
  apiKey: "fig_...",
  headers: { "x-client-name": "my-service" },
});

Complete example

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

const figranium = new Figranium({
  baseUrl: process.env.FIGRANIUM_BASE_URL,
  apiKey: process.env.FIGRANIUM_API_KEY!,
  timeoutMs: 45_000,
  headers: { "x-client-name": "orders-worker" },
});

Client resources

The Figranium instance exposes one property per resource, plus a few top-level convenience helpers.

Property	Purpose
`tasks`	List, save, version, update, delete, and execute tasks
`executions`	List, inspect, stop, delete, clear, and stream runs
`schedules`	Configure, describe, disable, and inspect schedules
`captures`	List and delete recordings and screenshots; manage cookies
`browser`	Open browser sessions, highlight selectors, inspect headful sessions
`execution`	Direct `scrape`, `agent`, and `headful` execution endpoints
`health`	Service health check

Top-level shortcuts:

figranium.runTask(id, input?) proxies to tasks.run.
figranium.scrape(input) proxies to execution.scrape.
figranium.agent(input) proxies to execution.agent.
figranium.headful(input) proxies to execution.headful.

Introduction

JavaScript SDK

Python SDK

Swift SDK

Kotlin SDK

Configure the Figranium SDK Client

Constructor options

Option details

`baseUrl`

`apiKey` and `apiKeyHeader`

`timeoutMs`

`fetch`

`headers`

Complete example

Client resources

​Constructor options

​Option details

​baseUrl

​apiKey and apiKeyHeader

​timeoutMs

​fetch

​headers

​Complete example

​Client resources

Constructor options

Option details

`baseUrl`

`apiKey` and `apiKeyHeader`

`timeoutMs`

`fetch`

`headers`

Complete example

Client resources