llama-stack-mirror/docs/docs/api/list-all-available-api-routes-with-their-methods-and-implementing-providers.api.mdx
2025-09-23 09:48:43 -07:00

71 lines
No EOL
7.2 KiB
Text

---
id: list-all-available-api-routes-with-their-methods-and-implementing-providers
title: "List all available API routes with their methods and implementing providers."
description: "List all available API routes with their methods and implementing providers."
sidebar_label: "List all available API routes with their methods and implementing providers."
hide_title: true
hide_table_of_contents: true
api: eJztWF1v2zYU/SuEnjbAidNgRde8ZVu3BWjRIEkfhjQYaOraYkuRGkk5MQz/951LSrEcO00K9CWA/WLLvJ+H55Ail4Wn0DgbKBQny+L46Ii/SgrK6yZqZ4uT4qKzEMrZKLXVdia0nTpfS7YQcuLaKKQxQs6lNnJiSHj8ReGwGBXsRDZyWNk0RqvkNP4SOPayCKqiWvKvuGgI2dzkC6kIx8a7hnzUubJSxqGV9F4uYKQj1eFp71TOwCxEjy5gttnpVUXi9PxMkC0bp20UjYxVsRoVNcXKlU8H+Pvq6lxkYwGARKw6KDgISprrkvy/HCM8o5kuyephlvc6ROGmog8oUkAkk1HoujFUA3A86tAnRwhZlpr9pTkfQDOVJtAIJPiv1Z7Q4XWH1X3PW3XfjIqoo+ECL9j0DFTYAuJsmx82QZuigz7KtGUiUgwJ5VEH2wiG5boLNunzg06PQvGAeRv8zJwI34dC4tugVU6U2g29HLZ63qUTKUxf4YY+7qHgplZc2S+7pMeE5KoIMW5lQFtzaXQpQK1aGm6Ryh+nsRBlbIcEhARoRn43zbM1mi0TuzugnlLIO+9ZF2yMqRahcj6K0Na19AuGiRVDyea20qoSOjfttQSlWVLgUR5PeRIhALZ5buZszamNs+hNVG0t7YEnWaaJGfhslMOZtEXPVj2jy58+NpllP4tT8enifdeMQvETEm2gUkSHmYU3zUnUztOOJZWTh4aUnmolnFKt94T0D+r6HlZ3M9zP1j14A6InmB4Br98rxNS7OtUAHh8K6GJWmQWmxxh3G8TFn7+LN78evUl6pTvJYh7yC1Rf5/tNluIiU3xdzzOZ3ynn+O1u5SijeSGs4B7SiugcnO2iD8xRQYSZnhO+a9fapNSoa9qLai+qFyaq47frfFdg+gdmeqesMJTWP66FJoAQ3SmikmFjsUlsm0bXOh6Kc0MSBUWwR86wkwmDQd/vVK8f26kC+TkmH3CylAjwMLFaS3fAO+KJOhj20tpL6wVJ6/VwvzpjZqNycZnZvs7fyet0m/I9GOWh+NiCCSTrtCtNCBuPdRGAYayTV0lT2Zq4LbFvBd6Lai+qlyWqo13ZniGhpBKmmpwF7ubMMjqRq99xNHzs1CVuday4eO27g2f45sETKpFewhJPyHqzvhIoZpRExDcFJ8V4/mqsc0XjnAljeV9kv2XRem6wirE5GY+xQx9ULqDJA2NkLQ8Ajvp6qFxdrG7YDy3ruEiOf/TLwvUNjzFREgX78yn7i0v2F5cdXRKNkJ+TZ0zmr3bcebC6wgbP5JD5w8jpiqGDJXy24sEHUqb0Ct1foGRQM8zK+UydfO7nZXQqVX9vIT195lOzcT7pYjv4hI8CBkrxctZX9QHrjsn3Ag1whIgZE4uJ+vEE2IBtuV5uf3SeblGJdBfHjcHbF3eXaLPsWHad57HjGX51TAMtmE1ssFxO8Ab3yZvViv/GS6BfZN6mZXTCnAGR4IA1D4s7M+wrLVh7SlHDQXHeatPt1MPNZDVk/1/vrqDI/wF+Mx5E
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 available API routes with their methods and implementing providers."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/inspect/routes"}
context={"endpoint"}
>
</MethodEndpoint>
List all available API routes with their methods and implementing providers.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Response containing information about all available routes.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"route":{"type":"string","description":"The API endpoint path"},"method":{"type":"string","description":"HTTP method for the route"},"provider_types":{"type":"array","items":{"type":"string"},"description":"List of provider types that implement this route"}},"additionalProperties":false,"required":["route","method","provider_types"],"title":"RouteInfo","description":"Information about an API route including its path, method, and implementing providers."},"description":"List of available route information objects"}},"additionalProperties":false,"required":["data"],"title":"ListRoutesResponse","description":"Response containing a list of all available API routes."}}}},"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>