Install the Figranium Python SDK

The Figranium Python SDK installs from PyPI as figranium-sdk. It has a single runtime dependency on httpx>=0.27,<1, so it stays lightweight in your dependency tree.

Requirements

Python 3.9 or newer.
A running Figranium server that the client can reach at its base_url. Local installs default to http://localhost:11345.

Install

pip install figranium-sdk

uv pip install figranium-sdk

poetry add figranium-sdk

pipx inject your-tool figranium-sdk

The package depends only on httpx>=0.27,<1. If your project already uses httpx, the SDK will share the same version range.

Import styles

Import the sync client, async client, helpers, and types from the figranium module.

from figranium import Figranium, actions, variable, Task

from figranium import AsyncFigranium

Verify the install

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

verify_sync.py

import os
from figranium import Figranium

with Figranium(
    base_url="http://localhost:11345",
    api_key=os.environ["FIGRANIUM_API_KEY"],
) as client:
    status = client.health.check()
    print(status)

A healthy Figranium instance returns a dict like {"status": "ok"}. For async environments, use AsyncFigranium with asyncio.run:

verify_async.py

import asyncio
import os
from figranium import AsyncFigranium

async def main():
    async with AsyncFigranium(
        base_url="http://localhost:11345",
        api_key=os.environ["FIGRANIUM_API_KEY"],
    ) as client:
        status = await client.health.check()
        print(status)

asyncio.run(main())

Next steps

Quickstart

Save and run your first task with the SDK.

Client configuration

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

JavaScript SDK

Python SDK

Swift SDK

Install the Figranium Python SDK

Requirements

Install

Import styles

Verify the install

Next steps

Quickstart

Client configuration

​Requirements

​Install

​Import styles

​Verify the install

​Next steps

Quickstart

Client configuration

Requirements

Install

Import styles

Verify the install

Next steps