llama-stack-mirror/docs/docs/api-deprecated/list-chat-completions.api.mdx

---
id: list-chat-completions
title: "List chat completions."
description: "List chat completions."
sidebar_label: "List chat completions."
hide_title: true
hide_table_of_contents: true
api: eJztHVty3LjxKij+xHbGI3mzW5vVnyLZiVKyrZKl2kpZLhWG7BliDQJcAJQ05Zoz5D9fOUbOkwvkCqkGCBKc4bw03lrJwn6sZBJodDf6hUaz9SVRoEspNOjk4Evy3f4+/shAp4qVhkmRHCSH5JRp874EcXhylFNzJIuSA748r+cOk0GSSmFAGJxOy5KzlOKIvV80wviS6DSHguJvZlpCcpDI0S+QmmSQlEqWoAxzGGTUhKOoUnSaDBJmoNDrZ7MsGKONYmKSDObIuciBnBwTOSYmB5Lm1JC0oSiZDZI0lywFfX8sCtCaTgB/lQLej5ODj+umKMmhD/VUCm2Sg6TSoCwlY1rxzoOQtLeVNmQE5Mq+vkqIkYRlIAwbT4nJmSZUE0rwJfFIzjpbt4BvjclssJwZm9Lo3i6n0cCd6dDYPOinEV8voRFfEU/WbOAgbSQZ4UwvIw2rZoOEZhnD4ZSfBcSNKdcwSBT8WjEFWXLw0S1Vr/xpkBhmcIeTPjU6csudUWUu4A5/0mIRuRCxkipDxlIRB+4lCjA1bMQXBNojr4fhHt5zh1hBJ3BdKd7Zpu7T/r1qxizZMPs+3LEW6II9OrFjL89PiS4hZePa1BAqMlIqmYLWTExIBoYyrnEPVhJdr7FaNHC1WhocqkiESHmVAWGiKyU4F5deD/XZ+9LJ0nNyCjfAcQk3126uW6klaUiOqHD85PL2KhmQqyRnkxx/k4pcJbQy8irZTk6R/AX5tCy+PD+9l8i3W7e53NsF+wX/JBSN30vyx4xDR+jtg9nA/VzrEXDU9Zxrayyre9vnuup3ghY9yK3dmi7r3zAObyzS99hSS+XCbjpwnwZJxnDDCiaokQoxramfvrOYeygFLUvEHEnpGuToMR6ox+ja4eg9ovd4it5jQysfnci9nQjC23Cz3T7PrN9ZMMb9dnhAbnOW5iSlotE7a7ZR6aXJ7XEoYxR51c+nFbqHy+Ikv2Z4urICx1JWUmGG2zHNngjbs9kC3y41qLdulX7JP2yQGCtZtKgxtHUbKAAiA9psEj2tO73qqTZQdEQ/eNRv892ApWdY9/ornmJjJPKgI5GN1N1LDXq9ojRXyZCcjElRccNKDnMyowlV1j/esAyyAQKY2kepFCk1IKiBbGjVuxIZKD7FuOCU04KSD4amn0kqMyAFnRLKtSQ087Zkfp1nSC3cUaRrYEkfS1VQYxCgkZKTDMZM2L3Rz4dfxQp1cfgN7dAHu9AaSzSPjWU6Us+ENqpKLeUYhdhl7gwqhpVemQH/GhaIas20oaKrpN2n/ZrajFmmrh7NP2jic6nRHEVztEQsdlbsRh6X6PYgQYtynVLOd0hhM5HBXTCMCQOTnoxzgOgJTvFYWquGOPjzDWfancw2yNAHQC8F+7UCL5UMrOnsrmBJXhd5V8LamG70HT7s1ws/ZGkY4gc0mDRAFw6eAVVvwlkbHzW3Fp13gdg0iBrZ4ErVpCpAGL0V1EM/C0GVVGtvrJslLGf+/uH9O3K/U0ZXpS+k5EeUc8+0e9iONUbDr7BoKBop7uYKNjMXzc3a0J3qQ8h4o2a3xq+gh+Q1TfNQcXQbp/fjS5yg3MehL3Dk0JuVDc8UaOooEzaCCUzds8Y8PW/o/z1OHMjGrgP0D5Y4QCmXJZeo25PQiDcWtvfAvZD9WW/D3GItwzQOiVHE04wiGjHwwJvzuxXi+0TvHYFdEcyjZdnQACgoFWjc5toEKNAVt1tUawwTN7I2mL+DBcgwJYoTOhLcfdovxs2YpQahGRHzD09bVeeI7ZWLnSP+Bai/4Wn+2K+1bWqxRXJ7Xd/gBrHGO7hBtAUwa/Um1tVE2xDrauLNaLwZjXU1j+xKNNbVfMMeI9bVRO8RvUesq4l1NU+5rsZXwex8jI0FNjEkiQU2scDm/gU2QS3MztYoFttE0xSLbWKxTSy2icU2sdjm4RfbuOKYnd1+rLmJwcRjDSZizU1tN315zM7WINbfRLWN9TePov5mthAxXbSS0y5hww6X9hZM59cKaN3cZ71ourEtGKKNLEvIyAQEKGrqhPqmJyEEycIjkOvZgyC4nJRKjvTKMwHO53KCeZIRHTHOcMOCEOEzCD1/g7TuxBDYn3vaGFy2955hNDUb9SPy7Jq1fAjeiqoYgXKxVHkd8ulh47uV5bI4tdB6vG15Kidn+K7XhMpyTjCmViyoEwqnDBuql++NNduJgrnd6iHoM4hVJH11ctaYzm31aob0jytN+cMXxag6UXUekupsm+pBJ3nq+bEVb1sv2PX+3mf3hInWIy+GLs5Vfx3++cyOb9k3G3iNWxGrI/xh0PIvDNv73s1LhVuBIHh/AX7LOHeB/RwArPsYJKkCvOvaMLC5FOyOGFaANrQocc81pFJkmtzmIPq6FpJbqolfZDZIXKS2UWDmojGD8BBIpSHDU0kdlsGyHomVb3A4n8ND1bAvCRPuEs7n8CykkLOrTaS7Ybx2gr8B595Zk+fSfKGuODjugOgX3x1qlxtGGso3B3qBwz1Ay/FnDkvyxwDwc4Tc4cK1T16v9S8pTXPIdiBTgVEMbiBzemrh7ZZZvrTHGUuOlRJ93GTi+2SoJtVKTs2cdgcc/AUtsHI37N3qzVnn7BoTkx24Z/cUMW+AkWfy1Z78k1M3/fwrsDLMUG/HTlmZstqCndu4ia7W9uncnLasSS9c+hCRibIy1z4hsCpAii1XY9rqwaSt4qchsbj3iRb3xqre+GlI9Bjx05DoPaL3iJ+GPDwnEj8NecifhsQvQmIk8hhKLuIXId/qFyHxK5Bojh6dOYpfgcSvQOJXIPErkPgVSGy5Gj//iFFE/PwjtlyNqvotqWr85CO2XI11NU/dNsS6mngz+kRvRuOVaKyriR4j1tVE7xG9R6yreXhOJNbVPOS6mthyNYYkDyUkiQU2T7rAJrZcjabpUZumWGwTi21isU0stonFNrHlaqy5icFErLmJLVej2n7jahvrb75Wy9UuGp3Vt+t754xd3QJt0OqT7wjmG4ItdNFZFLQG15+ZyU9w9Fs/eEXztS6Vbn1NbpnJkVEMGYQdh4oAVE71dSFVKCYjKTnQxePKzznYFBT+D2w2CycGK2pCbyjjFFk+gqkUmdNsfyYbM6XNRjHMyXFznsA5IVX2nBcA5XRrmDhlFcj1revsyNDmNQ/6bR6+XmrS8WUQ720jcfbqJtjEgMctZxqCAjFDmemzaecejXla/AundogyOuK1qmbtF5L0/f7+4lHVhR9WF23XOyZuKGcZJusKyjGRCWH8cPAloWXJ69PR3i9112Od5lDQ9Y5MG2qqTfqI/e3i4oy40TYPm7RGYp2QvVYKg20cPMCbhFwqQ3RVFFRNvfiBHeOuj5gjWjFMtNi2lqJ+b9fZ4urWrexG49JcigkoklcFFS8V0MyqZTCng45r7YUHqnQ7j3Fo773bu7ARNL0Lfe86ZybCNoR0JLHxGaaS6/MukWlaKQUihTm8tlGHeof9bjXMCwTfsmkJ81RHxhGHw7OTITmX1STn2HWUc3mryfmbI/Ljn/d/tGFjnXoP5ev7/f12vb/QjJw7EW/x2VDya8357qd+zUk5wwAgp5pgYIxRMCmomHrAtqccJRN2A4LQQlZ1tMAKiEoVleqRKdV3P7XrXUhJ3qKk15qlQ9X6h6xITm+AwF0KkCHbUNmwiSpnBTNDcsaBaiBGTQmdUCYIpwaU91Q/LPNUGtQNKAIiRVUCBRkKViXgroTUQFYzN6pWVK1HpVo/hP7qBCVbUE4+OGlv16/V63BR5D0zsiF5XyligBbWK40ABBHSZiEzr15NzDyvYqsAR6WKSvW4lGq/b7UNVMhqCYoanWik5kSMwXIkWcgC2XP/4nlrkJSYuwADSttEoMsCJXRsrJgznPtrBWram0mbPybPJRXcllZK4EIt2+t9WNDC9mKuwcM64fV4FPSOFVVBRNPUeZ7UbXEJ/lRDg0ybkFmNjOvOLsmYcQOKjKb3Jl+qbJNtsMNwRY3Go6f7uyaj6YGtG0mvEldti1CwLunYmVjLoObpNvgOEhBVgeJHdVqj10lS1TR00f6AmDq8bbdwOmG2zqlzQemSmaWC1HXiN6qCQVKAyWWWHCQTsCabmjw5SPZuXu3JEgRl+BvSvxfQnwwSF5E5KbdV00luTHmwt0fF9GUutYHsJceiqpcai6rw7wHYjws0pJViZmonHnuH9PETvkMTZTniMyVBUdaHzu3sS3LcEIJGAjFCdBw3bl717Ctaet2xeTS0wuFa9k8B1BVk+kqQuf8o0WCPcyCyUjK8Jqc234ZpvlQqx/O6DsqAGtMUtANKFVzhpSqXytroReAjPJZyuAGFiVaH1VvbMX14Ja7Eixf//de///eff5Lj12fnr48OL14fv3hxQE5hQtOp5YRbCMvXRnjOLSR2sGeCjCtTKSA1l/SQXKKhxUMvmyha52Zrg0ek4FNrXkupTUFFW5uw3PR1GB78LajlM2rJx4T/Xskpc39WwZXgOzn86PbSSSLu8Sub5qWm01fdZnFR5nDCly8jquFS8dkMHzs1R2HLmEYX3KrgUoS3tcW9dHyGaWD5byivcIy9DNoOk22t8QpsvP3fBZtec7xiTW/md1jztzDIKzD2bqLF+BP+QzFE2dqqQZIDxUEoV27SYZpCGfJ2IVJGKI2x/evri2Q2+z8iW1MT
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 chat completions."}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/openai/v1/chat/completions"}
  context={"endpoint"}
