Authentication
All API requests require an API key passed as a Bearer token in the Authorization header.
Getting your API key
- Log in to your web app — on the Feld cloud that is app.feld.ai
- Navigate to Project Settings → API Keys
- Click Create API Key and copy the key, along with the API endpoint shown next to it
vorsicht
The full key is shown only once at creation. Store it securely.
hinweis
Note the host in step 3: the API endpoint is a different host from the web app you just logged in to. Send API requests to the API host, not to the web app address in your browser's address bar.
Making authenticated requests
Include your API key in every request:
curl https://api.feld.ai/v1/documents \
-H "Authorization: Bearer YOUR_API_KEY"
Key properties
| Property | Details |
|---|---|
| Scope | Each key is bound to a single project |
| Permissions | Full access to all documents and operations within the project |
| Revocation | Keys 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
- Quick Start — Upload your first document
- Error handling — Error types and status codes