Skip to main content
The figranium-sdk package is the official Python client for the Figranium API. It exposes synchronous and asynchronous clients built on httpx, with typed request and response shapes via TypedDict, a py.typed marker for type-checker support, and structured error handling with streaming execution events.

​
Highlights

Typed API

TypedDict definitions for tasks, actions, executions, schedules, and more. Ships with a py.typed marker so mypy and pyright can use the annotations.

Sync and async

Use Figranium for synchronous code or AsyncFigranium for async/await. Both expose the same method names and resource layout.

Custom httpx clients

Pass your own httpx.Client or httpx.AsyncClient for proxies, tracing, or test doubles. The SDK never closes a caller-supplied client.

Abortable streams

Execution and selector streams surface as iterators (sync) or async iterators with per-request timeout control via RequestOptions.

​
Package facts

​
What you can do with the SDK

  • Save, update, version, and roll back tasks with typed Task and Action dicts.
  • Run tasks with runtime variables, or call scrape, agent, and headful directly for one-off executions.
  • 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 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 Python environment can reach Figranium.

Quickstart

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

Client configuration

Configure base_url, timeouts, custom httpx clients, and default headers.

Resources

Reference for every resource exposed on the Figranium client.