>

</MethodEndpoint>

:::caution deprecated

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

:::

List chat completions.

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

<ParamsDetails
  parameters={[{"name":"after","in":"query","description":"The ID of the last chat completion to return.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of chat completions to return.","required":false,"schema":{"type":"integer"}},{"name":"model","in":"query","description":"The model to filter by.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The order to sort the chat completions by: \"asc\" or \"desc\". Defaults to \"desc\".","required":false,"schema":{"type":"string","enum":["asc","desc"],"title":"Order","description":"Sort order for paginated responses."}}]}
>

</ParamsDetails>

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

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"A ListOpenAIChatCompletionResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the chat completion"},"choices":{"type":"array","items":{"type":"object","properties":{"message":{"oneOf":[{"type":"object","properties":{"role":{"type":"string","const":"user","default":"user","description":"Must be \"user\" to identify this as a user message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}],"discriminator":{"propertyName":"type","mapping":{"text":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},"image_url":{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},"file":{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}}},"title":"OpenAIChatCompletionContentPartParam"}}],"description":"The content of the message, which can include text and other media"},"name":{"type":"string","description":"(Optional) The name of the user message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIUserMessageParam","description":"A message from the user in an OpenAI-compatible chat completion request."},{"type":"object","properties":{"role":{"type":"string","const":"system","default":"system","description":"Must be \"system\" to identify this as a system message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the \"system prompt\". If multiple system messages are provided, they are concatenated. The underlying Llama Stack code may also add other system messages (for example, for formatting tool definitions)."},"name":{"type":"string","description":"(Optional) The name of the system message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAISystemMessageParam","description":"A system message providing instructions or context to the model."},{"type":"object","properties":{"role":{"type":"string","const":"assistant","default":"assistant","description":"Must be \"assistant\" to identify this as the model's response"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the model's response"},"name":{"type":"string","description":"(Optional) The name of the assistant message participant."},"tool_calls":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"(Optional) Index of the tool call in the list"},"id":{"type":"string","description":"(Optional) Unique identifier for the tool call"},"type":{"type":"string","const":"function","default":"function","description":"Must be \"function\" to identify this as a function call"},"function":{"description":"(Optional) Function call details","type":"object","properties":{"name":{"type":"string","description":"(Optional) Name of the function to call"},"arguments":{"type":"string","description":"(Optional) Arguments to pass to the function as a JSON string"}},"additionalProperties":false,"title":"OpenAIChatCompletionToolCallFunction"}},"additionalProperties":false,"required":["type"],"title":"OpenAIChatCompletionToolCall","description":"Tool call specification for OpenAI-compatible chat completion responses."},"description":"List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object."}},"additionalProperties":false,"required":["role"],"title":"OpenAIAssistantMessageParam","description":"A message containing the model's (assistant) response in an OpenAI-compatible chat completion request."},{"type":"object","properties":{"role":{"type":"string","const":"tool","default":"tool","description":"Must be \"tool\" to identify this as a tool response"},"tool_call_id":{"type":"string","description":"Unique identifier for the tool call this response is for"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The response content from the tool"}},"additionalProperties":false,"required":["role","tool_call_id","content"],"title":"OpenAIToolMessageParam","description":"A message representing the result of a tool invocation in an OpenAI-compatible chat completion request."},{"type":"object","properties":{"role":{"type":"string","const":"developer","default":"developer","description":"Must be \"developer\" to identify this as a developer message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the developer message"},"name":{"type":"string","description":"(Optional) The name of the developer message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIDeveloperMessageParam","description":"A message from the developer in an OpenAI-compatible chat completion request."}],"discriminator":{"propertyName":"role","mapping":{"user":{"type":"object","properties":{"role":{"type":"string","const":"user","default":"user","description":"Must be \"user\" to identify this as a user message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}],"discriminator":{"propertyName":"type","mapping":{"text":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},"image_url":{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},"file":{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}}},"title":"OpenAIChatCompletionContentPartParam"}}],"description":"The content of the message, which can include text and other media"},"name":{"type":"string","description":"(Optional) The name of the user message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIUserMessageParam","description":"A message from the user in an OpenAI-compatible chat completion request."},"system":{"type":"object","properties":{"role":{"type":"string","const":"system","default":"system","description":"Must be \"system\" to identify this as a system message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the \"system prompt\". If multiple system messages are provided, they are concatenated. The underlying Llama Stack code may also add other system messages (for example, for formatting tool definitions)."},"name":{"type":"string","description":"(Optional) The name of the system message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAISystemMessageParam","description":"A system message providing instructions or context to the model."},"assistant":{"type":"object","properties":{"role":{"type":"string","const":"assistant","default":"assistant","description":"Must be \"assistant\" to identify this as the model's response"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the model's response"},"name":{"type":"string","description":"(Optional) The name of the assistant message participant."},"tool_calls":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"(Optional) Index of the tool call in the list"},"id":{"type":"string","description":"(Optional) Unique identifier for the tool call"},"type":{"type":"string","const":"function","default":"function","description":"Must be \"function\" to identify this as a function call"},"function":{"description":"(Optional) Function call details","type":"object","properties":{"name":{"type":"string","description":"(Optional) Name of the function to call"},"arguments":{"type":"string","description":"(Optional) Arguments to pass to the function as a JSON string"}},"additionalProperties":false,"title":"OpenAIChatCompletionToolCallFunction"}},"additionalProperties":false,"required":["type"],"title":"OpenAIChatCompletionToolCall","description":"Tool call specification for OpenAI-compatible chat completion responses."},"description":"List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object."}},"additionalProperties":false,"required":["role"],"title":"OpenAIAssistantMessageParam","description":"A message containing the model's (assistant) response in an OpenAI-compatible chat completion request."},"tool":{"type":"object","properties":{"role":{"type":"string","const":"tool","default":"tool","description":"Must be \"tool\" to identify this as a tool response"},"tool_call_id":{"type":"string","description":"Unique identifier for the tool call this response is for"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The response content from the tool"}},"additionalProperties":false,"required":["role","tool_call_id","content"],"title":"OpenAIToolMessageParam","description":"A message representing the result of a tool invocation in an OpenAI-compatible chat completion request."},"developer":{"type":"object","properties":{"role":{"type":"string","const":"developer","default":"developer","description":"Must be \"developer\" to identify this as a developer message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the developer message"},"name":{"type":"string","description":"(Optional) The name of the developer message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIDeveloperMessageParam","description":"A message from the developer in an OpenAI-compatible chat completion request."}}},"description":"The message from the model"},"finish_reason":{"type":"string","description":"The reason the model stopped generating"},"index":{"type":"integer","description":"The index of the choice"},"logprobs":{"description":"(Optional) The log probabilities for the tokens in the message","type":"object","properties":{"content":{"type":"array","items":{"type":"object","properties":{"token":{"type":"string"},"bytes":{"type":"array","items":{"type":"integer"}},"logprob":{"type":"number"},"top_logprobs":{"type":"array","items":{"type":"object","properties":{"token":{"type":"string"},"bytes":{"type":"array","items":{"type":"integer"}},"logprob":{"type":"number"}},"additionalProperties":false,"required":["token","logprob"],"title":"OpenAITopLogProb","description":"The top log probability for a token from an OpenAI-compatible chat completion response."}}},"additionalProperties":false,"required":["token","logprob","top_logprobs"],"title":"OpenAITokenLogProb","description":"The log probability for a token from an OpenAI-compatible chat completion response."},"description":"(Optional) The log probabilities for the tokens in the message"},"refusal":{"type":"array","items":{"type":"object","properties":{"token":{"type":"string"},"bytes":{"type":"array","items":{"type":"integer"}},"logprob":{"type":"number"},"top_logprobs":{"type":"array","items":{"type":"object","properties":{"token":{"type":"string"},"bytes":{"type":"array","items":{"type":"integer"}},"logprob":{"type":"number"}},"additionalProperties":false,"required":["token","logprob"],"title":"OpenAITopLogProb","description":"The top log probability for a token from an OpenAI-compatible chat completion response."}}},"additionalProperties":false,"required":["token","logprob","top_logprobs"],"title":"OpenAITokenLogProb","description":"The log probability for a token from an OpenAI-compatible chat completion response."},"description":"(Optional) The log probabilities for the tokens in the message"}},"additionalProperties":false,"title":"OpenAIChoiceLogprobs"}},"additionalProperties":false,"required":["message","finish_reason","index"],"title":"OpenAIChoice","description":"A choice from an OpenAI-compatible chat completion response."},"description":"List of choices"},"object":{"type":"string","const":"chat.completion","default":"chat.completion","description":"The object type, which will be \"chat.completion\""},"created":{"type":"integer","description":"The Unix timestamp in seconds when the chat completion was created"},"model":{"type":"string","description":"The model that was used to generate the chat completion"},"usage":{"description":"Token usage information for the completion","type":"object","properties":{"prompt_tokens":{"type":"integer","description":"Number of tokens in the prompt"},"completion_tokens":{"type":"integer","description":"Number of tokens in the completion"},"total_tokens":{"type":"integer","description":"Total tokens used (prompt + completion)"},"prompt_tokens_details":{"type":"object","properties":{"cached_tokens":{"type":"integer","description":"Number of tokens retrieved from cache"}},"additionalProperties":false,"title":"OpenAIChatCompletionUsagePromptTokensDetails","description":"Token details for prompt tokens in OpenAI chat completion usage."},"completion_tokens_details":{"type":"object","properties":{"reasoning_tokens":{"type":"integer","description":"Number of tokens used for reasoning (o1/o3 models)"}},"additionalProperties":false,"title":"OpenAIChatCompletionUsageCompletionTokensDetails","description":"Token details for output tokens in OpenAI chat completion usage."}},"additionalProperties":false,"required":["prompt_tokens","completion_tokens","total_tokens"],"title":"OpenAIChatCompletionUsage"},"input_messages":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"role":{"type":"string","const":"user","default":"user","description":"Must be \"user\" to identify this as a user message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}],"discriminator":{"propertyName":"type","mapping":{"text":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},"image_url":{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},"file":{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}}},"title":"OpenAIChatCompletionContentPartParam"}}],"description":"The content of the message, which can include text and other media"},"name":{"type":"string","description":"(Optional) The name of the user message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIUserMessageParam","description":"A message from the user in an OpenAI-compatible chat completion request."},{"type":"object","properties":{"role":{"type":"string","const":"system","default":"system","description":"Must be \"system\" to identify this as a system message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the \"system prompt\". If multiple system messages are provided, they are concatenated. The underlying Llama Stack code may also add other system messages (for example, for formatting tool definitions)."},"name":{"type":"string","description":"(Optional) The name of the system message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAISystemMessageParam","description":"A system message providing instructions or context to the model."},{"type":"object","properties":{"role":{"type":"string","const":"assistant","default":"assistant","description":"Must be \"assistant\" to identify this as the model's response"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the model's response"},"name":{"type":"string","description":"(Optional) The name of the assistant message participant."},"tool_calls":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"(Optional) Index of the tool call in the list"},"id":{"type":"string","description":"(Optional) Unique identifier for the tool call"},"type":{"type":"string","const":"function","default":"function","description":"Must be \"function\" to identify this as a function call"},"function":{"description":"(Optional) Function call details","type":"object","properties":{"name":{"type":"string","description":"(Optional) Name of the function to call"},"arguments":{"type":"string","description":"(Optional) Arguments to pass to the function as a JSON string"}},"additionalProperties":false,"title":"OpenAIChatCompletionToolCallFunction"}},"additionalProperties":false,"required":["type"],"title":"OpenAIChatCompletionToolCall","description":"Tool call specification for OpenAI-compatible chat completion responses."},"description":"List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object."}},"additionalProperties":false,"required":["role"],"title":"OpenAIAssistantMessageParam","description":"A message containing the model's (assistant) response in an OpenAI-compatible chat completion request."},{"type":"object","properties":{"role":{"type":"string","const":"tool","default":"tool","description":"Must be \"tool\" to identify this as a tool response"},"tool_call_id":{"type":"string","description":"Unique identifier for the tool call this response is for"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The response content from the tool"}},"additionalProperties":false,"required":["role","tool_call_id","content"],"title":"OpenAIToolMessageParam","description":"A message representing the result of a tool invocation in an OpenAI-compatible chat completion request."},{"type":"object","properties":{"role":{"type":"string","const":"developer","default":"developer","description":"Must be \"developer\" to identify this as a developer message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the developer message"},"name":{"type":"string","description":"(Optional) The name of the developer message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIDeveloperMessageParam","description":"A message from the developer in an OpenAI-compatible chat completion request."}],"discriminator":{"propertyName":"role","mapping":{"user":{"type":"object","properties":{"role":{"type":"string","const":"user","default":"user","description":"Must be \"user\" to identify this as a user message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}],"discriminator":{"propertyName":"type","mapping":{"text":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."},"image_url":{"type":"object","properties":{"type":{"type":"string","const":"image_url","default":"image_url","description":"Must be \"image_url\" to identify this as image content"},"image_url":{"description":"Image URL specification and processing details","type":"object","properties":{"url":{"type":"string","description":"URL of the image to include in the message"},"detail":{"type":"string","description":"(Optional) Level of detail for image processing. Can be \"low\", \"high\", or \"auto\""}},"additionalProperties":false,"required":["url"],"title":"OpenAIImageURL"}},"additionalProperties":false,"required":["type","image_url"],"title":"OpenAIChatCompletionContentPartImageParam","description":"Image content part for OpenAI-compatible chat completion messages."},"file":{"type":"object","properties":{"type":{"type":"string","const":"file","default":"file"},"file":{"type":"object","properties":{"file_data":{"type":"string"},"file_id":{"type":"string"},"filename":{"type":"string"}},"additionalProperties":false,"title":"OpenAIFileFile"}},"additionalProperties":false,"required":["type","file"],"title":"OpenAIFile"}}},"title":"OpenAIChatCompletionContentPartParam"}}],"description":"The content of the message, which can include text and other media"},"name":{"type":"string","description":"(Optional) The name of the user message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIUserMessageParam","description":"A message from the user in an OpenAI-compatible chat completion request."},"system":{"type":"object","properties":{"role":{"type":"string","const":"system","default":"system","description":"Must be \"system\" to identify this as a system message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the \"system prompt\". If multiple system messages are provided, they are concatenated. The underlying Llama Stack code may also add other system messages (for example, for formatting tool definitions)."},"name":{"type":"string","description":"(Optional) The name of the system message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAISystemMessageParam","description":"A system message providing instructions or context to the model."},"assistant":{"type":"object","properties":{"role":{"type":"string","const":"assistant","default":"assistant","description":"Must be \"assistant\" to identify this as the model's response"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the model's response"},"name":{"type":"string","description":"(Optional) The name of the assistant message participant."},"tool_calls":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"(Optional) Index of the tool call in the list"},"id":{"type":"string","description":"(Optional) Unique identifier for the tool call"},"type":{"type":"string","const":"function","default":"function","description":"Must be \"function\" to identify this as a function call"},"function":{"description":"(Optional) Function call details","type":"object","properties":{"name":{"type":"string","description":"(Optional) Name of the function to call"},"arguments":{"type":"string","description":"(Optional) Arguments to pass to the function as a JSON string"}},"additionalProperties":false,"title":"OpenAIChatCompletionToolCallFunction"}},"additionalProperties":false,"required":["type"],"title":"OpenAIChatCompletionToolCall","description":"Tool call specification for OpenAI-compatible chat completion responses."},"description":"List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object."}},"additionalProperties":false,"required":["role"],"title":"OpenAIAssistantMessageParam","description":"A message containing the model's (assistant) response in an OpenAI-compatible chat completion request."},"tool":{"type":"object","properties":{"role":{"type":"string","const":"tool","default":"tool","description":"Must be \"tool\" to identify this as a tool response"},"tool_call_id":{"type":"string","description":"Unique identifier for the tool call this response is for"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The response content from the tool"}},"additionalProperties":false,"required":["role","tool_call_id","content"],"title":"OpenAIToolMessageParam","description":"A message representing the result of a tool invocation in an OpenAI-compatible chat completion request."},"developer":{"type":"object","properties":{"role":{"type":"string","const":"developer","default":"developer","description":"Must be \"developer\" to identify this as a developer message"},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Must be \"text\" to identify this as text content"},"text":{"type":"string","description":"The text content of the message"}},"additionalProperties":false,"required":["type","text"],"title":"OpenAIChatCompletionContentPartTextParam","description":"Text content part for OpenAI-compatible chat completion messages."}}],"description":"The content of the developer message"},"name":{"type":"string","description":"(Optional) The name of the developer message participant."}},"additionalProperties":false,"required":["role","content"],"title":"OpenAIDeveloperMessageParam","description":"A message from the developer in an OpenAI-compatible chat completion request."}}},"title":"OpenAIMessageParam"}}},"additionalProperties":false,"required":["id","choices","object","created","model","input_messages"],"title":"OpenAICompletionWithInputMessages"},"description":"List of chat completion objects with their input messages"},"has_more":{"type":"boolean","description":"Whether there are more completions available beyond this list"},"first_id":{"type":"string","description":"ID of the first completion in this list"},"last_id":{"type":"string","description":"ID of the last completion in this list"},"object":{"type":"string","const":"list","default":"list","description":"Must be \"list\" to identify this as a list response"}},"additionalProperties":false,"required":["data","has_more","first_id","last_id","object"],"title":"ListOpenAIChatCompletionResponse","description":"Response from listing OpenAI-compatible chat completions."}}}},"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>