llama-stack-mirror/docs/docs/api-deprecated/describe-an-agent-by-its-id.api.mdx

---
id: describe-an-agent-by-its-id
title: "Describe an agent by its ID."
description: "Describe an agent by its ID."
sidebar_label: "Describe an agent by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztG9tu20b2Vw740jSgZSdo0VbYFnDspHXbJIbtoFg4hjIij8SphzPMzFC2augb9n2f9jP2e/YH9hcWZy4UJVK+pbuou/aLJXLm3M+ZORddJRpNpaRBkwyvkuc7O/QvR5NpXlmuZDJMdiXsTlFaUBOwBQKjL4MkTTIlLUpLO1hVCZ4x2rH9q6FtV4nJCiwZfbLzCpNhosa/YmaTNKm0qlBb7pE6eCOet1Yaq7mcJukaJe8k/1gj8Byl5ROOGiZKL2lKFmkAlik54dMuK3vuea0doWDQWi6nZg1KegO9hpWV4HI6qphmpbmZQWM1szid02cl8e0kGZ7etMe/7QokU9LYZJhMNWI+dxKasFqsPWrz/Lo2FsYI78OC9wlYFWU4B1twA5ElaEhdkCzznBMQJg5btE2YMJgmGj/WXGOeDE89kWdpYrkVRO33DtFxAHocYa5T5pd1kYMtmAWDAjNrnGIKPi3QWKi0GrMxF9zOwapzlMAsIMsKMBarQbJIP1WuVlWjakWsyyf9UnXvbynUNLFYVqiZrXWbDFmXY9QdJHtKWq2EAc1krkqJxgCXDeAB/EBy0TBjokZ6lWlkBlvLHUrHQC+ywOPO4JsvO7jrshbM8hmuSr3QaAolcuc0ss4E1qZF0b6HaUgcBPbTDOlEVYc3mtGJqrYqeBJo+XyjPdFjNDDRqnRGZUomBFmVQR/byKAMXHBbQNbP/Xffwu9mZecdKzu/wcrOb29lDtqSAC4tTnsM7I0zBc98FQVgFRCdPA/xdancSA6zIJAZC8/uod5I3aqaf7qVms83KVcjyZjCRbPAKqflcyiVsSD4OYoQNMwgWZylSc4JfMkls0qTsIIO529YSVQFaktWVaS94VWMsDcG/Mfgfb/g3QlVj0H8MYj/14J4J0o+BvMHGsyJ7jX4ZBrr0J3SS3Y58hs3iDS6Ux/Ikl3ysi5BtkTtxUx0Z0ySQKcoKThgTm5OVGeKjJbADICg+OCXqdrnVHNVazLQsrJQidrAkkQCKZUFvMwQcwesVDmKzwy45OuSdCentnCsaazQOuWNKpRM2Pm1AePZBgMao71AlLD1fLADTObwfLAzgENluHOlEKccBv4bgsSLKIUxM5iDknBRoKWYZgucA6sqZDoKwxFtFEyYTmOwcxpu8eb0ywulcqd4Js6BjVVtA66KZ8YxbKxqx0SmNSNT4xZX0rLgsR0jeUdeAl+AwY81ygwN0a3RkbJ7eAAXXAggHFGlROek1p41b3xOoRptrSUpiJhz20hrpCIW2HZgIqLB3TytCQYtL4seduhz0HXW4mtwOSpa1F5iXFa1HZmCo8jNHUS3SBNV23vvtUqJqVZ1de2+Tm7cKO6mEC3dja1H4UxPexP0ftn3kCBrIdoEjJUSyGT7UfCs1pMu3Z7XLiOLs8WdTMExGthqWYOrz5woJb4nIf/CbbFLKxZ9S5xCMsGpTkJ6uY0qN52MUa23qt48eVt5Hj+Hg/1YTCIQ4GD4E9B9H6NQVJexinTYr9xO8GIltoF23P0O5P1Ql0xuaWQ5GwuE1jrCcEGxvqE9V2hanrWx5vUHsrhrOP/x+O0bOHZM+KoYsehYM/Dk9d6h/+wXfJ60osKfkW/PW2Dcf2lxXqJlObMPmOndhkqIzIRzdulEdw5OKzdBJfZx0nP5I7/BCZcOLtTG35V0LS0vMV5tzKA5O0ZZoXjWGwVQ1iUhZ7VVSYueNJFKdsjZ83DWKfol3leIstogcAMREigNBLxklmd03nNDrxkUXNp4MXU3F7goeFZAyebu+B8jTJQQ6gLzARxYyLFCmRu6H9GWA2msrjMngVduHZ3XGat8nsLRxHDmgA8c0ZXGjK6WydDqGqN0/OVxNFG6ZPY6IbnSfJpMaunwjiyjt9XcFkqOBDd2XV6HDvIrD3hdav4leLTObTIm3K0jq41VJWzDb6gVmEJZJ1pzHRPLmv3Nh07LHjZdGv6fLKMnNpy189EggY2BoI/JhrG04Tclhkl2A9hjEpgwCkyFGaWvzG+mEECcExAWXvLMvVstKyxFPiBMIR//3W158w0kyNi0lFQoyi6iPTt+yKDNAF7MIUgzhZ8FKxkcW5ad+6s+s1QPsku2IwC6J3ADYypPsJxVlBK2rWIAW/Bh3csGxNeHYUgUIwnANAa4BIWRlbkzyztJP6S2aPohosyECtGXwV/ihm+bnaTP78CyaT+GlrT7EfhTk+g9dEvBzKVll7C1BQxoG1lyxBak7TK7ubFYjko0hk1xNMaCzbiv0m5084qcyDl6JViG16rfNwJdzApaVzPUmuc++wvKBk9GSM6dCI7dk9eerheBrIHH/WEIu5X3ZAJSaTXjOeYRSmAmmsBdcQS2PgzhyH8ym8H4+tc1RPi8dY0wql9wmYk6SMGLGD67umrsYXlqm8XiM1fAkjk1frGVOzf6bK2mQ6AWOYU+Lg1qi/lgpWYW1HfjhWMlZvsjo6fi2uryNte52mBTAeJygnrEKS++vgz0bId2kLfenEGcNJGk1aEOUaHTqObLIN+TNPfWs7y22hu7YG+XLEVH8PF6BUjaXMcsCizR6rkrAkWWfJOfUKGk7Ghk0BhfctKGG0v1jRYB8ULbEmlQ5AaKJoJNo1GR9cVSUkAD7pZaMHeIjBEi1twXwPwsQ+v02IAlroyxOmubTJJ+cpu+fUjF5ChNppqVJdPdyLQsDbc29BWI49Hia6+xAr2KZelT7eeLdOXrw0payPzdceepd9baqDBEFlKh0iVYNYADOs7CiXO8/1Pqhcfp3mSp7wQfqnnOpOXZh+YOdY/ad1ugrevkj0ZJnygeBRo3XKC7garF5Na0doG74TMWIZX8lBb0vS0zLLm9VUaYq21O/2yRJmM5eYBW+OLNKwhMNNdbr77rbfJe9kUiWunMOrx3NqpA7/UGda+G+A0R5TFWPsbKP0KsbIzpf2+jj1HzTx01XYEyIFrDcCfSfYaxlhWsd29CukPtG41UQBv1V0ji7TfJmcUtKql28wleorGsrOh+LZe3f7hgBgL0u3HQTPGuzeCuELvOUYeuXRnoIEEwmWGY5FjRDqUjsWDtdLBIky/6Jpd9b/ZjTQUYYozLGRPc1e1KJkhMrhz4O80xG8tsvSmdbJP1w8nJIfjVkKkck6UR3ZS4vdSakjVanFKBrVDagqnJUOexKIhuja84cs+05kz6Ci2T4b3D45zVMn6L5NZj9qsJNXXoUENxbausISdmvEz2V/E39yjg3dHPgZkwX+HyU6uo6645zijn1lRV8GbvDKRpYjQVSJVltdaUnK7RdbdGvNNw1FYjvJZZOzFtEN4y6YzTS7uHBwM4UvW0EPNQEjZw9GoPvvp65yt3cuGlm3hq29cXOztLfC9YDkfexJf03NLyg+c8/6bfc3yP2OXaBl1BW0HJ5DwCNr5qOOUzuiaUcZwlxJtHp3p0qofkVM+/Waktwmuy9OBZpu1af1U1FGyGYSgrjGXRhA4IXnI7gEPhBjhd5WxKA0CCWdTxpPpy00llUM9QU02eXAmpwcQk1BIvK8yo6o9BDI+u9ehaD8i1vmyfVwdk2VSBPfbWvsQf3Gu3a/JRGPkA3tYaLLLSnUpjmlKUyhXa8+heTdbU8zO2jYAfnerRqR6WU+30YbuFCzkvIVNjNBh56tMw061g7LtvNB4eM7LxHLg1cLBPfbvlWKkrLviuUzsH5ASkYrboiGE5+9f8kHQpXhoISbvO1oySnnXnR9wkVqFyqpOgc0jCOky2Z8+2HQazfRUJWyRp4o9ZT3etSV6FtdVwe5vJ+VahqJe0JajHv2Woxz/IVOmqowazWnOaqT69SvZjlDk9o3dkd47coJL2jMDxSr1jC/Yb+knzZEhEjpfN7FlP589X49qGzNqu1cblRg5Cy9e8l7D2x+KvJFDmleLSGpdL2wK5hkxpb5s5td0obOlJ6DIzS8389zTNLJR2jtcF7sYcBM5QUy/ZU/Wayhpm8F6+l0+f/uvv//j3P/8G+y8Pj17u7Z683H/6dAg/45RlcycJj4hmZMaUvJRq5vuQk5p+aANBSmYA70I/teTTUBHQOMHg11L4Of9KGVsyuZwOvsmk14ZFm/Pgpn3BRGlibbsSjLveqDOsq2CKp16v3hiTNBk2fnKWJmRxtOTqiqbn32mxWNDjjzVqMrWzNHGRe0x2dXpFNXr6nPe3UdtkPzkKXtUet21crpfqWNyTNAPs5vyTYZKkyTnO297tinwFshy1o8m/3s0yrGxrY+cYJU9pfPX7lyfJYvEfruIRZQ==
sidebar_class_name: "get api-method"
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Describe an agent by its ID."}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/agents/{agent_id}"}
  context={"endpoint"}
