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.

​
List agents

Retrieve all agents that belong to your organization. 
GET /v1/agents
No request body is required. 
curl https://your-domain/v1/agents \
  -H "Authorization: Bearer brs_live_xxxxxxxxxxxxxxxxxx"

​
Response

{
  "bots": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Support Assistant",
      "description": "Handles customer support queries",
      "model": "openai/gpt-4o",
      "isDraft": false,
      "organizationId": "org_xxxxxxxxxxxxxxxx",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-03-01T14:22:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1
  }
}
​
bots
array
List of agents belonging to your organization.
​
bots[].id
string
Unique identifier for the agent. Use this as agent_id when sending chat messages.
​
bots[].name
string
Display name of the agent.
​
bots[].description
string
Optional description of what the agent does.
​
bots[].model
string
The AI model the agent uses (e.g. openai/gpt-4o).
​
bots[].isDraft
boolean
When true, the agent is in draft state and may not be fully configured.
​
bots[].createdAt
string
ISO 8601 timestamp of when the agent was created.
​
pagination
object
Pagination metadata for the result set.

​
Get agent

Retrieve details for a single agent by its ID. 
GET /v1/agents/:id

​
Path parameters

​
id
string
required
The unique identifier of the agent to retrieve.
curl https://your-domain/v1/agents/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer brs_live_xxxxxxxxxxxxxxxxxx"

​
Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Support Assistant",
  "description": "Handles customer support queries",
  "model": "openai/gpt-4o",
  "isDraft": false,
  "organizationId": "org_xxxxxxxxxxxxxxxx",
  "knowledgeBases": [
    {
      "id": "kb_xxxxxxxxxxxxxxxx",
      "name": "Product Docs"
    }
  ],
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-03-01T14:22:00.000Z"
}
​
id
string
Unique identifier for the agent.
​
name
string
Display name of the agent.
​
description
string
Optional description of the agent.
​
model
string
The AI model the agent uses.
​
isDraft
boolean
Whether the agent is in draft state.
​
knowledgeBases
array
Knowledge bases linked to this agent. Each entry includes an id and name.
​
createdAt
string
ISO 8601 timestamp of when the agent was created.
​
updatedAt
string
ISO 8601 timestamp of the last update.