API Keys

API keys let your agents talk to Faramesh. Create one per agent or environment (dev, staging, prod).

Create a key

1. Go to API Keys

2. Click Create API Key

3. Name it (e.g. "production-agent" or "langchain-bot")

4. Choose scopes if prompted

5. Copy the key — it's shown only once

Store the key securely (environment variable, secrets manager). If you lose it, revoke it and create a new one.

Using a key

Pass the key as a Bearer token when calling the API or configuring the SDK:

export FARAMESH_API_KEY="your-key"
# or
curl -H "Authorization: Bearer your-key"

export FARAMESH_API_KEY="your-key"
# or
curl -H "Authorization: Bearer your-key"

export FARAMESH_API_KEY="your-key"
# or
curl -H "Authorization: Bearer your-key"

Revoke a key

Click Revoke next to the key. Revoked keys stop working immediately.