llama-stack-mirror/docs/docs/api/generate-a-completion-for-the-given-content-using-the-specified-model.api.mdx

---
id: generate-a-completion-for-the-given-content-using-the-specified-model
title: "Generate a completion for the given content using the specified model."
description: "Generate a completion for the given content using the specified model."
sidebar_label: "Generate a completion for the given content using the specified model."
hide_title: true
hide_table_of_contents: true
api: eJztXGtv2zgW/SuEv2wLJE5atDvbLGaB9J2ZPoI4/bBoggwt0TYnlKghqaTewP99772kLNqSH3nMYFqoaJtYou6L5x6SV6RvekbYQudW2N7BTe/p/j7+SIVNjCyc1HnvoHc0YtYZwbOf33JlxQ4zwpUmt4yzVzorlMB2J0EMu5ZuwtxEsFGpFEvmDfqslnNqylhMzgaDN0xcidyFFkyPWmQP6N6rSZlf9ns7vUTnDh5Bg3lRKJlwbLz3u0Wrb3o2mYiM429uWgjwQw9/F4mDBwujC2Gc9D5nwhmZ2KghN4ZPoZ10IrPbCojagQ8yH0O7xTieQlByngl0DgMUnpvt9K64KgUK0Ln4POodfJ2LkuDiWBhoNL+Ul9kQr5y3yi8zAUIZSWwqKnPpNhv66DP9xtVjhjLxIRSVCW5LIzLsppE2kWivrjcDDTxNpX/4OArSiIADWPujlEak4GEVtcp58MZJp9Cqj3TnaN7tDfsOF9QymSeqTEUKv7DD4yM2R3QfXV7p2gdpg1vU/4xbqxPJHQiaYzgWh8IiyG3u67HIhSF5dRYwJ745lGSdLi4AzgGsy9IEdCRGSeTphR5dYKLQVfqUCWv5GOOiS0e39aXIba+BiBOSz64n08oYNAFVF9AJYIXSY8Dy8B7gryRcDKfejLZH2kHRQPSy+a9lQk+ZKcsgwyEyzHsKP7B7pGGgnqF+PpRKkthbgbBpfYTDU7zwQY+PKULLxn1Y1kw5Ufe5t7QFghUCm7a3SridQxVAFwEWOdVk1YZncyofGZ0ByUfoRVXCuj4ZhVDeI9be9azdsW7Hun8G66ZCOb45gJ/ENQv4j7LIgqGCKQ5qE5o5QHSlZQnMOobQVzn8MyzTRsQZ+5ew85wIzDqa3mFyVKWg6Dj7B+RsD++1HB3NfFvyknCNScXD9HlxylGlErI2GvasbZKPlBPYnV1zC1kNaS5TSg6uwEkQ+nBzbuu4K2M4VYy77Nz709Nj5luDSyklQAjTJjp4YwzSJTbewchMtIHlRZlliM3A0YLaXE9kMmHSO20kD0wLDOHvkx7ChONSbavZt0bVSufgG5uUGc93oX9SPlSCRc8smIOaZA4+A2/datQ4ZF9OPgRnAr2VljCJSy0jYaj2RCdz7E/PMnwILEXKbSESOQJ+10lSGiOQNhftug2oQw9XvTUPXgRzCtOK4JmFOUgYFPrsRJfjiZpC9yilry07efuK/fSv/Z8oZcU3jpiP8QVQr/W95Ck78RCv7dkS+SFznr5oz5xESRx1JvC4xV+c1vBwPq0Eo1QAwljCbInxTJc5DYJOZqJLqi6pvrOkevoiHnA1+4hID5ll49T6ry4hJyBC4lsiBE4WUSmOlEzJTLo+O1Yw94GpF6CHjzkkiYKbphqpnq8aqawwV9D5EE5MJQHhQWCVufgG8cZxWIQwdKnVpdZ3lFrP4/HqCJGNk86BR3utP6TXYRPyVTDSPvtcAhKwloqj0lDAwJNrBwGDeyG9UjHipXLNFFsnuEuqLqm+r6Tab9O2RQpRliDU+NiiNy+5SyZH+Uj4sDyCZRoubwda54+bq/t3YU24WECrKjh+JlhVK0pL6+Q6/mBLBkBX+Jqj4AZWdEAFaMS5DzAMtC91OkUvH+otCKq7kOl2BTWZgkq008yrXfg8ogzQ1qcClr+SlTCtHuIMeyytH6mpzvNB8YyzgePJJeQYDN9X0CGUEleSk8Q9EmBhkE8LDdTQXyrAN6p2wV4s2jXurfDa3216DGpgkQCMlPlKzpwpoyuLVQ/8BHDgLlBFFZeqi7E002eH6ppPLTvzYs56lOYkcWMHlUa1EDVle1BFgnDZknLH6QbMp+hNHCU6NsM7B9Ru7wbVzf49hOnXP5/t3OCdWZ990oBYN4HW+DzMrlTqZ3BK5GPoNpq2WYTlJmvldkhCNf42o172BSM/TxRWlya5ZYUTNUf8AvKJtXl7BTF0zxuYSKZ45aDnA9Kw1V+mGScVPSnWFGhc8wXkbbJz6b0qyeD4HnVJegiIH37Ig9tEgHyscBWFgvS98g4fARxbKknerRizcQ38jklEr7ziHJpfuFcKoRSfQSRvM9qgVSXrTgElNXGtET6vD6eLVIZo4jgRe4p2h3BOPwHPY3i8ulA+xQZbUkTHZh2bdWy2gc2W2aIjtfuT2my2tGpVArIsjeVEw0jjbVU3W+v4reO3brb29yO2brbWsVnHZt1s7YcitW1ma7PzdW1as6lSAhk0XlX79JursEIL4bmgyqZtMktUzj6eFz9RLqowWvlKaZCCgAVV4+lmYqharnin2CbwoaamYyNEOl2AYHQpNuVjKJiehQZnPfQ8FFyn4Lq0TVPvAKaog9+RokEQOqhkNira1Kyp3HO2FQoCY6lvJnI8we0U9U6pqd8ZxaCh4MkEnhVF/yFmK7q4KBYze36lPap0f8ugYsJlBUK5NLEZYfPbspJXHp6WGZ6nOsuFpX0fleA+e49xMX4DJd5KDL39rpuTSnKgVVnwcb//4nlDd5mVijsJw+VC1Ccwkk00jKT45iEvEyVKG1n02suk7EKx9wPSqS6ON8IIGu0W7FGw5fFKPNF7HFu/+7EZVwpRZYXfPOO3FdLbhKTd+//8zB4MZZcNlDW34i2i7HJ7lJG0zS9CPxEUvPNFtK8S7QQ1hjq57tzKHIgmbrNw7MndBh2ybrGbf92qmy9XdS6AErf/uigeYeJ1yTINlip5KdS03pB5p4l4YNh7zx468m4n7wZVdSTekfifRuINluzI/Dsl83gB0lA9Qwr/Vh2aaA9jlUJtyxB4WGZlxvIovD60aGvYElNv2A9livicKkrxhJdUG3WnujQIyqwAXlSQfLWJKDLXLmxxrPdC/MP6FdE3F+oXhGEjCtCCei4KAZ3mpmtJ4skK0AyFu8YdXbtP+/u0fQJ+9tmxtpLSJ3ATaZD/EywX11UUcLWfMjptIhzyGPw3ZTBmCm6qYJDRVrMRNzsVwVUbVCrfqE/lRGvaWuS4ugy7iLyuQib1SZrIxVUnVeZ7N5b8/YKZwZ4BXfxR4q4bi3bjWZ1wTOhaKkUnZeYnZ8DOUWm8ax5wzO/wxlM62EHoHD2GvYZdxIPbJKZS1L/tTqcA3/MmtI/9Mpd6329ouvBVsbUr33fwUAZ9Uu3I4vP9Q+NSYqHmEegsExzU0scsFb6I9BBr1up0E24hugj7h3ZgQkP2NDc61TwZPdDGlqEUGIioouNFLTUpx9chdPHHliFg1WmlRizyUql4RTDUGug0bzvqt9NE5xKOmyuL2XkDwoi+XwafPzFvfVVe9DvbYFjHMicEA6MDMeuzIzwpcDx1E+juwetfd3zw4K8eOZyEsd+Kacohrslv1SaxuwwEcUAj0P4Clwd0tTp79NZjtWWeNJLj0tS4jJzcDRid+1mfa7vPeuzOyAxNtkdlJXNxzu+vQbCH+eg7ROHLT2/ZuJVW1mPyTvjCEC0sU0jvrUEV7F0PqDutDjcwSseVHVf+HbhyDqa/HqMda/7QrBkvw5Y00MS9+kqHpWivOXxwNGL+q33qF0Dt3+0TR26xfkFfMdRfcc59FfDXrLhXLRXf62t/QjOsix5h2Ki6VdAqSuePw5kJWDa0H/vegkvWRWq+1X9nxalyssYvRCub/MJlWC9nbsln813+9U76CG3xuXN/TJYwUguABYfA9TmsHDV87IFZ1BvcTeDT3tWTPVkdj9irV9TQwp/Xs5TMtJmgN3GuONjbgx7YnYAUke4qPBGwa/FEQB8eplHdiqQ0EhfJ8ODrqjO/nuM9pLOT+izEm/rgR32WofGyPb7U8h4yfkMYwBQqvUtlif32pfyTasH7tVJz3r7sC8IXKXlx3J5FSYiBX8oIj/n9GR0UGmm6FvoxPlsxiBkLdGA3eDRePWl5jetHz/gkkCeVkLOxZKqngD1XQDH2LGdLf3hV4qvOb1gqVPivgEi08UHBNSvDfDUjjqt7EsqNOMNludKGTi41hQ+xhKiAVQzuGfBWfaTjIkQdiEtIboxJ7qd/D3YaZyFg0embh9MQoEHfrlMoLnP6Chm/A8dn2lffd/NcI3jPsw1SAzMKm93cYLnni1GzGV6GXDFTf4iIjrgNES1fEaETwVMgTMyySzENVXD8Yp9TPyyFr8ppnjDCUdQ/cZgkonBr255H1HH8eXCK4104xYTew1XDr+Ei/n/Qw0oGxZnwTtdueorn45L2LPW8TPzzf6CyyPA=
sidebar_class_name: "post 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={"Generate a completion for the given content using the specified model."}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/inference/completion"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Generate a completion for the given content using the specified model.

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

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"model_id":{"type":"string","description":"The identifier of the model to use. The model must be registered with Llama Stack and available via the /models endpoint."},"content":{"oneOf":[{"type":"string"},{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"image","default":"image","description":"Discriminator type of the content item. Always \"image\""},"image":{"type":"object","properties":{"url":{"description":"A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits.","type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL"},"data":{"type":"string","contentEncoding":"base64","description":"base64 encoded image data as string"}},"additionalProperties":false,"description":"Image as a base64 encoded string or an URL"}},"additionalProperties":false,"required":["type","image"],"title":"ImageContentItem","description":"A image content item"},{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Discriminator type of the content item. Always \"text\""},"text":{"type":"string","description":"Text content"}},"additionalProperties":false,"required":["type","text"],"title":"TextContentItem","description":"A text content item"}],"discriminator":{"propertyName":"type","mapping":{"image":{"type":"object","properties":{"type":{"type":"string","const":"image","default":"image","description":"Discriminator type of the content item. Always \"image\""},"image":{"type":"object","properties":{"url":{"description":"A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits.","type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL"},"data":{"type":"string","contentEncoding":"base64","description":"base64 encoded image data as string"}},"additionalProperties":false,"description":"Image as a base64 encoded string or an URL"}},"additionalProperties":false,"required":["type","image"],"title":"ImageContentItem","description":"A image content item"},"text":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Discriminator type of the content item. Always \"text\""},"text":{"type":"string","description":"Text content"}},"additionalProperties":false,"required":["type","text"],"title":"TextContentItem","description":"A text content item"}}},"title":"InterleavedContentItem"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"image","default":"image","description":"Discriminator type of the content item. Always \"image\""},"image":{"type":"object","properties":{"url":{"description":"A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits.","type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL"},"data":{"type":"string","contentEncoding":"base64","description":"base64 encoded image data as string"}},"additionalProperties":false,"description":"Image as a base64 encoded string or an URL"}},"additionalProperties":false,"required":["type","image"],"title":"ImageContentItem","description":"A image content item"},{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Discriminator type of the content item. Always \"text\""},"text":{"type":"string","description":"Text content"}},"additionalProperties":false,"required":["type","text"],"title":"TextContentItem","description":"A text content item"}],"discriminator":{"propertyName":"type","mapping":{"image":{"type":"object","properties":{"type":{"type":"string","const":"image","default":"image","description":"Discriminator type of the content item. Always \"image\""},"image":{"type":"object","properties":{"url":{"description":"A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits.","type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL"},"data":{"type":"string","contentEncoding":"base64","description":"base64 encoded image data as string"}},"additionalProperties":false,"description":"Image as a base64 encoded string or an URL"}},"additionalProperties":false,"required":["type","image"],"title":"ImageContentItem","description":"A image content item"},"text":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Discriminator type of the content item. Always \"text\""},"text":{"type":"string","description":"Text content"}},"additionalProperties":false,"required":["type","text"],"title":"TextContentItem","description":"A text content item"}}},"title":"InterleavedContentItem"}}],"title":"InterleavedContent","description":"The content to generate a completion for."},"sampling_params":{"description":"(Optional) Parameters to control the sampling strategy.","type":"object","properties":{"strategy":{"description":"The sampling strategy.","oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"greedy","default":"greedy","description":"Must be \"greedy\" to identify this sampling strategy"}},"additionalProperties":false,"required":["type"],"title":"GreedySamplingStrategy","description":"Greedy sampling strategy that selects the highest probability token at each step."},{"type":"object","properties":{"type":{"type":"string","const":"top_p","default":"top_p","description":"Must be \"top_p\" to identify this sampling strategy"},"temperature":{"type":"number","description":"Controls randomness in sampling. Higher values increase randomness"},"top_p":{"type":"number","default":0.95,"description":"Cumulative probability threshold for nucleus sampling. Defaults to 0.95"}},"additionalProperties":false,"required":["type"],"title":"TopPSamplingStrategy","description":"Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p."},{"type":"object","properties":{"type":{"type":"string","const":"top_k","default":"top_k","description":"Must be \"top_k\" to identify this sampling strategy"},"top_k":{"type":"integer","description":"Number of top tokens to consider for sampling. Must be at least 1"}},"additionalProperties":false,"required":["type","top_k"],"title":"TopKSamplingStrategy","description":"Top-k sampling strategy that restricts sampling to the k most likely tokens."}],"discriminator":{"propertyName":"type","mapping":{"greedy":{"type":"object","properties":{"type":{"type":"string","const":"greedy","default":"greedy","description":"Must be \"greedy\" to identify this sampling strategy"}},"additionalProperties":false,"required":["type"],"title":"GreedySamplingStrategy","description":"Greedy sampling strategy that selects the highest probability token at each step."},"top_p":{"type":"object","properties":{"type":{"type":"string","const":"top_p","default":"top_p","description":"Must be \"top_p\" to identify this sampling strategy"},"temperature":{"type":"number","description":"Controls randomness in sampling. Higher values increase randomness"},"top_p":{"type":"number","default":0.95,"description":"Cumulative probability threshold for nucleus sampling. Defaults to 0.95"}},"additionalProperties":false,"required":["type"],"title":"TopPSamplingStrategy","description":"Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p."},"top_k":{"type":"object","properties":{"type":{"type":"string","const":"top_k","default":"top_k","description":"Must be \"top_k\" to identify this sampling strategy"},"top_k":{"type":"integer","description":"Number of top tokens to consider for sampling. Must be at least 1"}},"additionalProperties":false,"required":["type","top_k"],"title":"TopKSamplingStrategy","description":"Top-k sampling strategy that restricts sampling to the k most likely tokens."}}},"title":"SamplingStrategy"},"max_tokens":{"type":"integer","default":0,"description":"The maximum number of tokens that can be generated in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length."},"repetition_penalty":{"type":"number","default":1,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics."},"stop":{"type":"array","items":{"type":"string"},"description":"Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence."}},"additionalProperties":false,"required":["strategy"],"title":"SamplingParams"},"response_format":{"description":"(Optional) Grammar specification for guided (structured) decoding.","oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"json_schema\" to identify this format type","const":"json_schema","default":"json_schema"},"json_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The JSON schema the response should conform to. In a Python SDK, this is often a `pydantic` model."}},"additionalProperties":false,"required":["type","json_schema"],"title":"JsonSchemaResponseFormat","description":"Configuration for JSON schema-guided response generation."},{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"grammar\" to identify this format type","const":"grammar","default":"grammar"},"bnf":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The BNF grammar specification the response should conform to"}},"additionalProperties":false,"required":["type","bnf"],"title":"GrammarResponseFormat","description":"Configuration for grammar-guided response generation."}],"discriminator":{"propertyName":"type","mapping":{"json_schema":{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"json_schema\" to identify this format type","const":"json_schema","default":"json_schema"},"json_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The JSON schema the response should conform to. In a Python SDK, this is often a `pydantic` model."}},"additionalProperties":false,"required":["type","json_schema"],"title":"JsonSchemaResponseFormat","description":"Configuration for JSON schema-guided response generation."},"grammar":{"type":"object","properties":{"type":{"type":"string","enum":["json_schema","grammar"],"description":"Must be \"grammar\" to identify this format type","const":"grammar","default":"grammar"},"bnf":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The BNF grammar specification the response should conform to"}},"additionalProperties":false,"required":["type","bnf"],"title":"GrammarResponseFormat","description":"Configuration for grammar-guided response generation."}}},"title":"ResponseFormat"},"stream":{"type":"boolean","description":"(Optional) If True, generate an SSE event stream of the response. Defaults to False."},"logprobs":{"type":"object","properties":{"top_k":{"type":"integer","default":0,"description":"How many tokens (for each position) to return log probabilities for."}},"additionalProperties":false,"description":"(Optional) If specified, log probabilities for each token position will be returned."}},"additionalProperties":false,"required":["model_id","content"],"title":"CompletionRequest"}}},"required":true}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"If stream=False, returns a CompletionResponse with the full completion. If stream=True, returns an SSE event stream of CompletionResponseStreamChunk.","content":{"application/json":{"schema":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","description":"The name of the metric"},"value":{"oneOf":[{"type":"integer"},{"type":"number"}],"description":"The numeric value of the metric"},"unit":{"type":"string","description":"(Optional) The unit of measurement for the metric value"}},"additionalProperties":false,"required":["metric","value"],"title":"MetricInResponse","description":"A metric value included in API responses."},"description":"(Optional) List of metrics associated with the API response"},"content":{"type":"string","description":"The generated completion text"},"stop_reason":{"type":"string","enum":["end_of_turn","end_of_message","out_of_tokens"],"description":"Reason why generation stopped"},"logprobs":{"type":"array","items":{"type":"object","properties":{"logprobs_by_token":{"type":"object","additionalProperties":{"type":"number"},"description":"Dictionary mapping tokens to their log probabilities"}},"additionalProperties":false,"required":["logprobs_by_token"],"title":"TokenLogProbs","description":"Log probabilities for generated tokens."},"description":"Optional log probabilities for generated tokens"}},"additionalProperties":false,"required":["content","stop_reason"],"title":"CompletionResponse","description":"Response from a completion request."}},"text/event-stream":{"schema":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","description":"The name of the metric"},"value":{"oneOf":[{"type":"integer"},{"type":"number"}],"description":"The numeric value of the metric"},"unit":{"type":"string","description":"(Optional) The unit of measurement for the metric value"}},"additionalProperties":false,"required":["metric","value"],"title":"MetricInResponse","description":"A metric value included in API responses."},"description":"(Optional) List of metrics associated with the API response"},"delta":{"type":"string","description":"New content generated since last chunk. This can be one or more tokens."},"stop_reason":{"type":"string","enum":["end_of_turn","end_of_message","out_of_tokens"],"description":"Optional reason why generation stopped, if complete"},"logprobs":{"type":"array","items":{"type":"object","properties":{"logprobs_by_token":{"type":"object","additionalProperties":{"type":"number"},"description":"Dictionary mapping tokens to their log probabilities"}},"additionalProperties":false,"required":["logprobs_by_token"],"title":"TokenLogProbs","description":"Log probabilities for generated tokens."},"description":"Optional log probabilities for generated tokens"}},"additionalProperties":false,"required":["delta"],"title":"CompletionResponseStreamChunk","description":"A chunk of a streamed completion response."}}}},"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>