Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.brainstormer.io/llms.txt

Use this file to discover all available pages before exploring further.

The Brainstormer API uses API keys for authentication. Every request to a v1 endpoint must include a valid API key in the Authorization header.

​
API keys and Applications

API keys are scoped to an Application — a named container you create in the Developer Portal. Each application has a type that describes how it integrates with Brainstormer:
TypeWhen to use
Agent ConsumerApps that call agents on behalf of users
Web IntegrationEmbedding agents in websites or web apps
Backend ServiceServer-to-server integrations
A single application can have multiple API keys (for example, separate keys for production and development environments).

​
Getting an API key

  1. Open Developer in the sidebar.
  2. Click New App, enter a name, choose an application type, and click Create.
  3. Select the application from the list, then click Generate Key.
  4. Copy the key immediately.
Your API key is only shown once at the moment it is generated. If you lose it, you will need to revoke it and generate a new one.
API keys follow this format: 
brs_live_xxxxxxxxxxxxxxxxxx

​
Using your API key

Pass the key in the Authorization header of every request as a Bearer token. 
Authorization: Bearer brs_live_xxxxxxxxxxxxxxxxxx
Full example (replace https://your-domain with your Brainstormer instance URL): 
curl -X POST https://your-domain/v1/chat \
  -H "Authorization: Bearer brs_live_xxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"agent_id": "YOUR_AGENT_ID", "message": "Hello!"}'
Any request that is missing the header, uses the wrong format, or contains a revoked key receives a 401 Unauthorized response.

​
Revoking keys

You can revoke an API key at any time from the Developer Portal. Navigate to the application, find the key in the table, and click Revoke. Revocation is immediate — all subsequent requests using that key will be rejected.