Authenticate the Figranium Python SDK

The Figranium Python SDK authenticates with an API key. Create one in the Figranium web UI, then pass it to the client so every request is signed automatically.

Create an API key

Sign into the Figranium web UI and generate an API key from Settings. Copy the value once; you will not see it again.

Pass the key to the client

Provide api_key when constructing the client. Figranium sends it as Authorization: Bearer <key> by default.

import os
from figranium import Figranium

client = Figranium(
    base_url="http://localhost:11345",
    api_key=os.environ["FIGRANIUM_API_KEY"],
)

Switch to the x-api-key header (optional)

Some deployments expect x-api-key instead of the Authorization header. Set api_key_header="x-api-key":

Figranium(
    api_key=os.environ["FIGRANIUM_API_KEY"],
    api_key_header="x-api-key",
)

Only "authorization" (default) and "x-api-key" are valid values.

What API keys can access

API keys authenticate every task, execution, schedule, capture, browser, and execution endpoint exposed by the SDK. Server-administration operations (creating API keys, changing themes, configuring AI providers, and managing proxies) are performed in the Figranium web UI.

Store API keys in environment variables or a secrets manager. Never commit keys to source control or expose them in client-side code.

Client configuration

All available client options, including base_url and timeout.

API key

How Figranium API keys work and how to manage them from the web UI.

JavaScript SDK

Python SDK

Swift SDK

Authenticate the Figranium Python SDK

What API keys can access

Client configuration

API key

​What API keys can access

​Related

Client configuration

API key

What API keys can access

Related