v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-1759238438.1 KB

API Keys

Create an API key

Creates a new API key for the specified organization. The secret is only returned once in the response and cannot be retrieved later.

post/v1beta/api-keys

Request body

expires_atstring date-time

Expiration timestamp. If not set, the key does not expire. When set, must be in the future and within 1 year. Security note: Keys without expiration should be rotated periodically. timestamp.gt_now = true timestamp.within = 8760h0m0s

namestring required

Human-readable name for the key (e.g., "Production", "Staging").

organization_idstring required

Organization ID to create the key for. Pattern: org_[0-9a-hjkmnp-tv-z]{26}

Response

Success

secretstring required

The API key secret. This is only returned once and cannot be retrieved later. Format: ffy_{env}_{base32_uuid7}{base62_random}

env: "prod" or "test"
base32_uuid7: 26 chars (TypeID base32 alphabet: 0-9a-hjkmnp-tv-z)
base62_random: 43 chars (0-9A-Za-z) Store this value securely - it will not be shown again. SECURITY WARNING: This field must NEVER be logged. Handlers must redact secrets from all logs.

Example response

{
  "api_key": {
    "id": "key_01jd4h5mck9gq6zrp8bn2t4w3x",
    "key_prefix": "ffy_prod_01jd4h5...",
    "name": "Production",
    "organization_id": "org_01h2xcejqtf2nbrexx3vqjhp41"
  },
  "secret": "ffy_prod_01h2xcejqtf2nbrexx3vqjhp41KJ8f3mNpQrStUvWxYz0123456789ABCDEFGHIJKLmNo"
}