Skip to main content
GET
/
agents
/
{name}
Agent Manifest
curl --request GET \
  --url http://localhost:8000/agents/{name}
{
  "name": "chat",
  "description": "Conversational agent with memory, supporting real-time search, Wikipedia lookups, and weather updates through integrated tools",
  "input_content_types": [
    "<string>"
  ],
  "output_content_types": [
    "<string>"
  ],
  "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": "[email protected]",
      "url": "https://example.com"
    },
    "contributors": [
      {
        "name": "John Smith",
        "email": "[email protected]",
        "url": "https://example.com"
      }
    ],
    "links": [
      {
        "type": "source-code",
        "url": "https://github.com/i-am-bee/beeai-platform.git"
      },
      {
        "type": "homepage",
        "url": "https://agentcommunicationprotocol.dev"
      }
    ],
    "dependencies": [
      {
        "type": "tool",
        "name": "weather"
      }
    ],
    "recommended_models": [
      "llama3.3:70b-instruct-fp16",
      "llama3.3"
    ]
  },
  "status": {
    "avg_run_tokens": 1,
    "avg_run_time_seconds": 1,
    "success_rate": 50
  }
}

Path Parameters

​
name
string
required

The name of the agent to retrieve. A unique identifier for the agent following the RFC 1123 DNS label naming convention.

Required string length: 1 - 63
Example:

"chat"

Response

Agent manifests

​
name
string
required

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

Required string length: 1 - 63
Example:

"chat"

​
description
string
required

Human-readable description of the agent.

Example:

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

​
input_content_types
string[]
required

List of supported MIME content types for input Messages. Defines what formats of content the agent can consume.

Minimum array length: 1
​
output_content_types
string[]
required

List of supported MIME content types for output Messages. Defines what formats of content the agent can produce.

Minimum array length: 1
​
metadata
object

Static details about the agent, for discovery, classification, and cataloging.

​
status
object

Real-time dynamic metrics and state provided by the system managing the agent.