mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-12 04:00:42 +00:00
72 lines
7.6 KiB
Text
72 lines
7.6 KiB
Text
---
|
|
id: list-all-session-s-of-a-given-agent
|
|
title: "List all session(s) of a given agent."
|
|
description: "List all session(s) of a given agent."
|
|
sidebar_label: "List all session(s) of a given agent."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWMFuGzcQ/ZUBT4khS06QoI1uauy2ARzEUBwUhW0Eo93RLhMuuRlyFQuCvqH3nvoZ/Z7+QH+hGHJXWltKYgO9BLAvtnfJmTcz7w13uFJMvnbWk1fjlXp6dCS/cvIZ6zpoZ9VYTeAMC20xUD5tFw/VQGXOBrJB1mNdG52hrB998LJppXxWUoXyV1jWpMbKzT5QFtRA1exq4qCTyxxDfxUy41INlA5U+X27Mc+1OEJzdsOOs/RmrsYXmx22MUatB5v/Z84ZQtt/ZJtqRtx/4gNrW/SfJEC9By2S9dV6PbiVqfOSwGgfwM0hBgBzxxBKgqxhJhugxoLUeqBK9O8rx9SLsMN32+hvJYWSohkmQCaQja19XKA2ODMEOA9xkfbgKYiPhk3PfBvZPsjvpqcRKGYZea9tkcxIJEqC3J/yORpPA8X0qdFMuRpfpFr2grsaqKCDEfc7FNpBMoGCLLHOJElpLXTkhFBigLkzxn32gOB1VRsS0BWGoVqvBeazfeSV+AQi+QCf0YO2CzQ6B8dQoREDlP9/ZPYBQ9OnrbaBCuKdYH89Pz+DtBoyl0dOtKn6VsVOmIVUsnggqSgdB/BNVSEvhXhCN4prPpc6K0GnoFmjDanMtn0f/UQSB9R34ErynFaLa+NsQQxlU6E9ZMI8ErG35wYc8aStD2izO0T56E2dKPcYJpGgKZgMLcwIGk85BAdMgTUtOknYRAjxjDPXhOjc15Tpuc7AZUmFGd3CdR+KtxXuqrVJXo/qMU1fSN6G0HN2VcQwOXs1hKlritIsNwyf/vwSfvjx6IehJI2uUdje59ezo6Otv58wh2mi+BbPHZnfKufpi/3KyYyWrlWiNBUbIDgHFdplZ1isAkKhF2QBK9fY2PuCruhBVA+i+s5E9fTF1t+5c/BamN4qy/el9btroMQFAV1nRLmkTcSGQY7/SochnBlCObZ4CVigtmAwEHcn1fMvnVSeeEEMZDOREjHlQqzG0nVNmRyI1KbhQVoP0vqOpPW8f169EmZbNPA2sX3rv5XXZJfyXTLyIbxpGAJhFU+lGZEF64Kea8o7eeU0x8aEPZPMVww/iOpBVN+XqI72ebuDhKJKhGpYeIlmUpANXsDfBHsqkywaA16mQmcf+ceSs83nnmyTi4AaGSsKxD6O3xarODfL6/dadKXFWo2h3Dt9vjruKhG3SEXjDN16jTO0uNkWIHBDg105drO7zOotCB+Qw3ttc7rucHxqiJd7gcRl4j7uiojaSVS4JLW6CaMlxg6OTu59IPGz4NsQ0oWE5GMTfSJ4w/a+zmM9a6ZMJukuaRWF0uVqrAqKjUuKMlajxZNRTL4frbq6rUcdBDVQ6bsk1TdeK6gyhHo8GqFdHpbOB8oPjcEKD33A7OMwc5USAJ6yhnVYxo3HXVu+uJJ3ItQIvOXwqeyHt7If3rZyTak/hONNICIVQSRwUt4WT/akUvqdv6F87Peivq94tVCzW+ic/KWFWz8o1ymyj2xeO22DB7Txg08zZI6TmHO5NZHc8xwz8skoMl1aEaTj2Kl2jc9kODO0IMaiQ/Xa5WT88NJe2oODf/7869+//4Djk7PpycvJ+cnxwcEYTqnAbBkzkRxVuJSGyFS5BeUyk82b0DBBmyU/hHc+XpdApQtOqWCaU9sIrVnGJlM7HyqMh13L27v2gBv5X21P0jsbaOkb6DqMaoPa9m6wEksvUqUTT9VAjXsdZkPVq4ESOsrq1WqGnt6xWa/lcRKd8DDXXs6orYi+CP7uXWEv/I+03OlBCzSNrIw3ivdD8q3m8BUMXfvZer+Sf1iL+3sm5dG0bUKP4T7tey+67o7VLvvgOtSbAq+v5MqUMCeOYNPrSZZR3Y9q56NNotx0vF9OztV6/R+4sv74
|
|
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 session(s) of a given agent."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/agents/{agent_id}/sessions"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
List all session(s) of a given agent.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to list sessions for.","required":true,"schema":{"type":"string"}},{"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 sessions 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>
|