GET
/
agents
curl --request GET \
  --url http://localhost:8000/agents
[
  {
    "name": "chat",
    "description": "Conversational agent with memory, supporting real-time search, Wikipedia lookups, and weather updates through integrated tools",
    "metadata": {
      "annotations": {},
      "documentation": "The agent is a conversational system designed to process user messages, maintain context, and generate...",
      "license": "Apache-2.0",
      "programming_language": "Python",
      "natural_languages": [
        "en"
      ],
      "framework": "BeeAI",
      "capabilities": [
        {
          "name": "Conversational AI",
          "description": "Handles multi-turn conversations with memory."
        },
        {
          "name": "Vacation Request",
          "description": "Handles submission and tracking of vacation requests."
        }
      ],
      "domains": [
        "finance",
        "healthcare",
        "supply-chain"
      ],
      "tags": [
        "Chat"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "author": {
        "name": "John Smith",
        "email": "jsmith@example.com",
        "url": "https://example.com"
      },
      "contributors": [
        {
          "name": "John Smith",
          "email": "jsmith@example.com",
          "url": "https://example.com"
        }
      ],
      "links": [
        {
          "type": "source-code",
          "url": "https://github.com/i-am-bee/beeai-platform.git"
        }
      ],
      "dependencies": [
        {
          "type": "tool",
          "name": "weather"
        }
      ],
      "recommended_models": [
        "llama3.3:70b-instruct-fp16"
      ]
    },
    "status": {
      "avg_run_tokens": 123,
      "avg_run_time_seconds": 123,
      "success_rate": 50
    }
  }
]

Query Parameters

​
limit
integer
default:10

Maximum number to return

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Offset to start from

Required range: x >= 0

Response

200
application/json
Successful operation
​
name
string
required

A unique identifier for the agent following the RFC 1123 DNS-label naming convention.

Example:

"chat"

​
description
string
required

A concise, human-readable description of the agent. This description may be utilized by Large Language Models (LLMs) and other AI systems to understand and interact with the agent appropriately.

Example:

"Conversational agent with memory, supporting real-time search, Wikipedia lookups, and weather updates through integrated tools"

​
metadata
object

Optional static details about the agent, aiding in discovery, classification, and cataloging.

​
status
object

Dynamic runtime information provided and regularly updated by the system managing the agent. This includes current operational metrics, performance metrics, state information, and other real-time statistics.