Authentication

The Firefly API supports multiple authentication methods, including JWT and Basic Authentication. To use the API, you'll need to create an API key pair (Access Key and Secret Key) for authentication.

Creating an API Key Pair

To create a new API key pair for authentication:

1. In the Firefly web console, navigate to Settings > Users

2. Click Create Key Pair

3. Copy both the Access Key and Secret Key (they will only be shown once)

4. Store your keys securely in a password manager or secrets vault

For detailed instructions on creating and managing API keys, see the User Management documentation.

Authentication

Login with access key

post

Authenticate user using access key and secret key

Body

accessKeystringrequired

User's access key

secretKeystringrequired

User's secret key

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.firefly.ai/api/v2/login' \
  --header 'Content-Type: application/json' \
  --data '{
    "accessKey": "text",
    "secretKey": "text"
  }'

200

401

200

{
  "accessToken": "text",
  "expiresAt": 1,
  "tokenType": "text"
}

Successful login

Health Check

Health Check

get

Simple health check endpoint that returns 204 if the service is up

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.firefly.ai/api/v2/health'

204

204

No Content

Service is healthy.