Zum Hauptinhalt springen

Authentication

All API requests require an API key passed as a Bearer token in the Authorization header.

Getting your API key

  1. Log in to the feld.ai web app
  2. Navigate to Project SettingsAPI Keys
  3. Click Create API Key and copy the key
vorsicht

The full key is shown only once at creation. Store it securely.

Making authenticated requests

Include your API key in every request:

curl https://api.feld.ai/api/v1/documents \
-H "Authorization: Bearer YOUR_API_KEY"

Key properties

PropertyDetails
ScopeEach key is bound to a single project
PermissionsFull access to all documents and operations within the project
RevocationKeys can be revoked at any time from the web app
tipp

Use environment variables to keep keys out of your codebase:

export FELD_API_KEY="your-api-key-here"

Next steps