List API Keys

Returns a list of all API keys belonging to the authenticated user’s workspace.

Requirements:

Authentication required via admin API key

Key Features:

View all API keys with their aliases and creation dates
Optionally expand to include creator information
Paginated results for workspaces with many keys

Expansion Options:

expand=creator_info: Include creator_nickname and creator_email for each key

Common Use Cases:

Audit existing API keys
Find keys by alias
Monitor key creation activity
Build key management interfaces

GET

keys

List API Keys

curl --request GET \
  --url https://api.fal.ai/v1/keys \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "keys": [
    {
      "key_id": "abc123def456",
      "alias": "Production Key",
      "scope": "API",
      "created_at": "2025-01-15T12:00:00Z"
    },
    {
      "key_id": "xyz789ghi012",
      "alias": "Development Key",
      "scope": "API",
      "created_at": "2025-01-10T09:30:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

Admin API key must be prefixed with "Key ", e.g. Authorization: Key YOUR_ADMIN_API_KEY

Query Parameters

limit

integer

Maximum number of items to return. Actual maximum depends on query type and expansion parameters.

Required range: x >= 1

Example:

50

cursor

string

Pagination cursor from previous response. Encodes the page number.

Example:

"Mg=="

expand

Fields to expand in the response. Available: creator_info (includes creator_nickname and creator_email)

Example:

["creator_info"]

Response

Successfully retrieved API keys

Response containing a list of API keys with pagination support

next_cursor

string | null

required

Cursor for the next page of results, null if no more pages

has_more

boolean

required

Boolean indicating if more results are available (convenience field derived from next_cursor)

keys

object[]

required

Array of API keys belonging to the authenticated user

Show child attributes

Create API KeyCreates a new API key with the specified alias. **Requirements:** - Authentication required via admin API key **Important Security Notice:** The `key_secret` is only returned once at creation time. Store it securely immediately as it cannot be retrieved again. If lost, you must delete the key and create a new one. **Key Features:** - Create API keys programmatically without UI access - Assign meaningful aliases for key identification - Keys are immediately active upon creation **Common Use Cases:** - Programmatic key provisioning for CI/CD pipelines - Self-serve key generation for team members - Automated key rotation workflows - Integration with secret management systems

⌘I

List API Keys

curl --request GET \
  --url https://api.fal.ai/v1/keys \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "keys": [
    {
      "key_id": "abc123def456",
      "alias": "Production Key",
      "scope": "API",
      "created_at": "2025-01-15T12:00:00Z"
    },
    {
      "key_id": "xyz789ghi012",
      "alias": "Development Key",
      "scope": "API",
      "created_at": "2025-01-10T09:30:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}