>

</MethodEndpoint>

:::caution deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

:::

Describe an agent by its ID.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"agent_id","in":"path","description":"ID of the agent.","required":true,"schema":{"type":"string"}}]}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"An Agent of the agent.","content":{"application/json":{"schema":{"type":"object","properties":{"agent_id":{"type":"string","description":"Unique identifier for the agent"},"agent_config":{"description":"Configuration settings for the agent","type":"object","properties":{"sampling_params":{"type":"object","properties":{"strategy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"greedy","default":"greedy","description":"Must be \"greedy\" to identify this sampling strategy"}},"additionalProperties":false,"required":["type"],"title":"GreedySamplingStrategy","description":"Greedy sampling strategy that selects the highest probability token at each step."},{"type":"object","properties":{"type":{"type":"string","const":"top_p","default":"top_p","description":"Must be \"top_p\" to identify this sampling strategy"},"temperature":{"type":"number","description":"Controls randomness in sampling. Higher values increase randomness"},"top_p":{"type":"number","default":0.95,"description":"Cumulative probability threshold for nucleus sampling. Defaults to 0.95"}},"additionalProperties":false,"required":["type"],"title":"TopPSamplingStrategy","description":"Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p."},{"type":"object","properties":{"type":{"type":"string","const":"top_k","default":"top_k","description":"Must be \"top_k\" to identify this sampling strategy"},"top_k":{"type":"integer","description":"Number of top tokens to consider for sampling. Must be at least 1"}},"additionalProperties":false,"required":["type","top_k"],"title":"TopKSamplingStrategy","description":"Top-k sampling strategy that restricts sampling to the k most likely tokens."}],"discriminator":{"propertyName":"type","mapping":{"greedy":{"type":"object","properties":{"type":{"type":"string","const":"greedy","default":"greedy","description":"Must be \"greedy\" to identify this sampling strategy"}},"additionalProperties":false,"required":["type"],"title":"GreedySamplingStrategy","description":"Greedy sampling strategy that selects the highest probability token at each step."},"top_p":{"type":"object","properties":{"type":{"type":"string","const":"top_p","default":"top_p","description":"Must be \"top_p\" to identify this sampling strategy"},"temperature":{"type":"number","description":"Controls randomness in sampling. Higher values increase randomness"},"top_p":{"type":"number","default":0.95,"description":"Cumulative probability threshold for nucleus sampling. Defaults to 0.95"}},"additionalProperties":false,"required":["type"],"title":"TopPSamplingStrategy","description":"Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p."},"top_k":{"type":"object","properties":{"type":{"type":"string","const":"top_k","default":"top_k","description":"Must be \"top_k\" to identify this sampling strategy"},"top_k":{"type":"integer","description":"Number of top tokens to consider for sampling. Must be at least 1"}},"additionalProperties":false,"required":["type","top_k"],"title":"TopKSamplingStrategy","description":"Top-k sampling strategy that restricts sampling to the k most likely tokens."}}},"description":"The sampling strategy."},"max_tokens":{"type":"integer","default":0,"description":"The maximum number of tokens that can be generated in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length."},"repetition_penalty":{"type":"number","default":1,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics."},"stop":{"type":"array","items":{"type":"string"},"description":"Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence."}},"additionalProperties":false,"required":["strategy"],"title":"SamplingParams","description":"Sampling parameters."},"input_shields":{"type":"array","items":{"type":"string"}},"output_shields":{"type":"array","items":{"type":"string"}},"toolgroups":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"name":{"type":"string"},"args":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}}},"additionalProperties":false,"required":["name","args"],"title":"AgentToolGroupWithArgs"}],"title":"AgentTool"}},"client_tools":{"type":"array","items":{"type":"object","properties":{"toolgroup_id":{"type":"string","description":"(Optional) ID of the tool group this tool belongs to"},"name":{"type":"string","description":"Name of the tool"},"description":{"type":"string","description":"(Optional) Human-readable description of what the tool does"},"input_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) JSON Schema for tool inputs (MCP inputSchema)"},"output_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) JSON Schema for tool outputs (MCP outputSchema)"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Additional metadata about the tool"}},"additionalProperties":false,"required":["name"],"title":"ToolDef","description":"Tool definition used in runtime contexts."}},"tool_choice":{"type":"string","enum":["auto","required","none"],"title":"ToolChoice","description":"Whether tool use is required or automatic. This is a hint to the model which may not be followed. It depends on the Instruction Following capabilities of the model.","deprecated":true},"tool_prompt_format":{"type":"string","enum":["json","function_tag","python_list"],"title":"ToolPromptFormat","description":"Prompt format for calling custom / zero shot tools.","deprecated":true},"tool_config":{"type":"object","properties":{"tool_choice":{"oneOf":[{"type":"string","enum":["auto","required","none"],"title":"ToolChoice","description":"Whether tool use is required or automatic. This is a hint to the model which may not be followed. It depends on the Instruction Following capabilities of the model."},{"type":"string"}],"default":"auto","description":"(Optional) Whether tool use is automatic, required, or none. Can also specify a tool name to use a specific tool. Defaults to ToolChoice.auto."},"tool_prompt_format":{"type":"string","enum":["json","function_tag","python_list"],"description":"(Optional) Instructs the model how to format tool calls. By default, Llama Stack will attempt to use a format that is best adapted to the model. - `ToolPromptFormat.json`: The tool calls are formatted as a JSON object. - `ToolPromptFormat.function_tag`: The tool calls are enclosed in a <function=function_name> tag. - `ToolPromptFormat.python_list`: The tool calls are output as Python syntax -- a list of function calls."},"system_message_behavior":{"type":"string","enum":["append","replace"],"description":"(Optional) Config for how to override the default system prompt. - `SystemMessageBehavior.append`: Appends the provided system message to the default system prompt. - `SystemMessageBehavior.replace`: Replaces the default system prompt with the provided system message. The system message can include the string '{{function_definitions}}' to indicate where the function definitions should be inserted.","default":"append"}},"additionalProperties":false,"title":"ToolConfig","description":"Configuration for tool use."},"max_infer_iters":{"type":"integer","default":10},"model":{"type":"string","description":"The model identifier to use for the agent"},"instructions":{"type":"string","description":"The system instructions for the agent"},"name":{"type":"string","description":"Optional name for the agent, used in telemetry and identification"},"enable_session_persistence":{"type":"boolean","default":false,"description":"Optional flag indicating whether session data has to be persisted"},"response_format":{"description":"Optional response format configuration","oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"json_schema\" to identify this format type","const":"json_schema","default":"json_schema"},"json_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The JSON schema the response should conform to. In a Python SDK, this is often a `pydantic` model."}},"additionalProperties":false,"required":["type","json_schema"],"title":"JsonSchemaResponseFormat","description":"Configuration for JSON schema-guided response generation."},{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"grammar\" to identify this format type","const":"grammar","default":"grammar"},"bnf":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The BNF grammar specification the response should conform to"}},"additionalProperties":false,"required":["type","bnf"],"title":"GrammarResponseFormat","description":"Configuration for grammar-guided response generation."}],"discriminator":{"propertyName":"type","mapping":{"json_schema":{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"json_schema\" to identify this format type","const":"json_schema","default":"json_schema"},"json_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The JSON schema the response should conform to. In a Python SDK, this is often a `pydantic` model."}},"additionalProperties":false,"required":["type","json_schema"],"title":"JsonSchemaResponseFormat","description":"Configuration for JSON schema-guided response generation."},"grammar":{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"grammar\" to identify this format type","const":"grammar","default":"grammar"},"bnf":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The BNF grammar specification the response should conform to"}},"additionalProperties":false,"required":["type","bnf"],"title":"GrammarResponseFormat","description":"Configuration for grammar-guided response generation."}}},"title":"ResponseFormat"}},"additionalProperties":false,"required":["model","instructions"],"title":"AgentConfig"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the agent was created"}},"additionalProperties":false,"required":["agent_id","agent_config","created_at"],"title":"Agent","description":"An agent instance with configuration and metadata."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
>

</StatusCodes>