Agent Directory

Endpoints

Get All Agents

Retrieves a list of all available agents.

URL: /agents
Method: GET
Authentication: Not required

Response:

[
  {
    "id": "string",
    "name": "string",
    "url": "string",
    "description": "string",
    "config": "object",
    "thumbnail_url": "string",
    "creator": "string",
    "configs": [
      {
        "id": "string",
        "config": "object"
      }
    ],
    "total_rate": "number",
    "total_reviews": "number"
  }
]

Status Codes:

200 OK: Agents successfully retrieved
500 Internal Server Error: Server-side error

Usage: Use this endpoint to display a list of available agents to users.

Get Agent by ID

Retrieves detailed information about a specific agent.

URL: /agents/{agent_id}
Method: GET
Authentication: Not required

Parameters:

agent_id: The unique identifier of the agent

Response:

{
  "id": "string",
  "name": "string",
  "url": "string",
  "description": "string",
  "config": "object",
  "thumbnail_url": "string",
  "configs": [
    {
      "id": "string",
      "config": "object"
    }
  ],
  "total_rate": "number",
  "total_reviews": "number"
}

Status Codes:

200 OK: Agent successfully retrieved
404 Not Found: Agent not found
500 Internal Server Error: Server-side error

Usage: Use this endpoint to fetch detailed information about a specific agent.

Choose Best Agent

Automatically selects the most suitable agent based on a user message.

URL: /agents/choose
Method: POST
Authentication: Not required

Request Body:

{
  "message": "string"
}

Response:

{
  "id": "string",
  "name": "string",
  "url": "string",
  "description": "string",
  "config": "object",
  "total_rate": "number",
  "total_reviews": "number"
}

Status Codes:

200 OK: Agent successfully selected
400 Bad Request: Missing required fields
404 Not Found: No agents available
500 Internal Server Error: Server-side error

Usage: Use this endpoint when you want the system to automatically determine the most appropriate agent based on user input.