GET
/
agents
/
{name}
curl --request GET \
  --url http://localhost:8333/api/v0/agents/{name}
{
  "name": "chat",
  "description": "Conversational agent with memory, supporting real-time search, Wikipedia lookups, and weather updates through integrated tools",
  "interfaces": {
    "input": "chat",
    "output": "chat",
    "awaits": [
      {
        "name": "<string>",
        "request": {},
        "response": {}
      }
    ]
  },
  "metadata": {
    "documentation": "The agent is a conversational system designed to process user messages, maintain context, and generate...",
    "license": "Apache-2.0",
    "programmingLanguage": "Python",
    "naturalLanguages": [
      "en"
    ],
    "framework": "BeeAI",
    "useCases": [
      "Conversational AI – Handles multi-turn conversations with memory."
    ],
    "examples": [
      "<any>"
    ],
    "tags": [
      "Chat"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "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.git"
      }
    ],
    "dependencies": [
      {
        "type": "tool",
        "name": "weather"
      }
    ],
    "recommendedModels": [
      "llama3.3:70b-instruct-fp16"
    ]
  },
  "status": {
    "avgRunTokens": 123,
    "avgRunTimeSeconds": 123,
    "successRate": 50
  }
}

This is an Alpha version still in active development; its structure, interfaces, and functionality are changing frequently as the design evolves. Join the GitHub discussions to help shape it.

Response

200
application/json
Successful operation
​
name
string
required

Name of the agent

Example:

"chat"

​
description
string
required

Short description of the agent. This field might be consumed and interpreted by large language models (LLMs).

Example:

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

​
interfaces
object
required

Description of agent interfaces

​
metadata
object

Optional data to support agent discovery and cataloguing.

​
status
object

Runtime metrics and statistics provided by the platform.