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:
In the Firefly web console, navigate to Settings > Users
Click Create Key Pair
Copy both the Access Key and Secret Key (they will only be shown once)
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
Authenticate user using access key and secret key
Body
accessKeystringRequired
User's access key
secretKeystringRequired
User's secret key
Responses
200
Successful login
application/json
401
Unauthorized Error
application/json
post
POST /v2/login HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"accessKey": "text",
"secretKey": "text"
}
{
"accessToken": "text",
"expiresAt": 1,
"tokenType": "text"
}
Health Check
Last updated
Was this helpful?