List Agents

Retrieves all agents created by the authenticated user.

Endpoint

GET /v1/agents

Authentication

Requires a valid API key or user authentication token.

Response

Returns an array of agent objects, each containing the agent's configuration and metadata.

Response Format

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "system_prompt": "string",
    "language": "string",
    "voice_id": "string",
    "tts_provider": "string",
    "stt_provider": "string",
    "llm_model": "string",
    "knowledge_base_ids": ["string"],
    "created_at": "datetime",
    "updated_at": "datetime",
    "created_by": "string"
  }
]

Response Fields

Field	Type	Description
id	string	Unique identifier for the agent
name	string	Display name of the agent
description	string	Optional description of the agent's purpose
system_prompt	string	Instructions that define the agent's personality and behavior
language	string	Language code (e.g., "en" for English)
voice_id	string	Identifier for the agent's voice
tts_provider	string	Text-to-speech provider (e.g., "KrosMLingual 0.1")
stt_provider	string	Speech-to-text provider (e.g., "KrosMLingual 0.1")
llm_model	string	Large language model used by the agent (e.g., "KrosMLingual 0.1")
knowledge_base_ids	array	List of knowledge base IDs the agent can access
created_at	datetime	When the agent was created
updated_at	datetime	When the agent was last updated
created_by	string	ID of the user who created the agent

Example Request

curl -X GET "https://api.krosai.com/v1/agents" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Customer Support Agent",
    "description": "Helps users with product inquiries",
    "system_prompt": "You are a helpful customer support agent for KrosAI...",
    "language": "en",
    "voice_id": "echo",
    "tts_provider": "krosaimlingual",
    "stt_provider": "krosaimlingual",
    "llm_model": "krosaimlingual",
    "knowledge_base_ids": ["kb-12345"],
    "created_at": "2023-06-15T10:30:00Z",
    "updated_at": "2023-06-15T10:30:00Z",
    "created_by": "user-12345"
  },
  {
    "id": "b2c3d4e5-f6g7-8901-bcde-fg2345678901",
    "name": "Sales Assistant",
    "description": "Helps with product recommendations",
    "system_prompt": "You are a knowledgeable sales assistant...",
    "language": "en",
    "voice_id": "helen",
    "tts_provider": "krosaimlingual",
    "stt_provider": "krosaimlingual",
    "llm_model": "krosaimlingual",
    "knowledge_base_ids": ["kb-23456", "kb-34567"],
    "created_at": "2023-06-20T14:45:00Z",
    "updated_at": "2023-06-22T09:15:00Z",
    "created_by": "user-12345"
  }
]

Error Responses

Status Code	Description
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions
500	Internal Server Error