Agent Detail

The Agent Detail describes essential properties of an agent, including its identity, capabilities, metadata, and runtime status.

Parameters

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.

metadata.annotations

object

Key-value pairs used by third-party tools and automation systems to add supplementary, non-identifying metadata to the agent object.

metadata.documentation

string

Full agent documentation in markdown.

Example:

"The agent is a conversational system designed to process user messages, maintain context, and generate..."

metadata.license

string

SPDX license ID: https://spdx.org/licenses/

Example:

"Apache-2.0"

metadata.programming_language

string

Programming language, supported values: https://docs.github.com/en/get-started/learning-about-github/github-language-support

Example:

"Python"

metadata.natural_languages

string[]

List of human-readable languages supported by the agent for conversational interactions or content generation. Use ISO 639-1 codes.

metadata.framework

string

For example BeeAI, crewAI, Autogen, AG2

Example:

"BeeAI"

metadata.capabilities

object[]

A structured list describing capabilities supported by the agent. Each capability includes a human-readable name and a brief description. This information might be consumed and interpreted by large language models (LLMs).

Example:

[
  {
    "name": "Conversational AI",
    "description": "Handles multi-turn conversations with memory."
  },
  {
    "name": "Vacation Request",
    "description": "Handles submission and tracking of vacation requests."
  }
]

metadata.domains

string[]

Domains or functional areas applicable to the agent, such as 'finance', 'healthcare', 'supply-chain', or custom-defined domains relevant to your organization or team.

Example:

["finance", "healthcare", "supply-chain"]

metadata.tags

(string | enum<string>)[]

metadata.created_at

string

Timestamp in RFC3339 format (ISO8601-compatible).

metadata.updated_at

string

Timestamp in RFC3339 format (ISO8601-compatible).

metadata.author

object

metadata.contributors

object[]

metadata.links

object[]

metadata.dependencies

object[]

Experimental: Represents a dependency required by the agent, specifying external resources or capabilities it relies upon, such as other agents, tools, or AI models.

metadata.recommended_models

string[]

Model name (ollama, OpenAI)

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.

Agent DiscoveryDiscover available agents and their capabilities

{
  "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
  }
}

Introduction

Core Concepts

How To

REST API

Python SDK

About

Parameters

Introduction

Core Concepts

How To

REST API

Python SDK

About

​Parameters

Parameters