Get Agent

Retrieves detailed information about a specific agent.

Endpoint

GET /v1/agents/{agent_id}

Parameters

Parameter	Type	Required	Description
agent_id	string	Yes	Unique identifier of the agent to retrieve

Authentication

Requires a valid API key or user authentication token.

Response

Returns the agent object with its complete 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	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., "krosaimlingual")
stt_provider	string	Speech-to-text provider (e.g., "krosaimlingual")
llm_model	string	Large language model used by the agent (e.g., "krosaimlingual")
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/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Product Expert",
  "description": "Helps users with product information and recommendations",
  "system_prompt": "You are a knowledgeable product expert for KrosAI. You help users understand our products and make recommendations based on their needs. Be friendly, concise, and helpful.",
  "language": "en",
  "voice_id": "pidgin",
  "tts_provider": "krosaimlingual",
  "stt_provider": "krosaimlingual",
  "llm_model": "krosaimlingual",
  "knowledge_base_ids": ["kb-product-catalog"],
  "created_at": "2023-07-10T15:30:00Z",
  "updated_at": "2023-07-10T15:30:00Z",
  "created_by": "user-12345"
}

Error Responses

Status Code	Description
401	Unauthorized - Invalid or missing API key
403	Forbidden - Not authorized to access this agent
404	Not Found - Agent with the specified ID does not exist
500	Internal Server Error

Notes

• Users can only retrieve agents they have created.

• The system prompt may contain sensitive information about how the agent is configured to behave.