mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-05 04:17:32 +00:00
68 lines
7.4 KiB
Text
68 lines
7.4 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: eJztWFFv2zYQ/iuEnhLAsdNgRVe/eWu3BUiRIEkxDKlRnKWzxZYiNZJyYxj+77sjJVu2lcYB9hLAAQLbEnn33d338UguE4uuNNqhS4bL5OL8nD8ydKmVpZdGJ8NkJG5gJjV4zG7rwf2kl6RGe9Sex0NZKpkCjx98czxpmbg0xwL4m1+USGbM5BumniaW1pRovYwuM/DtUWAtLGiQ9Fi4rtmQZZIdgbrZsmM0Xk+T4cN6hq6USla99e+JMQpBtx/pqpigbT9x3ko9az+JgFoPaiSr8WrV28nUfY5CSeeFmYoQgJgaKzw9TStrKVmihBmSsSQH97UwFlsRNvh2jf6dI1kIZiwKoH+eWNuHOUgFE0Uvpj4Mkk449Oyjsqplvo6sC/Ln26sAFNIUnaNR0QxHknCQ3SmfgnLYI/78W0mLGaU+1rIV3LiXeOkVu9+j0B6SkZihRitTTlIcKxpyEiDwhFEp84OCFk4WJcVMoAvwfQLJMH/pIi/HxxCRqvIDnJB6DkpmgsItQLEBgv6/kdl58FWbtpLMzohiu8H+dX9/I+JokZoscKJO1XMV+2gtk4oH9zgVubFeuKoowC6YeEw3DGN+5DLNhYxBWwnaxzLr+n3wE0jsiUWHeo6j2bUymmITeVWAPrMIWSBia84WHPYkNcWs0wOiPLkuI+VOxSgQNAaTEvgJisoRObyhytJsnDeS0JEQ7BkmpvLBuSsxlVOilUmjClPcwfUSitcVbqq1Tl6L6iFNTyRvTeipNUXAMLq57ItbU81ytVgz/PaP38W7X8/f9Tlp+AjM9ja/iOobf79BJm4jxTd4DmR+rZyL993KSZXkVYsETYsKffHG0GS9aAyzVSLCTM6RPgtT6bD2eVngUVRHUb0yUV283/i7J6Z/YqbXynJtaf1jKtIEZQgfU8SM08Zio5ZFTbOQvi9uqJVz2yL2wAxIJIpe2qZTvX2qUzm0cyo+pZOlRP0+Y2JVGh8p39wQsU7DUVpHab0iab1t96tLZjYhF3eR7Rv/tbxG+5RvkpH1xXVFTEAoQleaIDUebTwljN7V8spwCpXyHSeZnxg+iuooqtclqvMubwdIKKiEqQYzx9GM6NxF/W28C/aKT7KgFHUlOhUafeJOOWfr7R5P44uAEiwUSJp24fit6Qefm/n1V8m6kmytBJ93nj4vPzSVCFO4ouEMXXsNZ2h2symAtxUVZE+Ozdmdz+o1CEqVJRA6w8cGB3Vzu+gEEoax+zArIKpPoswlrtU2jJoYezgaubeBhG3B8xDihQTnYx19JHhl9UudUz2pKrmhwckMwzLFJRgmg/mbQUi1GyybKq0GjUMaF3chsZrhEiHJvS+HgwHth85y44hSZ0pBAWeUqfR7PzVFwu4cEsGkX4SJH5pF+GHM71iWAWbN2CueL+54vrirxRkSTf7ZeczJ/E1Hmngtc1uqhvY607Ycrg1odZ5LMvJFi50/4KsSnoc6Kw2lztG6GDZz0tKKbKNQM74R4bzaKaToolGw+EWz2IwNq9C+8QkfvBStS5aSXKP6RKu8ckHQJeWRlkzOSc2RQ/W2lY/lpmsdbKCmisdHPygV7U5bt0WRIw8x85El9GXYUvOaKFRVJgOPXi4ntN39bNVqxY8jwZkFmXTcDzaEfRL84QrshP8dF3t6p/NuxSPD7d3LkDwnxJ9gaKS+8T7mH9R6J8z8FyXl5LYW/Kl4yVLZia65z9SLNrgG9brAqzFfT1Ifp0WEwcbXozTFsh3V3gZpa7358+M9rUD/AT/nyfA=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/llama-stack-specification
|
|
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>
|
|
|
|
|
|
|
|
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>
|