Developers

Generate an API key

POST/v1/developers/api-keys

Returns the full key once, as `key`. It cannot be retrieved again.

Requires the session token of a signed-in Alfa user as a bearer token.

Request body

namestringrequired
at least 1 characters · at most 60 characters
environment"test" | "live"required
scopes"ats_jobs:write" | "jobs:read" | "candidates:read" | "webhooks:manage"[]required
at least 1 items
expiresInDays30 | 90 | 365 | null

Responses

201Created.
400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
401The bearer token is missing, expired or invalid. Problem details
403The caller may not perform this operation, or has no active organisation. Problem details
404The resource does not exist or is not visible to the caller. Problem details
422The request failed validation; `errors` lists each invalid field. Problem details
429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
500An unexpected error. Quote the `correlationId` to support. Problem details

Request

curl -X POST "https://api.welovealfa.com/v1/developers/api-keys" \
  -H "Authorization: Bearer $ALFA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","environment":"test","scopes":["ats_jobs:write"]}'