llama-stack-mirror/docs/docs/api/list-all-open-ai-responses.api.mdx

---
id: list-all-open-ai-responses
title: "List all OpenAI responses."
description: "List all OpenAI responses."
sidebar_label: "List all OpenAI responses."
hide_title: true
hide_table_of_contents: true
api: eJztXW1z2zYS/isYfUky4zhO5zq95psvSa++JrUncadzE3tUiIQktHwrQdrRZPzfb3cBkKBIiqTs5JwY/dDIIrBYLJ59wQJLfZrlQmVpooSavfg0++7oCP8JhQpymRUyTWYvZsfsjVTFaSaS45N3pvXp4k8RFIezg1mQJoVICuzGsyySAcduz/5U2PfTTAVrEXP8VGwyAdRS6gkdszzNRF5IPXLIC7cVz3O+gUayELEa7h3kghcinPPCaSuBsZXIoXFzPr8l8iMrZCxUweOMXa9Fwoq1YFYS7JorZijObg5mIs/TvC2Wx6f0iUdP2GtswUJRcBkpJpdNciuRiJykwpbQAIgeDE0nDYUzEVXkMlm15qFHxbZMhrAEcrmBZjQ2dmTpksYrc4GzgOkqvhpB9ucy5slTmH7IF5FgNHtmejPddGHHqejDADwMpRbImTOZJY+UOACU/V3KHKb+4oOeXc3QJUhDFhFy1MQYzQ9Zl+Ew17Cof5eVIKTI2RLYLtZSVQtBUoCxo2Fqb7GZS6xUIiSK9WIiObN+HfRALRQ8qNSLhljyMmp96Y6r1UovXz36AePRNd8odlH1vJjR8GWRlcUutUkTcboEoQ8qUK3FrS5mTjcHtx+mEB87pdWUwjkiGFoywxUiGdEmE5ithSLOX5PpFz51mNOgrvi3vnaHfmlG7F+BujOuwRTcmwGJ2V7QnyD5t3qKhpnzLkbPXfkgMBvCASOUME24tkPQKuZgs52F7DPGZMl2gaGWcZReuxRbz9dytd7ZgJdFOru5dBeIvtqe8RtxBToJUNDc6UnHaJSA+QDmDWQPWMATthCwTsDXxewAPiAD+AmaXxBlrTvjsEMDdICn/n4f9FBvzQZ9nJf5CKPkOJzf3r2plIJEYPV3EiDNMu8ByZPO6Z+4rEwFJQJAIrVYJrzQDtegcvMrj5EtYhNsOMQZKB9o4GjyYIzgbc+9sD0NBRoOC70l8pboC1si5Hz0+DjPfXct3RZpBCJ03Nc2Lu73KP4kSQuKVdVdxIhDXC1hbzMPpB6xwVf7SWN/WbG5A64NEhqw9NV+e4PUbtGWIhdJgLE9ELNEE3I3Q1TRKe0gJJNQfByxGz1LFekIow6WoJ0pu5awh9H70700y/hMKytngpbFXm2r1+Un6POyb/nwYc1vjTlSOysY3DCqTAQg/oBERCpY6Z6Z2pjYdAiFYMC6Qdh6MBmDLgUNQZGE87EL/ToJWWYXe3uZVcYRAc11PoDZ8bwYPcJ7bD15DLP4g4ERNuvA+7VY4DqmZR4Q7kc5EMdr9JLaA+X1cjRFZyepuRsB+F6wI+NjsA4WWOTAd2NO6i7wjSvHZSLyeb+97Wtzc+A86rKcA5DeZXR32s5BKO+z2o2pNBe/09y5HIzBgCXfsH63X0DiLePFuu0i6dsBId+lBGsxTXIFZ8TmXhu2Jh6HIyQfcviQ47OHHM3Q4Nag9BGIj0DucwTSGx7cGvk+Nvk/xyZOGHE3vvUbiFP60znHTn7kZu90ajPP0svaKeVmmskj/R3lWG9uLoGBPNWGcDjZqTaqEPHOdGaIaUqcxs5WpRpowJWSAE801ZcjclM2Re6Cxkmb96AFBihK1fFo2sGydilGjkPZxLcOp83caa6jhFCxIiUXccVzmZaKmS7koZX1ZJaeYsdnJ4fsfC02jOcCvHbESsArxH6JOZJfiICDwNvd2EpewSf4PqZ+2EBhtHdBk7iYAQtRKSAUAB8OD4G8VCxJGQQGxKTQnaB3hi4YWAtAUmAjmArAyAD7o3aftzxqL9I0YgFMYNeatuRdgryTgun21iuj21KC58GaIYOVhRvCH/Sb635zYsTFYdezRoRh2d8Rgm3RmHoQQ1bMSGYIoA2T8btYvKdhkcmXXdz/XkusWgemU8LV/Q1cqa3E9xfHBTTKGz6oN29e24etAxgwSIgTM1tDEEIeEZTm0s7twIcOZy/0kafqg1/nw6n42yaitwGwmDDGGJn2LDAvYCoLkF5n2254d/ippKQ1rv5ewIwEb6RNkjJedLqc1kFKG5bkgXrPon4Rm6dkJlk9GwbuKw0k3uWijW21vHeznSegmGDPXorSa7H/zn43TRWkuUvQiHOb4DsRiSsOmxpGHWpVNKjWBNnjhSiuhUjYEXmW508I5ONOyjtOyRvEpxlGB4B9MTLN3LA3zmhiFNi0mu+MorR2ri7neGesKPMEMLPY9BuEw7ZlctC4D8U9fIm1pvt5lbaAupMtn8uvIK09NVAjGoYuk4B2wNa/7KFxlsRCoMIhIe1FeL4qYxhxhCP5z/vTX5l+tq28Ffma3BhXYnp1+JHWk8lOxKVgjv9HLIKD7uMKpF1rslcc6FDv8cruShtvP1lpLOIMTtw1nqY5hpl+vbHc3rdg7O3Ls2ptBndzQdbGX+PLqdCznTXq7kbB7IyaCjbdDiCdWBTrNGxZAtglX4l8HvHFmPvDb7BZ61Y2ktd02Bq8bWS/t4tRXTQfrSevG5ez5bIpDXPbvOui8DBpDXYbJyzzNNYevgzwhtOyjBwcTXZaNnHiqJ518q6cx2ki8NGpgPoSN6VaIFIBtoo0AHw+hvZP7ps+RrijQUOhpu03UJuw75z6trR069E+ulqT0Bp7x4oAkrySYVW3QKzivOnD3rsZfbmtv/bkHu9ntJkjzhksZm3kUCSPlLnIlvEc9KUQ+Z6WDom1otcJ1uFV/QBJXq95UTv+MBVqolFw18vMx1F+wAtu+RGyCv/XDWYtLWLJDbb71Ksjerd5BX4FlpOqX3QfDdI6dq/xu7/ta+iRBfxog1eJo231tqbbNHGO49yeJJl4njiT2/dWdrvUyFed+JvfvurE3/W+d3e9fdXJw7A9vurEW6L7bYl81Ym/AjpxE+evgPqqk6GF9nc+/Z1PX3Xy9d/s9Lc5fdWJDzm+pZDDV534COQBRSC+6uSbjU181YmvOvFVJ77qpLfqpFV4MXyBw9ehPMg6lHaNxBeFii9N8aUpvjTFl6b40pRvvzRlq4xi+LKaL1XpdS2+VOWBlqrUtSCfO07zVSu+asVXrUxVTacA5EsoqC9j8WUsrt3zZSy+jOU+lLH0Z+M1R/0yNL/3AkIzLJDqssf2TudBHTPBZ1EEh7RPRWCDE47I5FDk4Kq7VT/Hzhkxb2XS1gKzrs4Q9n6vzSdhytWORePm4gpzxnPrCkbtWByNOHlldcuSqg+vYSyOogeZqsq03y6b1fEjSXqbHxO+yzH5BHdjy+NMByg1gb7f7rGphI7Ugb6UW5iYbSlXZV4fd7psWz3oteCa0vhjseEjGHPNtr8B/vKWtUGD7SoD3tK/EvBPF8n1xX+8Se5Qri6UO1QuZngmYJ2k3gbR9Mk1jzfwWAyRNO6cNO9Ks9Mk2tSr6nB1qLNQX6G7xDm7LrMxb7VOyygkKIIEQMiH7ARV8WwDQX/C3r/65UCHYBL1qhD47I9sE3JYiOAPRr95NSS1fT3oMQubPnSfFYNRGr+i5drHnnFr08h0dxhAoHwCfc7lCBOkBWzleI7VYC5GiAN7gc68GsmLjxyJ7eZ58mlyS7+cqTgmZ8vc6ItEFG8a72OaGfpm0zjETbfnOzf39Ys0m2eTrOyvZRAJsOHKWtsqjOu1tXmZBNvXPYbBdV51w0UGL7zaMPqRQRjEnJG6P+5Gh8qTykigg7uX6UrIo6iFKqoaoruoafCnmw/zdNMfZfqjTH+U6Y8y/VGmP8q8y6NMf3Tpjy790eWXUpodJ1NTATc3hHpxZxt87jus1XJVDO1eJKpJ316c03oyzdwG/Qh3BtJHABDIzBphknoLcAXm4FcC2mUQVKAl58FfdrenUxljFs+/WSh9OG/3GFom/z4P/z4P/2Yhb3v8m4W8JXp4lsi/WciX+U/cqvsyf/9moaGF9nX9vq7/DvDtq/ftavs3C91Wgv7NQj7k8CGHf7OQj0AeUgTi3yz0zcYm/s1C/s1C/s1C/s1CfW8W2p1Z7b/SqLOnupSHDpwje6NY1vUuExcrF3j9bc5xvUi36bAa/q3sVXW23lUd5N4s0tqorxv3KyCR/R2CWz3Z7blu54M1G+RHk9De09OCCEy1qUx00ljuLCvboqiqG38yb9JDEmuu5nHzLl3f7f7qSj/BARGHHaurXXWh10JsUoKNxEsCK7PpyFUxaitz0nG9EPoSGrQKOGQjvjdV7NpN1ABih9HByreGxam+aKywXtH+8Bp7TT1ZC3mBtYvVujmircVRzcFBJ8KjC6Ht7Rpf4Q4bIBgZRHVD1QAr4VdypWPCWBQc+aNDDZjUP46O9KHa9omnubQP1gStGpgaGeIpVcwjBLgITURjbohQSYGuM3iGdR74XX8VUTPqaBn6vq3Ez+fnZ/amVQCWYcJGQdfLU2NYXCwHAouoyjjm+caijarw2fVaBmu0pDjpXHJzWAS7FP2cxiHFtseQY0bWrXHoKE1W+B6AMubJUzB4IeljRwWQfikAhU3oa4MRs2wUFeGuQE/GHDtSYQlY6FxAbwgEtG1wDBbjC7Cv2tHYXXIaBHTFLRBbfE1RiNosmx2PEZ4DfRJTj/Dq8zj7MgLyqu/ScrWONrA8UZReK/bup5fsh38e/UB2V3zEyhrh4gugXo/3Lx6Cu9V1KfVijkO+0ZzvfuzWnCCSeMQI6s8UHbimKXRONpaw0lWg6N7h3zgtzZUCGQuvVF6pvjKl+u7HerxzQPpbRLrRLOWq1n/TEnTiCguvAyEwfKJMC3gxcGKxLA7ZGcQ0GAkDevgK49QIHubWU33f56nM+yNAnKhKEPiECKwyER9B3ugjhRGDVy2vWl+Ran3v+quTxOTu3mu01+Mb9TpuQ94KIzxkpyUgQfCYvNIC62iSlGLd0KpXFShvq9guwl6pvFJ9XUp11DXaCBUiLUGo8ZXC2RyvqBLjsnOHj+madr2ETlqYd/VgIk8nn2d8WRDOJfbHKqlN+5wDplu/VoS2xZU89GKWeYIj1AI3K9DSvzqLVjFA7neYAV3A56Yv1NTBnYxvNbrN8QyMTs1wvKWMsEy+5mGx2XvmaR6OET01o/ckoMVwRwblAluKX+uCuTqFxR4/4ip4hDuHR0jx0ZNJXOIBQRlTvaEKDFONRJbhfOuwDfnT3KK9yqo0gVu2gyk//bI76LESOpuGxwOzZ1fPn4EOJ1zip6rPzL6jSMOWDtNm66LIXjx7BtHe03WqYIynUcRj/hQULfjrMEhjSi0qAeojiw11fGVdzIdLfIZGhyZusx/Yn73H/uy9MT32sAgH11O8et6xRPrFHa7N4q4VdSlTrtK8xkldJGzrP3ALgrZjIgmzVGKxjcmvyhz8jU0D43Eagjlf8kCYBCjPxQWewURpTja2TXyB28oIrG6OGWPNFb2sTh/CZSBHcAgoE4PPndZk630jlSPe3cvADJOLz7IIomznfFTD4IOWsQYCyv45AdeCAVYOFxzbffq0gID9tzy6ucGvtQLhSodSoUcLu1/K5PI62rJ18v2X2DgGlPLh8DedXUxjYdC27Rjems9bDD9k3HaMbs3nLUa/O/O2g09rams+L/EPCK4WqP0f8CBpDZEQvn8EEKQ7HQeByFzZtkLMhjH79+tzMG//AycHQK4=
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 OpenAI responses."}
>
</Heading>

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

