Skip to main content
Use your Figranium API key to authenticate integrations, scripts, and other external tools with your instance.
1

Open API Keys

In Figranium, open Settings > API Keys from the main navigation.
2

Create a named key

Select Add API Key, give the key a name, and choose only the permissions it needs. You can optionally restrict it to specific Tasks.
3

Copy it once

Copy the secret when Figranium shows it after creation. Store it securely because the full value is shown only once.
4

Paste it into your integration

Return to the service you are connecting and paste the key into its API Key field.
Treat your API key like a password. Do not publish it in screenshots, source code, public repositories, or shared documents.

​
Using the key directly

Figranium accepts the API key in several authentication formats. For most integrations and scripts, use the x-api-key header:
You can also authenticate with a bearer token:
Your Figranium Base URL is the address of your own Figranium instance. For example, https://figranium.example.com or http://localhost:11345 for a default local installation.

​
Permissions and Task restrictions

Create each key for one integration or workflow and grant only the access it needs: You can restrict a key to selected Tasks with a Task allowlist. A restricted key cannot access other Tasks, even when it has the corresponding permission. Figranium accepts existing results:read keys and normalizes them to the current tasks:run access model.

​
Revoking a key

To invalidate a key, open Settings > API Keys, select the key, and confirm the revocation. Any integration using the revoked key must be updated with another key.

​
Regenerating a key

If a key is exposed or you want to replace it, create a new named key in Settings > API Keys, update your integrations, then revoke the old key.

REST API Reference

See the full API reference for authentication methods, endpoints, request bodies, and examples.