Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Returns a manifest of the specified agent.
cURL
curl --request GET \ --url http://localhost:8000/agents/{name}
import requests url = "http://localhost:8000/agents/{name}" response = requests.get(url) print(response.text)
const options = {method: 'GET'}; fetch('http://localhost:8000/agents/{name}', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
<?php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_PORT => "8000", CURLOPT_URL => "http://localhost:8000/agents/{name}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
package main import ( "fmt" "net/http" "io" ) func main() { url := "http://localhost:8000/agents/{name}" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) }
HttpResponse<String> response = Unirest.get("http://localhost:8000/agents/{name}") .asString();
require 'uri' require 'net/http' url = URI("http://localhost:8000/agents/{name}") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body
{ "name": "chat", "description": "Conversational agent with memory, supporting real-time search, Wikipedia lookups, and weather updates through integrated tools", "input_content_types": [ "*/*" ], "output_content_types": [ "*/*" ], "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" }, { "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 } }
{ "code": "server_error", "message": "<string>", "data": {} }
The name of the agent to retrieve. A unique identifier for the agent following the RFC 1123 DNS label naming convention.
1 - 63
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
"chat"
Agent manifests
A unique identifier for the agent following the RFC 1123 DNS label naming convention.
Human-readable description of the agent.
"Conversational agent with memory, supporting real-time search, Wikipedia lookups, and weather updates through integrated tools"
List of supported MIME content types for input Messages. Defines what formats of content the agent can consume.
1
List of supported MIME content types for output Messages. Defines what formats of content the agent can produce.
Static details about the agent, for discovery, classification, and cataloging.
Show child attributes
Real-time dynamic metrics and state provided by the system managing the agent.