</MethodEndpoint>



List all OpenAI responses.

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

<ParamsDetails
  parameters={[{"name":"after","in":"query","description":"The ID of the last response to return.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The number of responses to return.","required":false,"schema":{"type":"integer"}},{"name":"model","in":"query","description":"The model to filter responses by.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The order to sort responses by when sorted by created_at ('asc' or '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 ListOpenAIResponseObject.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"integer","description":"Unix timestamp when the response was created"},"error":{"description":"(Optional) Error details if the response generation failed","type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of failure"},"message":{"type":"string","description":"Human-readable error message describing the failure"}},"additionalProperties":false,"required":["code","message"],"title":"OpenAIResponseError"},"id":{"type":"string","description":"Unique identifier for this response"},"model":{"type":"string","description":"Model identifier used for generation"},"object":{"type":"string","const":"response","default":"response","description":"Object type identifier, always \"response\""},"output":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"text":{"type":"string","description":"The text content of the input message"},"type":{"type":"string","const":"input_text","default":"input_text","description":"Content type identifier, always \"input_text\""}},"additionalProperties":false,"required":["text","type"],"title":"OpenAIResponseInputMessageContentText","description":"Text content for input messages in OpenAI response format."},{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","const":"low"},{"type":"string","const":"high"},{"type":"string","const":"auto"}],"default":"auto","description":"Level of detail for image processing, can be \"low\", \"high\", or \"auto\""},"type":{"type":"string","const":"input_image","default":"input_image","description":"Content type identifier, always \"input_image\""},"image_url":{"type":"string","description":"(Optional) URL of the image content"}},"additionalProperties":false,"required":["detail","type"],"title":"OpenAIResponseInputMessageContentImage","description":"Image content for input messages in OpenAI response format."}],"discriminator":{"propertyName":"type","mapping":{"input_text":{"type":"object","properties":{"text":{"type":"string","description":"The text content of the input message"},"type":{"type":"string","const":"input_text","default":"input_text","description":"Content type identifier, always \"input_text\""}},"additionalProperties":false,"required":["text","type"],"title":"OpenAIResponseInputMessageContentText","description":"Text content for input messages in OpenAI response format."},"input_image":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","const":"low"},{"type":"string","const":"high"},{"type":"string","const":"auto"}],"default":"auto","description":"Level of detail for image processing, can be \"low\", \"high\", or \"auto\""},"type":{"type":"string","const":"input_image","default":"input_image","description":"Content type identifier, always \"input_image\""},"image_url":{"type":"string","description":"(Optional) URL of the image content"}},"additionalProperties":false,"required":["detail","type"],"title":"OpenAIResponseInputMessageContentImage","description":"Image content for input messages in OpenAI response format."}}},"title":"OpenAIResponseInputMessageContent"}},{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string","const":"output_text","default":"output_text"},"annotations":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file_citation","default":"file_citation","description":"Annotation type identifier, always \"file_citation\""},"file_id":{"type":"string","description":"Unique identifier of the referenced file"},"filename":{"type":"string","description":"Name of the referenced file"},"index":{"type":"integer","description":"Position index of the citation within the content"}},"additionalProperties":false,"required":["type","file_id","filename","index"],"title":"OpenAIResponseAnnotationFileCitation","description":"File citation annotation for referencing specific files in response content."},{"type":"object","properties":{"type":{"type":"string","const":"url_citation","default":"url_citation","description":"Annotation type identifier, always \"url_citation\""},"end_index":{"type":"integer","description":"End position of the citation span in the content"},"start_index":{"type":"integer","description":"Start position of the citation span in the content"},"title":{"type":"string","description":"Title of the referenced web resource"},"url":{"type":"string","description":"URL of the referenced web resource"}},"additionalProperties":false,"required":["type","end_index","start_index","title","url"],"title":"OpenAIResponseAnnotationCitation","description":"URL citation annotation for referencing external web resources."},{"type":"object","properties":{"type":{"type":"string","const":"container_file_citation","default":"container_file_citation"},"container_id":{"type":"string"},"end_index":{"type":"integer"},"file_id":{"type":"string"},"filename":{"type":"string"},"start_index":{"type":"integer"}},"additionalProperties":false,"required":["type","container_id","end_index","file_id","filename","start_index"],"title":"OpenAIResponseAnnotationContainerFileCitation"},{"type":"object","properties":{"type":{"type":"string","const":"file_path","default":"file_path"},"file_id":{"type":"string"},"index":{"type":"integer"}},"additionalProperties":false,"required":["type","file_id","index"],"title":"OpenAIResponseAnnotationFilePath"}],"discriminator":{"propertyName":"type","mapping":{"file_citation":{"type":"object","properties":{"type":{"type":"string","const":"file_citation","default":"file_citation","description":"Annotation type identifier, always \"file_citation\""},"file_id":{"type":"string","description":"Unique identifier of the referenced file"},"filename":{"type":"string","description":"Name of the referenced file"},"index":{"type":"integer","description":"Position index of the citation within the content"}},"additionalProperties":false,"required":["type","file_id","filename","index"],"title":"OpenAIResponseAnnotationFileCitation","description":"File citation annotation for referencing specific files in response content."},"url_citation":{"type":"object","properties":{"type":{"type":"string","const":"url_citation","default":"url_citation","description":"Annotation type identifier, always \"url_citation\""},"end_index":{"type":"integer","description":"End position of the citation span in the content"},"start_index":{"type":"integer","description":"Start position of the citation span in the content"},"title":{"type":"string","description":"Title of the referenced web resource"},"url":{"type":"string","description":"URL of the referenced web resource"}},"additionalProperties":false,"required":["type","end_index","start_index","title","url"],"title":"OpenAIResponseAnnotationCitation","description":"URL citation annotation for referencing external web resources."},"container_file_citation":{"type":"object","properties":{"type":{"type":"string","const":"container_file_citation","default":"container_file_citation"},"container_id":{"type":"string"},"end_index":{"type":"integer"},"file_id":{"type":"string"},"filename":{"type":"string"},"start_index":{"type":"integer"}},"additionalProperties":false,"required":["type","container_id","end_index","file_id","filename","start_index"],"title":"OpenAIResponseAnnotationContainerFileCitation"},"file_path":{"type":"object","properties":{"type":{"type":"string","const":"file_path","default":"file_path"},"file_id":{"type":"string"},"index":{"type":"integer"}},"additionalProperties":false,"required":["type","file_id","index"],"title":"OpenAIResponseAnnotationFilePath"}}},"title":"OpenAIResponseAnnotations"}}},"additionalProperties":false,"required":["text","type","annotations"],"title":"OpenAIResponseOutputMessageContentOutputText"}}]},"role":{"oneOf":[{"type":"string","const":"system"},{"type":"string","const":"developer"},{"type":"string","const":"user"},{"type":"string","const":"assistant"}]},"type":{"type":"string","const":"message","default":"message"},"id":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false,"required":["content","role","type"],"title":"OpenAIResponseMessage","description":"Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same \"type\" value, and there is no way to tell them apart in certain scenarios."},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this tool call"},"status":{"type":"string","description":"Current status of the web search operation"},"type":{"type":"string","const":"web_search_call","default":"web_search_call","description":"Tool call type identifier, always \"web_search_call\""}},"additionalProperties":false,"required":["id","status","type"],"title":"OpenAIResponseOutputMessageWebSearchToolCall","description":"Web search tool call output message for OpenAI responses."},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this tool call"},"queries":{"type":"array","items":{"type":"string"},"description":"List of search queries executed"},"status":{"type":"string","description":"Current status of the file search operation"},"type":{"type":"string","const":"file_search_call","default":"file_search_call","description":"Tool call type identifier, always \"file_search_call\""},"results":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Key-value attributes associated with the file"},"file_id":{"type":"string","description":"Unique identifier of the file containing the result"},"filename":{"type":"string","description":"Name of the file containing the result"},"score":{"type":"number","description":"Relevance score for this search result (between 0 and 1)"},"text":{"type":"string","description":"Text content of the search result"}},"additionalProperties":false,"required":["attributes","file_id","filename","score","text"],"title":"OpenAIResponseOutputMessageFileSearchToolCallResults","description":"Search results returned by the file search operation."},"description":"(Optional) Search results returned by the file search operation"}},"additionalProperties":false,"required":["id","queries","status","type"],"title":"OpenAIResponseOutputMessageFileSearchToolCall","description":"File search tool call output message for OpenAI responses."},{"type":"object","properties":{"call_id":{"type":"string","description":"Unique identifier for the function call"},"name":{"type":"string","description":"Name of the function being called"},"arguments":{"type":"string","description":"JSON string containing the function arguments"},"type":{"type":"string","const":"function_call","default":"function_call","description":"Tool call type identifier, always \"function_call\""},"id":{"type":"string","description":"(Optional) Additional identifier for the tool call"},"status":{"type":"string","description":"(Optional) Current status of the function call execution"}},"additionalProperties":false,"required":["call_id","name","arguments","type"],"title":"OpenAIResponseOutputMessageFunctionToolCall","description":"Function tool call output message for OpenAI responses."},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this MCP call"},"type":{"type":"string","const":"mcp_call","default":"mcp_call","description":"Tool call type identifier, always \"mcp_call\""},"arguments":{"type":"string","description":"JSON string containing the MCP call arguments"},"name":{"type":"string","description":"Name of the MCP method being called"},"server_label":{"type":"string","description":"Label identifying the MCP server handling the call"},"error":{"type":"string","description":"(Optional) Error message if the MCP call failed"},"output":{"type":"string","description":"(Optional) Output result from the successful MCP call"}},"additionalProperties":false,"required":["id","type","arguments","name","server_label"],"title":"OpenAIResponseOutputMessageMCPCall","description":"Model Context Protocol (MCP) call output message for OpenAI responses."},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this MCP list tools operation"},"type":{"type":"string","const":"mcp_list_tools","default":"mcp_list_tools","description":"Tool call type identifier, always \"mcp_list_tools\""},"server_label":{"type":"string","description":"Label identifying the MCP server providing the tools"},"tools":{"type":"array","items":{"type":"object","properties":{"input_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"JSON schema defining the tool's input parameters"},"name":{"type":"string","description":"Name of the tool"},"description":{"type":"string","description":"(Optional) Description of what the tool does"}},"additionalProperties":false,"required":["input_schema","name"],"title":"MCPListToolsTool","description":"Tool definition returned by MCP list tools operation."},"description":"List of available tools provided by the MCP server"}},"additionalProperties":false,"required":["id","type","server_label","tools"],"title":"OpenAIResponseOutputMessageMCPListTools","description":"MCP list tools output message containing available tools from an MCP server."}],"discriminator":{"propertyName":"type","mapping":{"message":{"type":"object","properties":{"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"text":{"type":"string","description":"The text content of the input message"},"type":{"type":"string","const":"input_text","default":"input_text","description":"Content type identifier, always \"input_text\""}},"additionalProperties":false,"required":["text","type"],"title":"OpenAIResponseInputMessageContentText","description":"Text content for input messages in OpenAI response format."},{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","const":"low"},{"type":"string","const":"high"},{"type":"string","const":"auto"}],"default":"auto","description":"Level of detail for image processing, can be \"low\", \"high\", or \"auto\""},"type":{"type":"string","const":"input_image","default":"input_image","description":"Content type identifier, always \"input_image\""},"image_url":{"type":"string","description":"(Optional) URL of the image content"}},"additionalProperties":false,"required":["detail","type"],"title":"OpenAIResponseInputMessageContentImage","description":"Image content for input messages in OpenAI response format."}],"discriminator":{"propertyName":"type","mapping":{"input_text":{"type":"object","properties":{"text":{"type":"string","description":"The text content of the input message"},"type":{"type":"string","const":"input_text","default":"input_text","description":"Content type identifier, always \"input_text\""}},"additionalProperties":false,"required":["text","type"],"title":"OpenAIResponseInputMessageContentText","description":"Text content for input messages in OpenAI response format."},"input_image":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","const":"low"},{"type":"string","const":"high"},{"type":"string","const":"auto"}],"default":"auto","description":"Level of detail for image processing, can be \"low\", \"high\", or \"auto\""},"type":{"type":"string","const":"input_image","default":"input_image","description":"Content type identifier, always \"input_image\""},"image_url":{"type":"string","description":"(Optional) URL of the image content"}},"additionalProperties":false,"required":["detail","type"],"title":"OpenAIResponseInputMessageContentImage","description":"Image content for input messages in OpenAI response format."}}},"title":"OpenAIResponseInputMessageContent"}},{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string","const":"output_text","default":"output_text"},"annotations":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file_citation","default":"file_citation","description":"Annotation type identifier, always \"file_citation\""},"file_id":{"type":"string","description":"Unique identifier of the referenced file"},"filename":{"type":"string","description":"Name of the referenced file"},"index":{"type":"integer","description":"Position index of the citation within the content"}},"additionalProperties":false,"required":["type","file_id","filename","index"],"title":"OpenAIResponseAnnotationFileCitation","description":"File citation annotation for referencing specific files in response content."},{"type":"object","properties":{"type":{"type":"string","const":"url_citation","default":"url_citation","description":"Annotation type identifier, always \"url_citation\""},"end_index":{"type":"integer","description":"End position of the citation span in the content"},"start_index":{"type":"integer","description":"Start position of the citation span in the content"},"title":{"type":"string","description":"Title of the referenced web resource"},"url":{"type":"string","description":"URL of the referenced web resource"}},"additionalProperties":false,"required":["type","end_index","start_index","title","url"],"title":"OpenAIResponseAnnotationCitation","description":"URL citation annotation for referencing external web resources."},{"type":"object","properties":{"type":{"type":"string","const":"container_file_citation","default":"container_file_citation"},"container_id":{"type":"string"},"end_index":{"type":"integer"},"file_id":{"type":"string"},"filename":{"type":"string"},"start_index":{"type":"integer"}},"additionalProperties":false,"required":["type","container_id","end_index","file_id","filename","start_index"],"title":"OpenAIResponseAnnotationContainerFileCitation"},{"type":"object","properties":{"type":{"type":"string","const":"file_path","default":"file_path"},"file_id":{"type":"string"},"index":{"type":"integer"}},"additionalProperties":false,"required":["type","file_id","index"],"title":"OpenAIResponseAnnotationFilePath"}],"discriminator":{"propertyName":"type","mapping":{"file_citation":{"type":"object","properties":{"type":{"type":"string","const":"file_citation","default":"file_citation","description":"Annotation type identifier, always \"file_citation\""},"file_id":{"type":"string","description":"Unique identifier of the referenced file"},"filename":{"type":"string","description":"Name of the referenced file"},"index":{"type":"integer","description":"Position index of the citation within the content"}},"additionalProperties":false,"required":["type","file_id","filename","index"],"title":"OpenAIResponseAnnotationFileCitation","description":"File citation annotation for referencing specific files in response content."},"url_citation":{"type":"object","properties":{"type":{"type":"string","const":"url_citation","default":"url_citation","description":"Annotation type identifier, always \"url_citation\""},"end_index":{"type":"integer","description":"End position of the citation span in the content"},"start_index":{"type":"integer","description":"Start position of the citation span in the content"},"title":{"type":"string","description":"Title of the referenced web resource"},"url":{"type":"string","description":"URL of the referenced web resource"}},"additionalProperties":false,"required":["type","end_index","start_index","title","url"],"title":"OpenAIResponseAnnotationCitation","description":"URL citation annotation for referencing external web resources."},"container_file_citation":{"type":"object","properties":{"type":{"type":"string","const":"container_file_citation","default":"container_file_citation"},"container_id":{"type":"string"},"end_index":{"type":"integer"},"file_id":{"type":"string"},"filename":{"type":"string"},"start_index":{"type":"integer"}},"additionalProperties":false,"required":["type","container_id","end_index","file_id","filename","start_index"],"title":"OpenAIResponseAnnotationContainerFileCitation"},"file_path":{"type":"object","properties":{"type":{"type":"string","const":"file_path","default":"file_path"},"file_id":{"type":"string"},"index":{"type":"integer"}},"additionalProperties":false,"required":["type","file_id","index"],"title":"OpenAIResponseAnnotationFilePath"}}},"title":"OpenAIResponseAnnotations"}}},"additionalProperties":false,"required":["text","type","annotations"],"title":"OpenAIResponseOutputMessageContentOutputText"}}]},"role":{"oneOf":[{"type":"string","const":"system"},{"type":"string","const":"developer"},{"type":"string","const":"user"},{"type":"string","const":"assistant"}]},"type":{"type":"string","const":"message","default":"message"},"id":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false,"required":["content","role","type"],"title":"OpenAIResponseMessage","description":"Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same \"type\" value, and there is no way to tell them apart in certain scenarios."},"web_search_call":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this tool call"},"status":{"type":"string","description":"Current status of the web search operation"},"type":{"type":"string","const":"web_search_call","default":"web_search_call","description":"Tool call type identifier, always \"web_search_call\""}},"additionalProperties":false,"required":["id","status","type"],"title":"OpenAIResponseOutputMessageWebSearchToolCall","description":"Web search tool call output message for OpenAI responses."},"file_search_call":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this tool call"},"queries":{"type":"array","items":{"type":"string"},"description":"List of search queries executed"},"status":{"type":"string","description":"Current status of the file search operation"},"type":{"type":"string","const":"file_search_call","default":"file_search_call","description":"Tool call type identifier, always \"file_search_call\""},"results":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Key-value attributes associated with the file"},"file_id":{"type":"string","description":"Unique identifier of the file containing the result"},"filename":{"type":"string","description":"Name of the file containing the result"},"score":{"type":"number","description":"Relevance score for this search result (between 0 and 1)"},"text":{"type":"string","description":"Text content of the search result"}},"additionalProperties":false,"required":["attributes","file_id","filename","score","text"],"title":"OpenAIResponseOutputMessageFileSearchToolCallResults","description":"Search results returned by the file search operation."},"description":"(Optional) Search results returned by the file search operation"}},"additionalProperties":false,"required":["id","queries","status","type"],"title":"OpenAIResponseOutputMessageFileSearchToolCall","description":"File search tool call output message for OpenAI responses."},"function_call":{"type":"object","properties":{"call_id":{"type":"string","description":"Unique identifier for the function call"},"name":{"type":"string","description":"Name of the function being called"},"arguments":{"type":"string","description":"JSON string containing the function arguments"},"type":{"type":"string","const":"function_call","default":"function_call","description":"Tool call type identifier, always \"function_call\""},"id":{"type":"string","description":"(Optional) Additional identifier for the tool call"},"status":{"type":"string","description":"(Optional) Current status of the function call execution"}},"additionalProperties":false,"required":["call_id","name","arguments","type"],"title":"OpenAIResponseOutputMessageFunctionToolCall","description":"Function tool call output message for OpenAI responses."},"mcp_call":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this MCP call"},"type":{"type":"string","const":"mcp_call","default":"mcp_call","description":"Tool call type identifier, always \"mcp_call\""},"arguments":{"type":"string","description":"JSON string containing the MCP call arguments"},"name":{"type":"string","description":"Name of the MCP method being called"},"server_label":{"type":"string","description":"Label identifying the MCP server handling the call"},"error":{"type":"string","description":"(Optional) Error message if the MCP call failed"},"output":{"type":"string","description":"(Optional) Output result from the successful MCP call"}},"additionalProperties":false,"required":["id","type","arguments","name","server_label"],"title":"OpenAIResponseOutputMessageMCPCall","description":"Model Context Protocol (MCP) call output message for OpenAI responses."},"mcp_list_tools":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this MCP list tools operation"},"type":{"type":"string","const":"mcp_list_tools","default":"mcp_list_tools","description":"Tool call type identifier, always \"mcp_list_tools\""},"server_label":{"type":"string","description":"Label identifying the MCP server providing the tools"},"tools":{"type":"array","items":{"type":"object","properties":{"input_schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"JSON schema defining the tool's input parameters"},"name":{"type":"string","description":"Name of the tool"},"description":{"type":"string","description":"(Optional) Description of what the tool does"}},"additionalProperties":false,"required":["input_schema","name"],"title":"MCPListToolsTool","description":"Tool definition returned by MCP list tools operation."},"description":"List of available tools provided by the MCP server"}},"additionalProperties":false,"required":["id","type","server_label","tools"],"title":"OpenAIResponseOutputMessageMCPListTools","description":"MCP list tools output message containing available tools from an MCP server."}}},"title":"OpenAIResponseOutput"},"description":"List of generated output items (messages, tool calls, etc.)"},"parallel_tool_calls":{"type":"boolean","default":false,"description":"Whether tool calls can be executed in parallel"},"previous_response_id":{"type":"string","description":"(Optional) ID of the previous response in a conversation"},"status":{"type":"string","description":"Current status of the response generation"},"temperature":{"type":"number","description":"(Optional) Sampling temperature used for generation"},"text":{"description":"Text formatting configuration for the response","type":"object","properties":{"format":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","const":"text"},{"type":"string","const":"json_schema"},{"type":"string","const":"json_object"}],"description":"Must be \"text\", \"json_schema\", or \"json_object\" to identify the format type"},"name":{"type":"string","description":"The name of the response format. Only used for json_schema."},"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. Only used for json_schema."},"description":{"type":"string","description":"(Optional) A description of the response format. Only used for json_schema."},"strict":{"type":"boolean","description":"(Optional) Whether to strictly enforce the JSON schema. If true, the response must match the schema exactly. Only used for json_schema."}},"additionalProperties":false,"required":["type"],"description":"(Optional) Text format configuration specifying output format requirements"}},"additionalProperties":false,"title":"OpenAIResponseText"},"top_p":{"type":"number","description":"(Optional) Nucleus sampling parameter used for generation"},"truncation":{"type":"string","description":"(Optional) Truncation strategy applied to the response"},"user":{"type":"string","description":"(Optional) User identifier associated with the request"},"input":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this tool call"},"status":{"type":"string","description":"Current status of the web search operation"},"type":{"type":"string","const":"web_search_call","default":"web_search_call","description":"Tool call type identifier, always \"web_search_call\""}},"additionalProperties":false,"required":["id","status","type"],"title":"OpenAIResponseOutputMessageWebSearchToolCall","description":"Web search tool call output message for OpenAI responses."},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this tool call"},"queries":{"type":"array","items":{"type":"string"},"description":"List of search queries executed"},"status":{"type":"string","description":"Current status of the file search operation"},"type":{"type":"string","const":"file_search_call","default":"file_search_call","description":"Tool call type identifier, always \"file_search_call\""},"results":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Key-value attributes associated with the file"},"file_id":{"type":"string","description":"Unique identifier of the file containing the result"},"filename":{"type":"string","description":"Name of the file containing the result"},"score":{"type":"number","description":"Relevance score for this search result (between 0 and 1)"},"text":{"type":"string","description":"Text content of the search result"}},"additionalProperties":false,"required":["attributes","file_id","filename","score","text"],"title":"OpenAIResponseOutputMessageFileSearchToolCallResults","description":"Search results returned by the file search operation."},"description":"(Optional) Search results returned by the file search operation"}},"additionalProperties":false,"required":["id","queries","status","type"],"title":"OpenAIResponseOutputMessageFileSearchToolCall","description":"File search tool call output message for OpenAI responses."},{"type":"object","properties":{"call_id":{"type":"string","description":"Unique identifier for the function call"},"name":{"type":"string","description":"Name of the function being called"},"arguments":{"type":"string","description":"JSON string containing the function arguments"},"type":{"type":"string","const":"function_call","default":"function_call","description":"Tool call type identifier, always \"function_call\""},"id":{"type":"string","description":"(Optional) Additional identifier for the tool call"},"status":{"type":"string","description":"(Optional) Current status of the function call execution"}},"additionalProperties":false,"required":["call_id","name","arguments","type"],"title":"OpenAIResponseOutputMessageFunctionToolCall","description":"Function tool call output message for OpenAI responses."},{"type":"object","properties":{"call_id":{"type":"string"},"output":{"type":"string"},"type":{"type":"string","const":"function_call_output","default":"function_call_output"},"id":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false,"required":["call_id","output","type"],"title":"OpenAIResponseInputFunctionToolCallOutput","description":"This represents the output of a function call that gets passed back to the model."},{"type":"object","properties":{"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"text":{"type":"string","description":"The text content of the input message"},"type":{"type":"string","const":"input_text","default":"input_text","description":"Content type identifier, always \"input_text\""}},"additionalProperties":false,"required":["text","type"],"title":"OpenAIResponseInputMessageContentText","description":"Text content for input messages in OpenAI response format."},{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","const":"low"},{"type":"string","const":"high"},{"type":"string","const":"auto"}],"default":"auto","description":"Level of detail for image processing, can be \"low\", \"high\", or \"auto\""},"type":{"type":"string","const":"input_image","default":"input_image","description":"Content type identifier, always \"input_image\""},"image_url":{"type":"string","description":"(Optional) URL of the image content"}},"additionalProperties":false,"required":["detail","type"],"title":"OpenAIResponseInputMessageContentImage","description":"Image content for input messages in OpenAI response format."}],"discriminator":{"propertyName":"type","mapping":{"input_text":{"type":"object","properties":{"text":{"type":"string","description":"The text content of the input message"},"type":{"type":"string","const":"input_text","default":"input_text","description":"Content type identifier, always \"input_text\""}},"additionalProperties":false,"required":["text","type"],"title":"OpenAIResponseInputMessageContentText","description":"Text content for input messages in OpenAI response format."},"input_image":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","const":"low"},{"type":"string","const":"high"},{"type":"string","const":"auto"}],"default":"auto","description":"Level of detail for image processing, can be \"low\", \"high\", or \"auto\""},"type":{"type":"string","const":"input_image","default":"input_image","description":"Content type identifier, always \"input_image\""},"image_url":{"type":"string","description":"(Optional) URL of the image content"}},"additionalProperties":false,"required":["detail","type"],"title":"OpenAIResponseInputMessageContentImage","description":"Image content for input messages in OpenAI response format."}}},"title":"OpenAIResponseInputMessageContent"}},{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string","const":"output_text","default":"output_text"},"annotations":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file_citation","default":"file_citation","description":"Annotation type identifier, always \"file_citation\""},"file_id":{"type":"string","description":"Unique identifier of the referenced file"},"filename":{"type":"string","description":"Name of the referenced file"},"index":{"type":"integer","description":"Position index of the citation within the content"}},"additionalProperties":false,"required":["type","file_id","filename","index"],"title":"OpenAIResponseAnnotationFileCitation","description":"File citation annotation for referencing specific files in response content."},{"type":"object","properties":{"type":{"type":"string","const":"url_citation","default":"url_citation","description":"Annotation type identifier, always \"url_citation\""},"end_index":{"type":"integer","description":"End position of the citation span in the content"},"start_index":{"type":"integer","description":"Start position of the citation span in the content"},"title":{"type":"string","description":"Title of the referenced web resource"},"url":{"type":"string","description":"URL of the referenced web resource"}},"additionalProperties":false,"required":["type","end_index","start_index","title","url"],"title":"OpenAIResponseAnnotationCitation","description":"URL citation annotation for referencing external web resources."},{"type":"object","properties":{"type":{"type":"string","const":"container_file_citation","default":"container_file_citation"},"container_id":{"type":"string"},"end_index":{"type":"integer"},"file_id":{"type":"string"},"filename":{"type":"string"},"start_index":{"type":"integer"}},"additionalProperties":false,"required":["type","container_id","end_index","file_id","filename","start_index"],"title":"OpenAIResponseAnnotationContainerFileCitation"},{"type":"object","properties":{"type":{"type":"string","const":"file_path","default":"file_path"},"file_id":{"type":"string"},"index":{"type":"integer"}},"additionalProperties":false,"required":["type","file_id","index"],"title":"OpenAIResponseAnnotationFilePath"}],"discriminator":{"propertyName":"type","mapping":{"file_citation":{"type":"object","properties":{"type":{"type":"string","const":"file_citation","default":"file_citation","description":"Annotation type identifier, always \"file_citation\""},"file_id":{"type":"string","description":"Unique identifier of the referenced file"},"filename":{"type":"string","description":"Name of the referenced file"},"index":{"type":"integer","description":"Position index of the citation within the content"}},"additionalProperties":false,"required":["type","file_id","filename","index"],"title":"OpenAIResponseAnnotationFileCitation","description":"File citation annotation for referencing specific files in response content."},"url_citation":{"type":"object","properties":{"type":{"type":"string","const":"url_citation","default":"url_citation","description":"Annotation type identifier, always \"url_citation\""},"end_index":{"type":"integer","description":"End position of the citation span in the content"},"start_index":{"type":"integer","description":"Start position of the citation span in the content"},"title":{"type":"string","description":"Title of the referenced web resource"},"url":{"type":"string","description":"URL of the referenced web resource"}},"additionalProperties":false,"required":["type","end_index","start_index","title","url"],"title":"OpenAIResponseAnnotationCitation","description":"URL citation annotation for referencing external web resources."},"container_file_citation":{"type":"object","properties":{"type":{"type":"string","const":"container_file_citation","default":"container_file_citation"},"container_id":{"type":"string"},"end_index":{"type":"integer"},"file_id":{"type":"string"},"filename":{"type":"string"},"start_index":{"type":"integer"}},"additionalProperties":false,"required":["type","container_id","end_index","file_id","filename","start_index"],"title":"OpenAIResponseAnnotationContainerFileCitation"},"file_path":{"type":"object","properties":{"type":{"type":"string","const":"file_path","default":"file_path"},"file_id":{"type":"string"},"index":{"type":"integer"}},"additionalProperties":false,"required":["type","file_id","index"],"title":"OpenAIResponseAnnotationFilePath"}}},"title":"OpenAIResponseAnnotations"}}},"additionalProperties":false,"required":["text","type","annotations"],"title":"OpenAIResponseOutputMessageContentOutputText"}}]},"role":{"oneOf":[{"type":"string","const":"system"},{"type":"string","const":"developer"},{"type":"string","const":"user"},{"type":"string","const":"assistant"}]},"type":{"type":"string","const":"message","default":"message"},"id":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false,"required":["content","role","type"],"title":"OpenAIResponseMessage","description":"Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same \"type\" value, and there is no way to tell them apart in certain scenarios."}],"title":"OpenAIResponseInput"},"description":"List of input items that led to this response"}},"additionalProperties":false,"required":["created_at","id","model","object","output","parallel_tool_calls","status","text","input"],"title":"OpenAIResponseObjectWithInput","description":"OpenAI response object extended with input context information."},"description":"List of response objects with their input context"},"has_more":{"type":"boolean","description":"Whether there are more results available beyond this page"},"first_id":{"type":"string","description":"Identifier of the first item in this page"},"last_id":{"type":"string","description":"Identifier of the last item in this page"},"object":{"type":"string","const":"list","default":"list","description":"Object type identifier, always \"list\""}},"additionalProperties":false,"required":["data","has_more","first_id","last_id","object"],"title":"ListOpenAIResponseObject","description":"Paginated list of OpenAI response objects with navigation metadata."}}}},"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>