Introduction
Agent Brains REST API introduction and quick links
API Introduction
Welcome to the Agent Brains REST API documentation. The base URL for requests is:
https://api.agent-brains.com
Use the sections below to navigate by domain.
Authentication
Authenticate every protected request using one of these headers:
x-api-key: <your-api-key>x-access-key: <your-api-key>Authorization: Bearer <your-api-key>
Header priority is x-api-key -> x-access-key -> Authorization: Bearer.
After extraction, the token is verified against the Access Keys Manager for
the required scope.
Knowledge Base
Browse, fetch, create, update, and delete implemented Knowledge Base resources. Entity and category deletion is permanent and cannot be undone. Attachment creation supports JSON/base64 and multipart HTTP requests; the MCP attachment create tool supports JSON/base64 only.
Snapshot
Entities
List Entities
GET /knowledge-base/entities
Get Entity
GET /knowledge-base/entities/{idOrAlias}
Create Entity
POST /knowledge-base/entities
Update Entity
PATCH /knowledge-base/entities/{id}
Delete Entity
DELETE /knowledge-base/entities/{id}. Permanent.
Get Entity Relationships
List relationships for a specific entity.
Get Entity Attachments
List attachments for a specific entity.
List Entities by Category
List entities filtered by category.
Categories
List Categories
GET /knowledge-base/categories
Get Category
GET /knowledge-base/categories/{key}
Create Category
POST /knowledge-base/categories
Update Category
PATCH /knowledge-base/categories/{id}
Delete Category
DELETE /knowledge-base/categories/{id}. Permanent.
List Category Aliases
List category alias keys available for filtering.
Attachments
List Attachments
GET /knowledge-base/attachments
Get Attachment
GET /knowledge-base/attachments/{attachmentId}
Create Attachment
POST /knowledge-base/attachments. JSON/base64 or multipart.
Update Attachment
PATCH /knowledge-base/attachments/{attachmentId}
Link/Unlink Attachment
Link or unlink an attachment to/from an entity.
Indexes
List Indexes
List indexes with metadata and vectorisation status.
Retrieve Matches
Search the vector database with a query using the RAG retrieval model.
Conversations
List conversations, retrieve history, and send outbound agent messages.
List Conversations
GET /conversations
Get Conversation History
GET /conversations/{conversationId}/history
Send Agent Message
POST /conversations/{conversationId}/message
Document Structuring
Start asynchronous document structuring tasks and retrieve task status/result.
Employees
Access employee configuration.
List Employees
List employees for the authenticated workspace.
Get Employee
Get one employee configuration by employee ID.
Company
Fetch tenant-level company information.