Every public endpoint requires a Coldy API key in the HTTP Authorization header.

Authorization: Bearer YOUR_API_KEY

Create a key

  1. Open Settings → Integrations.
  2. Select API Keys.
  3. Generate a key for the organization you want to access.
  4. Copy it immediately; the complete key is shown only once.
  5. Store it in a secrets manager or protected server-side environment variable.

Keys are organization-scoped. The same identifier may not be accessible with a key issued by another organization.

Send an authenticated request

curl --request GET \
  --url https://developer.coldy.ai/api/v1/accounts \
  --header "Authorization: Bearer $COLDY_API_KEY" \
  --header "Accept: application/json"

Send JSON request bodies with Content-Type: application/json.

Authentication failures

The API returns 401 Unauthorized when the header is missing or malformed, the key is invalid, or the key is not associated with an organization.

{
  "message": ["Unauthorized"],
  "error": "Unauthorized",
  "statusCode": 401
}

Do not retry a 401 automatically. Confirm that the complete key is present, uses the Bearer scheme, and belongs to the intended organization.

Rotate a key

Create a replacement, update the secret in every server-side environment, verify requests with it, and then revoke the old key.