Skip to content

Authentication

FullFill authenticates every API request with an API key.

Keys are created in the app under Settings → API Keys. You can’t mint keys through the API - this keeps a leaked key from creating more keys.

  • Permissions - a key acts with your own permissions. An admin’s key can do admin things; a regular user’s key cannot.
  • Read-only - a key marked read-only can ask questions but cannot upload or modify anything.
  • Expiry - keys can expire on a schedule or never.
  • The full key is shown once at creation. Store it securely; revoke it if leaked.

Pass the key in the X-API-Key header - the value is just the key:

X-API-Key: ffk_your_key_here
Terminal window
curl https://api.full-fill.ai/api/v2/chat/sessions/ \
-H "X-API-Key: ffk_your_key_here"
Status Meaning
401 / 403 Missing, invalid, revoked, or expired key
403 Key valid but not permitted (e.g. no active license, or repository upload without manager rights)
429 Rate or quota limit exceeded

Error responses have the shape {"error": "..."}.