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 and fetch knowledge-base entities, categories, attachments, and indexes.
Entities
List Entities
List entities with filtering and field selection.
Get Entity
Get a single entity by ID or alias.
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
List categories with filtering options.
Get Category
Get a category by key.
List Category Aliases
List category alias keys available for filtering.
Attachments
List Attachments
List attachments with optional filters.
Get Attachment
Get an attachment by ID.
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.
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.