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.

This guide walks you from a blank account to a running agent that you can query over HTTP.
1

Sign up and create an organization

Go to the Brainstormer dashboard and register for an account. During sign-up you’ll name your organization — this is the workspace that holds your agents, knowledge bases, and team members.If you’ve already signed up, make sure you’re logged in to the correct organization. You can switch organizations from the top-left dropdown.
2

Create an agent

  1. In the left sidebar, click Agents.
  2. Click Classic Setup to open the step-by-step agent wizard.
The wizard has five steps:
StepWhat you configure
Basic InfoAgent name and description
ProviderThe AI provider (OpenAI, Anthropic, Google, etc.)
ModelThe specific model — choose from 300+ options
PromptThe system prompt that defines your agent’s behavior
PreviewTest the agent before publishing
Write a system prompt that describes your agent’s role and tone. For example:
You are a helpful customer support assistant for Acme Inc.
Answer questions clearly and concisely. If you don't know
the answer, say so rather than guessing.
On the Preview step, send a test message to confirm the agent responds as expected, then click Publish.
The Creator Wizard is an alternative path designed for content creators. It connects public URLs and RSS feeds, ingests them into a knowledge base, and generates a system prompt scaffold based on your profile. Use Classic Setup if you want full manual control.
3

Chat with your agent in the dashboard

After publishing, click your agent’s card on the Agents page and open a conversation. The dashboard chat interface lets you test your agent with real messages — conversation memory is preserved across turns, so you can follow up naturally.Use this to iterate on your system prompt before connecting external applications.
4

Get an API key

  1. In the left sidebar, click Developer.
  2. Under Your Applications, click New App.
  3. Give the application a name (e.g. My First App) and choose a type:
    • Agent Consumer — apps that call agents
    • Web Integration — embedding agents in websites
    • Backend Service — server-to-server calls
  4. Click Create, then select the application from the list.
  5. Click Generate Key to create an API key.
Copy your key immediately — it’s only shown once. If you lose it, generate a new one and revoke the old one.
Your key looks like brs_live_xxxxxxxxxxxxxxxxxx. Keep it secret; it has full access to your organization’s agents.
5

Make your first API call

Pass your API key in the Authorization: Bearer header and send a POST request to /v1/chat with your agent’s ID and a message.Find your agent’s ID by clicking on it in the dashboard — it appears in the URL (/agents/<agent-id>).Replace https://your-domain in the examples below 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, what can you help me with?"
  }'
The response includes the agent’s reply and metadata about the conversation:
{
  "message": "I can help you with questions about Acme Inc. — products, billing, support, and more. What would you like to know?",
  "conversationId": "conv_abc123",
  "tokenUsage": { "prompt": 84, "completion": 32 }
}
To continue the conversation across calls, pass the conversationId from the previous response:
{
  "agent_id": "your-agent-id",
  "message": "Tell me more about billing.",
  "conversation_id": "conv_abc123"
}

​
Other endpoints

MethodPathDescription
GET/v1/agentsList all agents in your organization
GET/v1/agents/:idGet details for a single agent
POST/v1/kb/searchSearch a knowledge base by query

​
Search a knowledge base

cURL
curl -X POST https://your-domain/v1/kb/search \
  -H "Authorization: Bearer brs_live_xxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "kb_id": "your-knowledge-base-id",
    "query": "refund policy",
    "top_k": 5
  }'
All API endpoints require the Authorization: Bearer brs_live_... header. Requests without a valid key return 401 Unauthorized.

​
What’s next