FAfal
Keys

List API Keys

Changed on

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

Key Features:

  • View all API keys with their aliases and creation dates
  • See how each key is permissioned via mode, preset and permissions
  • Optionally expand to include creator information
  • Paginated results for workspaces with many keys

Key Modes:

  • preset: created from a named permission preset, reported in preset
  • custom: created with an explicit list of permissions
  • legacy: predates granular permissions and carries a coarse scope

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

Required permissions: auth:keys:read. Key presets that include them: BILLING, FULL. See key permissions.

get/keys

Request

  • Base URL
    https://api.fal.ai/v1
  • URL
    https://api.fal.ai/v1/keys
  • Auth
    API key in header Authorization

Query parameters

limitinteger

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

Example:50
cursorstring

Pagination cursor from previous response. Encodes the page number.

Example:Mg==
string
OR
string[]

Response

Successfully retrieved API keys

next_cursorstring nullable required

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

has_moreboolean required

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

Example response

{
  "keys": [
    {
      "key_id": "abc123def456",
      "alias": "Production Key",
      "scope": "API",
      "created_at": "2025-01-15T12:00:00Z",
      "description": "CI deploy key for the main environment",
      "mode": "preset",
      "preset": "API",
      "permissions": [
        "models:requests:read",
        "models:requests:write"
      ],
      "expires_at": "2025-07-15T12:00:00Z",
      "creator_nickname": "developer",
      "creator_email": "developer@example.com"
    }
  ]
}

Changes

  • c87cd6025a16Revision changes
    • breaking

      the response property // became optional for the status

    • warning

      added the new ADMIN enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 479db2f9dcd6Revision changes
    • info

      the endpoint scheme security billingApiKey was added to the API

    • info

      the endpoint scheme security adminApiKey was removed from the API

    • info

      response property keys/items/scope deprecated