mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-12 04:00:42 +00:00
72 lines
7.2 KiB
Text
72 lines
7.2 KiB
Text
---
|
|
id: list-all-agents
|
|
title: "List all agents."
|
|
description: "List all agents."
|
|
sidebar_label: "List all agents."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWMFuGzcQ/ZUBT60hy06QoI1uauy2ARzEcBwUhW0EI+7sLhMuuRlyFQuGvqH3nvoZ/Z7+QH+hGHIlrS0lcYBeAtgXW+vhzJvH90jN3iim0HoXKKjJjXp8eCi/CgqaTRuNd2qipnCKlXEYqTjrg8dqpLR3kVyUeGxbazRK/MG7IItuVNA1NSh/xUVLaqL87B3pqEaqZd8SR5NLFhiHUciMCzVSJlITdq3GojBSCO3prTze0atSTS7WK1xnrVqO1p9n3ltCN3zkumZGPHwSIhtXDZ9kQIMHPZLl1XI5usPUeU1gTYjgS0gNQOkZYk2gO2ZyEVqsSC1HqsbwtvFMgw5X+O4m/a2mWFNKwwTIBLKwz49zNBZnlgDLmIJMgEBRanRsB+n7znZBfnN2koCi1hSCcVVOI50oaXI35SXaQCPF9KEzTIWaXOS9HDR3NVLRRCvltyS0hWQKFTlio4WkHAsrcUKsMULprfUfAyAE07SWBHSDcayWS4H5ZJd4pT+BSCHCRwxg3BytKcAzNGglARX/n5hDxNgNZWtcpIp4q9lfz89PIUeD9kXSRE/Vl3bsmFlEJcEjoaL2HCF0TYO8EOGJ3CjFfKyNrsHkptmgi3mbXf//VCeJOKK5h1Zy5Rwtpa13FTHUXYNunwmLJMTBmltwpJJxIaLT9+jyu1dtltz3ME0Czc1odDAj6AIVED0wRTY0X1nCZUFIZZz5LqbioSVtSqPB6+xCTXdwfY3E+x1e7daavIHUE02fIG8t6JJ9kzBMT1+M4cx3VW0Xa4Wf/fwcfvjx8IexkEbXKGof6uvJ4eGm3k9YwFmW+AbPPZXfO+fxs93O0dbIqVWjHCouQvQeGnSLVWLJCgiVmZMDbHzn0tkXTUMPpnow1TdmqsfPNvXOvYeXovTeWWFord99BzXOCehaExVCm5gNo1z/jYljOLWEcm3xArBC48BiJF7dVE8/dVMF4jkxkNNiJWIqRFido+uWtFyI1NPwYK0Ha31D1no6vK9eiLIdWnid1b6p39trui35FRnFGF51DJGwSbfSjMiB89GUhoqVvQoqsbNxxyTzmcQPpnow1bdlqsNd1e5hoeQSkRpWQbqZVuRiEPC3wZ7IJIvWAqYAmflbZGwoEoc0aTts8u4hx7fGFXQtk7us/dARL3YOmylMti2tSt33857smDAihTZs9/RvmW9lqqWM5j2QdPl+GUIe+2X/c2e9iDp2X1s6cdYyaZlW1SRyRyPVUKx9oSaqonQ4YKzVRB3MHx3kcmqk8j2fSUxjuqpjbCcHB+gW+7UPkYp9a7HB/RBRvx9r3ygpFkh3bOIiLTxaHXMXV/I/EX4C2WviRNbDa1kPr3v5Z5L34WgNWqQniAROZmj+aAdpcn6EW07CobeHtdKo3rKfm4LCpYM7PyivJ2QduaL1RuhHl75AGQbtOZujkLcQwjOXqCnkpMh06UTgnpPzt5PPZNixNCfGaoXqpS/IhvGlu3R7e//8+de/f/8BR8enZ8fPp+fHR3t7EzihCvUiMZELNbiQA4ap8XMqZMYpu9gxQc9SGMObkF4/QGMqzlQwldQfLM4ukmlbH2KD6fLoFbrDU7eovtlcQrtiewFGuo4HrUXjBu95ss4u8v7h2tOiJnl8czPDQG/YLpfyOLtDZFSYIEf2Ru+fBHR/++7E+Z4WW4fFHG0nkekF29ch+byLP4NgdUpsal/JBzZSPLlppGrCgjjxkxdNtaZ2uGrrG4JkWVv/l+NztVz+ByRJdLg=
|
|
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={"List all agents."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/agents"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
List all agents.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"start_index","in":"query","description":"The index to start the pagination from.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of agents to return.","required":false,"schema":{"type":"integer"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"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>
|