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

Open Settings

In Figranium, open Settings from the main navigation.
2

Copy or generate your key

Copy your existing Figranium API key. If you do not have one yet, generate a new key.
3

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.

​
Regenerating a key

If a key is exposed or you want to replace it, generate a new one in Settings > API Keys. Any integration still using the previous key will need to be updated with the new value.

REST API Reference

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