Get All Brains

GET/v1/brains

Retrieve a list of all available brains/knowledge bases.

What is a Brain?

A brain (also known as a knowledge base) is a collection of documents and information that provides context and knowledge to agentic avatars. Brains enable avatars to answer questions intelligently by accessing stored information, FAQs, documentation, and other knowledge sources.

Key Features:

Knowledge Storage: Store documents, FAQs, and other information
AI Integration: Used by agentic avatars to provide intelligent responses
Status Tracking: Monitor brain status (ready, processing, etc.)
Document Management: Track the number of documents in each brain

Request History

TIME	STATUS	USER AGENT
Make a request to see history.

0 Requests This Month

Query Parameters

All query parameters are optional. Use them to filter and paginate the results.

Parameter	Type	Description
page	integer optional	Page number for pagination. Default: `1`
limit	integer optional	Number of items per page. Default: `20`
type	string optional	Filter by brain type (e.g., `knowledge_base`). If not specified, all brain types are returned.

Request Example

shell

curl -X GET "https://api.konpro.ai/v1/brains?page=1&limit=20&type=knowledge_base" \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json"

Response

Field	Type	Description
brains	array	Array of brain objects. Each object contains the brain/knowledge base details.
pagination	object	Pagination information object containing page, limit, total, and total_pages

Brain Object

Field	Type	Description
id	string	Unique identifier of the brain/knowledge base
name	string	Name of the brain/knowledge base
description	string	Description of the brain/knowledge base
type	string	Type of the brain (e.g., `knowledge_base`)
document_count	integer	Number of documents stored in the brain
last_updated	string	ISO 8601 timestamp of when the brain was last updated
status	string	Current status of the brain (e.g., `ready`, `processing`)

Pagination Object

Field	Type	Description
page	integer	Current page number
limit	integer	Number of items per page
total	integer	Total number of brains matching the query
total_pages	integer	Total number of pages available

Sample Successful Response

json

{
  "brains": [
    {
      "id": "002a9215-dc48-4537-91cb-93ac182e4e93",
      "name": "Customer Support Knowledge Base",
      "description": "Comprehensive FAQ and support documentation",
      "type": "knowledge_base",
      "document_count": 150,
      "last_updated": "2024-01-01T00:00:00Z",
      "status": "ready"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 10,
    "total_pages": 1
  }
}

Notes

This endpoint requires authentication using the x-api-key header.
All query parameters are optional. If not specified, the endpoint returns all brains with default pagination.
Use the type parameter to filter brains by type (e.g., knowledge_base).
The response includes pagination information to help you navigate through multiple pages of results.
Only brains/knowledge bases that belong to your account are returned.
The status field indicates whether the brain is ready to use (ready) or still processing (processing).
Brains can be used in agentic avatars by referencing the brain_id when creating an agentic avatar.
For error descriptions, see Error Responses.

Delete Agentic Avatar Validate API Key