Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
We generally recommend altering this or top_p but not both.
An alternative to sampling with temperature, called nucleus sampling,
where the model considers the results of the tokens with top_p probability
mass. So 0.1 means only the tokens comprising the top 10% probability mass
are considered.
We generally recommend altering this or temperature but not both.
Model ID used to generate the response, like gpt-4o or o1. OpenAI
offers a wide range of models with different capabilities, performance
characteristics, and price points. Refer to the model guide
to browse and compare available models.
Inserts a system (or developer) message as the first item in the model's context.
When using along with previous_response_id, the instructions from a previous
response will be not be carried over to the next response. This makes it simple
to swap out system (or developer) messages in new responses.
(File search · object | Function · object | Computer use · object | Web search · object)[]
required
An array of tools the model may call while generating a response. You
can specify which tool to use by setting the tool_choice parameter.
The two categories of tools you can provide the model are:
Built-in tools: Tools that are provided by OpenAI that extend the
model's capabilities, like web search
or file search. Learn more about
built-in tools.
Function calls (custom tools): Functions that are defined by you,
enabling the model to call your own code. Learn more about
function calling.
A tool that searches for relevant content from uploaded files.
Learn more about the file search tool.
How the model should select which tool (or tools) to use when generating
a response. See the tools parameter to see how to specify which tools
the model can call.
The length and order of items in the output array is dependent
on the model's response.
Rather than accessing the first item in the output array and
assuming it's an assistant message with the content generated by
the model, you might consider using the output_text property where
supported in SDKs.
The truncation strategy to use for the model response.
auto: If the context of this response and previous ones exceeds
the model's context window size, the model will truncate the
response to fit the context window by dropping input items in the
middle of the conversation.
disabled (default): If a model response will exceed the context window
size for a model, the request will fail with a 400 error.
SDK-only convenience property that contains the aggregated text output
from all output_text items in the output array, if any are present.
Supported in the Python and JavaScript SDKs.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Portkey (Prisma AIRS AI Gateway) Docs","description":"Comprehensive documentation for AI Gateway, Guardrails, Observability, and Governance features.","colors":{"primary":"#0891B2","light":"#0891B2","dark":"#0891B2"},"logo":{"light":"https://mintcdn.com/portkey-docs/tHk-hgNjLbEj4dhh/images/portkey-PANW-company-logo-positive.png?fit=max\u0026auto=format\u0026n=tHk-hgNjLbEj4dhh\u0026q=85\u0026s=c5fb09014ff79616583b1d3bffe27450","dark":"https://mintcdn.com/portkey-docs/tHk-hgNjLbEj4dhh/images/portkey-PANW-company-logo-negative.png?fit=max\u0026auto=format\u0026n=tHk-hgNjLbEj4dhh\u0026q=85\u0026s=6025ca49ef544522f58ff471b7f75f8f"},"favicon":"https://mintcdn.com/portkey-docs/Hf1XgyjG_b79ym4Q/favicon.png?fit=max\u0026auto=format\u0026n=Hf1XgyjG_b79ym4Q\u0026q=85\u0026s=cbaa1bfc49bb6e3fd6cf499a5da313a3","api":{"openapi":"https://raw.githubusercontent.com/Portkey-AI/openapi/refs/heads/master/openapi.yaml","examples":{"prefill":true},"url":"full"},"navbar":{"links":[{"href":"https://portkey.ai/models","label":"Models"},{"href":"https://support.portkey.ai/forms/customer-portal-ticket-form","label":"Support"},{"href":"https://www.paloaltonetworks.in/ai-security/ai-gateway?utm_source=portkey\u0026utm_medium=referral\u0026utm_campaign=prisma_airs\u0026utm_content=docs_nav#contact","label":"Contact Us"}],"primary":{"type":"button","label":"Sign in","href":"https://stratacloudmanager.paloaltonetworks.com/"}},"footer":{"socials":{"x":"https://twitter.com/PortkeyAI","linkedin":"https://www.linkedin.com/company/portkey-ai","github":"https://git.new/portkey"},"links":[{"header":"For LLMs","items":[{"label":"llms.txt","href":"https://portkey.ai/docs/llms.txt"},{"label":"llms-full.txt","href":"https://portkey.ai/docs/llms-full.txt"}]},{"header":"Products","items":[{"label":"Observability","href":"https://portkey.ai/features/observability"},{"label":"AI Gateway","href":"https://portkey.ai/features/ai-gateway"},{"label":"Guardrails","href":"https://portkey.ai/features/guardrails"},{"label":"Prompt Management","href":"https://portkey.ai/features/prompt-management"},{"label":"Agents","href":"https://portkey.ai/features/agents"},{"label":"MCP Gateway","href":"https://portkey.ai/docs/product/mcp-gateway"},{"label":"Security","href":"https://portkey.ai/features/security-and-compliance"},{"label":"Auto-Instrumentation","href":"https://portkey.ai/features/auto-instrumentation"}]},{"header":"Resources","items":[{"label":"API Status","href":"https://status.portkey.ai/"},{"label":"Helm Charts","href":"https://github.com/portkey-ai/helm"},{"label":"AI Grants Finder","href":"https://grantsfinder.portkey.ai/"},{"label":"Events Calendar","href":"https://lu.ma/portkey"},{"label":"Blog","href":"https://portkey.ai/blog"},{"label":"Error Library","href":"https://portkey.ai/error-library"},{"label":"Models \u0026 Pricing","href":"https://portkey.ai/models"}]},{"header":"Company","items":[{"label":"Pricing","href":"https://portkey.ai/pricing"},{"label":"Compliances","href":"https://trust.portkey.ai/"},{"label":"Privacy Policy","href":"https://portkey.ai/privacy-policy"},{"label":"Terms of Service","href":"https://portkey.ai/terms"},{"label":"DPA","href":"https://portkey.ai/dpa"},{"label":"Cookie Policy","href":"https://portkey.ai/cookie-policy"}]}]},"seo":{"metatags":{"og:type":"website","og:site_name":"Portkey AI Gateway Docs"},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"ga4":{"measurementId":"G-JJMXYE4DRL"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"toc"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"portkey-docs","hasAudioNarration":false,"actualSubdomain":"portkey-docs","customDomains":["docs.portkey.ai","portkey.ai"],"gitSource":{"type":"github","owner":"portkey-ai","repo":"docs-core","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfa7cae2a4938765af087a","collectionId":"04e38fd3-b064-4be8-9a07-c96fd5692c89","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfa7cae2a4938765af087a"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfa7cae2a4938765af087a","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Integrations","count":697},{"language":"default","tag":"Product","count":382},{"language":"default","tag":"Docs","count":320},{"language":"default","tag":"LLM Integrations","count":307},{"language":"default","tag":"More","count":176},{"language":"default","tag":"Admin APIs","count":172},{"language":"default","tag":"Guardrails","count":101},{"language":"default","tag":"AI Gateway","count":99},{"language":"default","tag":"Admin API","count":95},{"language":"default","tag":"Documentation","count":91}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@portkey.ai","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#banner{background:linear-gradient(90deg,#0d1b2e 0,#1a1040 40%,#2d0f22 100%);border-bottom:1px solid rgba(255,255,255,.08)}#banner a{color:#f0f0f0;text-decoration:none;font-weight:600;border-bottom:1px solid rgba(240,240,240,.5);padding-bottom:1px;transition:border-color .2s ease}#banner a:hover{border-bottom-color:#fff}"}],"page":{"pagePath":"api-reference/inference-api/responses/retrieve-response","slug":"/api-reference/inference-api/responses/retrieve-response","pageMetadata":{"title":"Get a Response","openapi":"get /responses/{response_id}","description":"","href":"/api-reference/inference-api/responses/retrieve-response"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={hr:`hr`,p:`p`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsx(_components.hr,{}),`\n`,_jsx(Card,{title:`Portkey is now PRISMA AIRS AI Gateway. See it in action.`,href:`https://www.paloaltonetworks.in/ai-security/ai-gateway?utm_source=portkey\u0026utm_medium=referral\u0026utm_campaign=prisma_airs\u0026utm_content=docs_nav#contact`,icon:`arrow-up-right-from-square`,children:_jsx(_components.p,{children:`Contact Us`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Get a Response","openapi":"get /responses/{response_id}","description":"","href":"/api-reference/inference-api/responses/retrieve-response"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getResponse","tags":["Responses"],"summary":"Retrieves a model response with the given ID.\n","parameters":["b5035860-52a4-4770-957b-f3bb072f71dd","d0f24efc-4315-4adb-b452-0df1fe905406"],"responses":{"200":"36912caa-d3d4-47dc-bf60-d6f0edbcac59"},"method":"get","type":"path","servers":["904f68fe-5e29-4f26-8ddc-97ed98e0aa9a","149303d8-a0a9-41d8-8a01-182fd472895a"],"security":["0a39a621-96fb-4cc7-a41c-1678aaeda3a9"],"path":"/responses/{response_id}","baseUrlOptions":["https://api.portkey.ai/v1","SELF_HOSTED_GATEWAY_URL"],"title":"Retrieves a model response with the given ID.\n","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"b5035860-52a4-4770-957b-f3bb072f71dd":{"in":"path","name":"response_id","required":true,"schema":{"type":"string","example":"resp_677efb5139a88190b512bc3fef8e535d","isRequired":true,"description":"The ID of the response to retrieve.","uniqueKey":"","typeLabel":"string"},"description":"The ID of the response to retrieve."},"d0f24efc-4315-4adb-b452-0df1fe905406":{"in":"query","name":"include","schema":{"type":"array","items":{"type":"string","description":"Specify additional output data to include in the model response. Currently\nsupported values are:\n- `file_search_call.results`: Include the search results of\n the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n","enum":["file_search_call.results","message.input_image.image_url","computer_call_output.output.image_url"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Specify additional output data to include in the response. Currently\nsupported values are:\n- `file_search_call.results`: Include the search results of\n the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"description":"Specify additional output data to include in the response. Currently\nsupported values are:\n- `file_search_call.results`: Include the search results of\n the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n"}},"responses":{"36912caa-d3d4-47dc-bf60-d6f0edbcac59":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["id","object","created_at","error","incomplete_details","instructions","model","tools","output","parallel_tool_calls","metadata","tool_choice","temperature","top_p"],"properties":{"metadata":{"oneOf":[{"type":"object","description":"Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard. \n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"x-oaiTypeLabel":"map","isRequired":true,"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard. \n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"x-oaiTypeLabel":"map","isRequired":true,"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"metadata","typeLabel":"object | null"},"temperature":{"oneOf":[{"type":"number","minimum":0,"maximum":2,"default":1,"example":1,"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.\n","isRequired":true,"uniqueKey":"temperature.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":2,"default":1,"example":1,"description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.\n","isRequired":true,"uniqueKey":"temperature.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"temperature","typeLabel":"number | null"},"top_p":{"oneOf":[{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n","isRequired":true,"uniqueKey":"top_p.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n","isRequired":true,"uniqueKey":"top_p.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"top_p","typeLabel":"number | null"},"model":{"type":"string","description":"Model ID used to generate the response, like `gpt-4o` or `o1`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n","enum":["o1-pro","o1-pro-2025-03-19","computer-use-preview","computer-use-preview-2025-03-11"],"example":"gpt-4o","isRequired":true,"uniqueKey":"model","typeLabel":"enum\u003cstring>"},"instructions":{"oneOf":[{"type":"string","description":"Inserts a system (or developer) message as the first item in the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will be not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.\n","isRequired":true,"uniqueKey":"instructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inserts a system (or developer) message as the first item in the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will be not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.\n","isRequired":true,"uniqueKey":"instructions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instructions","typeLabel":"string | null"},"tools":{"type":"array","description":"An array of tools the model may call while generating a response. You \ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](/docs/guides/tools-web-search)\n or [file search](/docs/guides/tools-file-search). Learn more about\n [built-in tools](/docs/guides/tools).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code. Learn more about\n [function calling](/docs/guides/function-calling).\n","items":{"oneOf":[{"type":"object","title":"File search","description":"A tool that searches for relevant content from uploaded files.\nLearn more about the [file search tool](/docs/guides/tools-file-search).\n","required":["type","vector_store_ids"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["file_search"],"description":"The type of the file search tool. Always `file_search`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"vector_store_ids":{"type":"array","items":{"type":"string","uniqueKey":"tools.items.[INDEX].oneOf.0.vector_store_ids.items.[INDEX]","typeLabel":"string"},"description":"The IDs of the vector stores to search.\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.vector_store_ids","typeLabel":"string[]"},"max_num_results":{"type":"integer","description":"The maximum number of results to return. This number should be between 1 \nand 50 inclusive.\n","uniqueKey":"tools.items.[INDEX].oneOf.0.max_num_results","typeLabel":"integer"},"filters":{"oneOf":[{"type":"object","title":"Comparison Filter","description":"A filter to apply based on file attributes.","required":["type","key","value"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","default":"eq","enum":["eq","ne","gt","gte","lt","lte"],"description":"Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The key to compare against the value.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.0.key","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"The value to compare against the attribute key; supports string, number, or boolean types.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"The value to compare against the attribute key; supports string, number, or boolean types.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"The value to compare against the attribute key; supports string, number, or boolean types.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.0.value.oneOf.2","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.0.value","typeLabel":"string | number | boolean"}},"additionalProperties":false,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.0","typeLabel":"Comparison Filter · object"},{"type":"object","title":"Compound Filter","description":"A filter to apply based on file attributes.","required":["type","filters"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"Type of operation: `and` or `or`.","enum":["and","or"],"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.type","typeLabel":"enum\u003cstring>"},"filters":{"type":"array","description":"Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.","items":{"oneOf":[{"type":"object","title":"Comparison Filter","description":"A filter used to compare a specified attribute key to a given value using a defined comparison operation.\n","required":["type","key","value"],"properties":{"type":{"type":"string","default":"eq","enum":["eq","ne","gt","gte","lt","lte"],"description":"Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The key to compare against the value.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.0.key","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"The value to compare against the attribute key; supports string, number, or boolean types.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"The value to compare against the attribute key; supports string, number, or boolean types.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"The value to compare against the attribute key; supports string, number, or boolean types.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.0.value.oneOf.2","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.0.value","typeLabel":"string | number | boolean"}},"additionalProperties":false,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.0","typeLabel":"Comparison Filter · object"},{"type":"object","additionalProperties":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters.items.[INDEX]","typeLabel":"Comparison Filter · object | object"},"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1.filters","typeLabel":"(Comparison Filter · object | object)[]"}},"additionalProperties":false,"uniqueKey":"tools.items.[INDEX].oneOf.0.filters.oneOf.1","typeLabel":"Compound Filter · object"}],"uniqueKey":"tools.items.[INDEX].oneOf.0.filters","typeLabel":"Comparison Filter · object | Compound Filter · object"},"ranking_options":{"description":"Ranking options for search.","type":"object","additionalProperties":false,"properties":{"ranker":{"type":"string","description":"The ranker to use for the file search.","enum":["auto","default-2024-11-15"],"default":"auto","uniqueKey":"tools.items.[INDEX].oneOf.0.ranking_options.ranker","typeLabel":"enum\u003cstring>"},"score_threshold":{"type":"number","description":"The score threshold for the file search, a number between 0 and 1.\nNumbers closer to 1 will attempt to return only the most relevant\nresults, but may return fewer results.\n","minimum":0,"maximum":1,"default":0,"uniqueKey":"tools.items.[INDEX].oneOf.0.ranking_options.score_threshold","typeLabel":"number"}},"uniqueKey":"tools.items.[INDEX].oneOf.0.ranking_options","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.0","typeLabel":"File search · object"},{"type":"object","title":"Function","description":"Defines a function in your own code the model can choose to call. Learn more\nabout [function calling](/docs/guides/function-calling).\n","required":["type","name","parameters","strict"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the function tool. Always `function`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the function to call.\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.1.name","typeLabel":"string"},"parameters":{"type":"object","description":"A JSON schema object describing the parameters of the function.\n","additionalProperties":true,"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters","typeLabel":"object"},"strict":{"type":"boolean","description":"Whether to enforce strict parameter validation. Default `true`.\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.1.strict","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","description":"A description of the function. Used by the model to determine whether\nor not to call the function.\n","uniqueKey":"tools.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the function. Used by the model to determine whether\nor not to call the function.\n","uniqueKey":"tools.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.items.[INDEX].oneOf.1.description","typeLabel":"string | null"}},"uniqueKey":"tools.items.[INDEX].oneOf.1","typeLabel":"Function · object"},{"type":"object","title":"Computer use","description":"A tool that controls a virtual computer. Learn more about the \n[computer tool](/docs/guides/tools-computer-use).\n","required":["type","display_width","display_height","environment"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["computer_use_preview"],"description":"The type of the computer use tool. Always `computer_use_preview`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"display_width":{"type":"number","description":"The width of the computer display.\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.2.display_width","typeLabel":"number"},"display_height":{"type":"number","description":"The height of the computer display.\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.2.display_height","typeLabel":"number"},"environment":{"type":"string","description":"The type of computer environment to control.\n","enum":["mac","windows","ubuntu","browser"],"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.2.environment","typeLabel":"enum\u003cstring>"}},"uniqueKey":"tools.items.[INDEX].oneOf.2","typeLabel":"Computer use · object"},{"type":"object","title":"Web search","description":"This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](/docs/guides/tools-web-search).\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["web_search_preview","web_search_preview_2025_03_11"],"description":"The type of the web search tool. One of:\n- `web_search_preview`\n- `web_search_preview_2025_03_11`\n","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"user_location":{"oneOf":[{"type":"object","title":"Web search location","description":"Approximate location parameters for the search.","required":["type"],"properties":{"type":{"type":"string","description":"The type of location approximation. Always `approximate`.\n","enum":["approximate"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.3.user_location.oneOf.0.type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"The two-letter \n[ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user,\ne.g. `US`.\n","uniqueKey":"tools.items.[INDEX].oneOf.3.user_location.oneOf.0.country","typeLabel":"string"},"region":{"type":"string","description":"Free text input for the region of the user, e.g. `California`.\n","uniqueKey":"tools.items.[INDEX].oneOf.3.user_location.oneOf.0.region","typeLabel":"string"},"city":{"type":"string","description":"Free text input for the city of the user, e.g. `San Francisco`.\n","uniqueKey":"tools.items.[INDEX].oneOf.3.user_location.oneOf.0.city","typeLabel":"string"},"timezone":{"type":"string","description":"The [IANA timezone](https://timeapi.io/documentation/iana-timezones) \nof the user, e.g. `America/Los_Angeles`.\n","uniqueKey":"tools.items.[INDEX].oneOf.3.user_location.oneOf.0.timezone","typeLabel":"string"}},"uniqueKey":"tools.items.[INDEX].oneOf.3.user_location.oneOf.0","typeLabel":"Web search location · object"},{"type":"null","uniqueKey":"tools.items.[INDEX].oneOf.3.user_location.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.items.[INDEX].oneOf.3.user_location","typeLabel":"Web search location · object | null"},"search_context_size":{"type":"string","description":"High level guidance for the amount of context window space to use for the \nsearch. One of `low`, `medium`, or `high`. `medium` is the default.\n","enum":["low","medium","high"],"default":"medium","uniqueKey":"tools.items.[INDEX].oneOf.3.search_context_size","typeLabel":"enum\u003cstring>"}},"uniqueKey":"tools.items.[INDEX].oneOf.3","typeLabel":"Web search · object"}],"uniqueKey":"tools.items.[INDEX]","typeLabel":"File search · object | Function · object | Computer use · object | Web search · object"},"isRequired":true,"uniqueKey":"tools","typeLabel":"(File search · object | Function · object | Computer use · object | Web search · object)[]"},"tool_choice":{"oneOf":[{"type":"string","title":"Tool choice mode","description":"How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.\n","enum":["none","auto","required"],"x-oaiExpandable":true,"isRequired":true,"uniqueKey":"tool_choice.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","title":"Hosted tool","description":"How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of hosted tool the model should to use. Learn more about\n[built-in tools](/docs/guides/tools).\n\nAllowed values are:\n- `file_search`\n- `web_search_preview`\n- `computer_use_preview`\n","enum":["file_search","web_search_preview","computer_use_preview","web_search_preview_2025_03_11"],"isRequired":true,"uniqueKey":"tool_choice.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"tool_choice.oneOf.1","typeLabel":"Hosted tool · object"},{"type":"object","title":"Function tool","description":"How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.\n","required":["type","name"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["function"],"description":"For function calling, the type is always `function`.","x-stainless-const":true,"isRequired":true,"uniqueKey":"tool_choice.oneOf.2.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"tool_choice.oneOf.2.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"tool_choice.oneOf.2","typeLabel":"Function tool · object"}],"isRequired":true,"uniqueKey":"tool_choice","typeLabel":"enum\u003cstring> | Hosted tool · object | Function tool · object"},"id":{"type":"string","description":"Unique identifier for this Response.\n","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","description":"The object type of this resource - always set to `response`.\n","enum":["response"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"created_at":{"type":"number","description":"Unix timestamp (in seconds) of when this Response was created.\n","isRequired":true,"uniqueKey":"created_at","typeLabel":"number"},"error":{"oneOf":[{"type":"object","description":"An error object returned when the model fails to generate a Response.\n","properties":{"code":{"type":"string","description":"The error code for the response.\n","enum":["server_error","rate_limit_exceeded","invalid_prompt","vector_store_timeout","invalid_image","invalid_image_format","invalid_base64_image","invalid_image_url","image_too_large","image_too_small","image_parse_error","image_content_policy_violation","invalid_image_mode","image_file_too_large","unsupported_image_media_type","empty_image_file","failed_to_download_image","image_file_not_found"],"isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human-readable description of the error.\n","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","description":"An error object returned when the model fails to generate a Response.\n","properties":{"code":{"type":"string","description":"The error code for the response.\n","enum":["server_error","rate_limit_exceeded","invalid_prompt","vector_store_timeout","invalid_image","invalid_image_format","invalid_base64_image","invalid_image_url","image_too_large","image_too_small","image_parse_error","image_content_policy_violation","invalid_image_mode","image_file_too_large","unsupported_image_media_type","empty_image_file","failed_to_download_image","image_file_not_found"]},"message":{"type":"string","description":"A human-readable description of the error.\n"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"},"incomplete_details":{"oneOf":[{"type":"object","description":"Details about why the response is incomplete.\n","properties":{"reason":{"type":"string","description":"The reason why the response is incomplete.","enum":["max_output_tokens","content_filter"],"uniqueKey":"incomplete_details.oneOf.0.reason","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"incomplete_details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Details about why the response is incomplete.\n","properties":{"reason":{"type":"string","description":"The reason why the response is incomplete.","enum":["max_output_tokens","content_filter"]}},"isRequired":true,"uniqueKey":"incomplete_details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"incomplete_details","typeLabel":"object | null"},"output":{"type":"array","x-oaiExpandable":true,"description":"An array of content items generated by the model.\n\n- The length and order of items in the `output` array is dependent\n on the model's response.\n- Rather than accessing the first item in the `output` array and \n assuming it's an `assistant` message with the content generated by\n the model, you might consider using the `output_text` property where\n supported in SDKs.\n","items":{"oneOf":[{"type":"object","title":"Output message","description":"An output message from the model.\n","required":["id","type","role","content","status"],"x-oaiExpandable":true,"properties":{"id":{"type":"string","description":"The unique ID of the output message.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.id","typeLabel":"string"},"type":{"type":"string","description":"The type of the output message. Always `message`.\n","enum":["message"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"role":{"type":"string","description":"The role of the output message. Always `assistant`.\n","enum":["assistant"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.role","typeLabel":"enum\u003cstring>"},"content":{"type":"array","description":"The content of the output message.\n","x-oaiExpandable":true,"items":{"oneOf":[{"type":"object","title":"Output text","description":"A text output from the model.\n","required":["type","text","annotations"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of the output text. Always `output_text`.\n","enum":["output_text"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text output from the model.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.text","typeLabel":"string"},"annotations":{"type":"array","description":"The annotations of the text output.\n","items":{"oneOf":[{"type":"object","title":"File citation","description":"A citation to a file.\n","required":["type","index","file_id"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of the file citation. Always `file_citation`.\n","enum":["file_citation"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","description":"The index of the file in the list of files.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.0.index","typeLabel":"integer"},"file_id":{"type":"string","description":"The ID of the file.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.0.file_id","typeLabel":"string"}},"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.0","typeLabel":"File citation · object"},{"type":"object","title":"URL citation","description":"A citation for a web resource used to generate a model response.\n","required":["url","title","type","start_index","end_index"],"x-oaiExpandable":true,"properties":{"url":{"type":"string","description":"The URL of the web resource.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.1.url","typeLabel":"string"},"title":{"type":"string","description":"The title of the web resource.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.1.title","typeLabel":"string"},"type":{"type":"string","description":"The type of the URL citation. Always `url_citation`.\n","enum":["url_citation"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.1.start_index","typeLabel":"integer"},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.1.end_index","typeLabel":"integer"}},"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.1","typeLabel":"URL citation · object"},{"type":"object","title":"File path","description":"A path to a file.\n","required":["type","file_id","index"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of the file path. Always `file_path`.\n","enum":["file_path"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"file_id":{"type":"string","description":"The ID of the file.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.2.file_id","typeLabel":"string"},"index":{"type":"integer","description":"The index of the file in the list of files.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.2.index","typeLabel":"integer"}},"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX].oneOf.2","typeLabel":"File path · object"}],"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations.items.[INDEX]","typeLabel":"File citation · object | URL citation · object | File path · object"},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0.annotations","typeLabel":"(File citation · object | URL citation · object | File path · object)[]"}},"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.0","typeLabel":"Output text · object"},{"type":"object","title":"Refusal","description":"A refusal from the model.\n","required":["type","refusal"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of the refusal. Always `refusal`.\n","enum":["refusal"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"refusal":{"type":"string","description":"The refusal explanationfrom the model.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.1.refusal","typeLabel":"string"}},"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].oneOf.1","typeLabel":"Refusal · object"}],"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX]","typeLabel":"Output text · object | Refusal · object"},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content","typeLabel":"(Output text · object | Refusal · object)[]"},"status":{"type":"string","description":"The status of the message input. One of `in_progress`, `completed`, or\n`incomplete`. Populated when input items are returned via API.\n","enum":["in_progress","completed","incomplete"],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX].oneOf.0","typeLabel":"Output message · object"},{"type":"object","title":"File search tool call","description":"The results of a file search tool call. See the \n[file search guide](/docs/guides/tools-file-search) for more information.\n","required":["id","type","status","queries"],"x-oaiExpandable":true,"properties":{"id":{"type":"string","description":"The unique ID of the file search tool call.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.id","typeLabel":"string"},"type":{"type":"string","enum":["file_search_call"],"description":"The type of the file search tool call. Always `file_search_call`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"The status of the file search tool call. One of `in_progress`, \n`searching`, `incomplete` or `failed`,\n","enum":["in_progress","searching","completed","incomplete","failed"],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"queries":{"type":"array","items":{"type":"string","uniqueKey":"output.items.[INDEX].oneOf.1.queries.items.[INDEX]","typeLabel":"string"},"description":"The queries used to search for files.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.queries","typeLabel":"string[]"},"results":{"oneOf":[{"type":"array","description":"The results of the file search tool call.\n","items":{"type":"object","properties":{"file_id":{"type":"string","description":"The unique ID of the file.\n","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].file_id","typeLabel":"string"},"text":{"type":"string","description":"The text that was retrieved from the file.\n","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].text","typeLabel":"string"},"filename":{"type":"string","description":"The name of the file.\n","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].filename","typeLabel":"string"},"attributes":{"oneOf":[{"type":"object","description":"Set of 16 key-value pairs that can be attached to an object. This can be \nuseful for storing additional information about the object in a structured \nformat, and querying for objects via API or the dashboard. Keys are strings \nwith a maximum length of 64 characters. Values are strings with a maximum \nlength of 512 characters, booleans, or numbers.\n","maxProperties":16,"additionalProperties":{"oneOf":[{"type":"string","maxLength":512,"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.0.additionalProperties","typeLabel":"string | number | boolean"},"x-oaiTypeLabel":"map","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.0","typeLabel":"object"},{"type":"null","description":"Set of 16 key-value pairs that can be attached to an object. This can be \nuseful for storing additional information about the object in a structured \nformat, and querying for objects via API or the dashboard. Keys are strings \nwith a maximum length of 64 characters. Values are strings with a maximum \nlength of 512 characters, booleans, or numbers.\n","maxProperties":16,"additionalProperties":{"oneOf":[{"type":"string","maxLength":512,"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.1.additionalProperties","typeLabel":"string | number | boolean"},"x-oaiTypeLabel":"map","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].attributes","typeLabel":"object | null"},"score":{"type":"number","format":"float","description":"The relevance score of the file - a value between 0 and 1.\n","uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX].score","typeLabel":"number\u003cfloat>"}},"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"The results of the file search tool call.\n","items":{"type":"object","properties":{"file_id":{"type":"string","description":"The unique ID of the file.\n"},"text":{"type":"string","description":"The text that was retrieved from the file.\n"},"filename":{"type":"string","description":"The name of the file.\n"},"attributes":{"oneOf":[{"type":"object","description":"Set of 16 key-value pairs that can be attached to an object. This can be \nuseful for storing additional information about the object in a structured \nformat, and querying for objects via API or the dashboard. Keys are strings \nwith a maximum length of 64 characters. Values are strings with a maximum \nlength of 512 characters, booleans, or numbers.\n","maxProperties":16,"additionalProperties":{"oneOf":[{"type":"string","maxLength":512},{"type":"number"},{"type":"boolean"}]},"x-oaiTypeLabel":"map"},{"type":"null","description":"Set of 16 key-value pairs that can be attached to an object. This can be \nuseful for storing additional information about the object in a structured \nformat, and querying for objects via API or the dashboard. Keys are strings \nwith a maximum length of 64 characters. Values are strings with a maximum \nlength of 512 characters, booleans, or numbers.\n","maxProperties":16,"additionalProperties":{"oneOf":[{"type":"string","maxLength":512},{"type":"number"},{"type":"boolean"}]},"x-oaiTypeLabel":"map"}]},"score":{"type":"number","format":"float","description":"The relevance score of the file - a value between 0 and 1.\n"}}},"uniqueKey":"output.items.[INDEX].oneOf.1.results.oneOf.1","typeLabel":"null"}],"uniqueKey":"output.items.[INDEX].oneOf.1.results","typeLabel":"object[] | null"}},"uniqueKey":"output.items.[INDEX].oneOf.1","typeLabel":"File search tool call · object"},{"type":"object","title":"Function tool call","description":"A tool call to run a function. See the \n[function calling guide](/docs/guides/function-calling) for more information.\n","required":["type","call_id","name","arguments"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["function_call"],"description":"The type of the function tool call. Always `function_call`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.call_id","typeLabel":"string"},"name":{"type":"string","description":"The name of the function to run.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.name","typeLabel":"string"},"arguments":{"type":"string","description":"A JSON string of the arguments to pass to the function.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.arguments","typeLabel":"string"},"id":{"type":"string","description":"The unique ID of the function tool call.\n","uniqueKey":"output.items.[INDEX].oneOf.2.id","typeLabel":"string"},"status":{"type":"string","description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"],"uniqueKey":"output.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX].oneOf.2","typeLabel":"Function tool call · object"},{"type":"object","title":"Web search tool call","description":"The results of a web search tool call. See the \n[web search guide](/docs/guides/tools-web-search) for more information.\n","required":["id","type","status"],"x-oaiExpandable":true,"properties":{"id":{"type":"string","description":"The unique ID of the web search tool call.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.id","typeLabel":"string"},"type":{"type":"string","enum":["web_search_call"],"description":"The type of the web search tool call. Always `web_search_call`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"The status of the web search tool call.\n","enum":["in_progress","searching","completed","failed"],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX].oneOf.3","typeLabel":"Web search tool call · object"},{"type":"object","title":"Computer tool call","description":"A tool call to a computer use tool. See the \n[computer use guide](/docs/guides/tools-computer-use) for more information.\n","required":["type","id","action","call_id","pending_safety_checks","status"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of the computer call. Always `computer_call`.","enum":["computer_call"],"default":"computer_call","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique ID of the computer call.","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.id","typeLabel":"string"},"call_id":{"type":"string","description":"An identifier used when responding to the tool call with output.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.call_id","typeLabel":"string"},"action":{"oneOf":[{"type":"object","title":"Click","description":"A click action.\n","required":["type","button","x","y"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["click"],"default":"click","description":"Specifies the event type. For a click action, this property is \nalways set to `click`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.0.type","typeLabel":"enum\u003cstring>"},"button":{"type":"string","enum":["left","right","wheel","back","forward"],"description":"Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.0.button","typeLabel":"enum\u003cstring>"},"x":{"type":"integer","description":"The x-coordinate where the click occurred.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.0.x","typeLabel":"integer"},"y":{"type":"integer","description":"The y-coordinate where the click occurred.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.0.y","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.0","typeLabel":"Click · object"},{"type":"object","title":"DoubleClick","description":"A double click action.\n","required":["type","x","y"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["double_click"],"default":"double_click","description":"Specifies the event type. For a double click action, this property is \nalways set to `double_click`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.1.type","typeLabel":"enum\u003cstring>"},"x":{"type":"integer","description":"The x-coordinate where the double click occurred.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.1.x","typeLabel":"integer"},"y":{"type":"integer","description":"The y-coordinate where the double click occurred.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.1.y","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.1","typeLabel":"DoubleClick · object"},{"type":"object","title":"Drag","description":"A drag action.\n","required":["type","path"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["drag"],"default":"drag","description":"Specifies the event type. For a drag action, this property is \nalways set to `drag`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.2.type","typeLabel":"enum\u003cstring>"},"path":{"type":"array","description":"An array of coordinates representing the path of the drag action. Coordinates will appear as an array\nof objects, eg\n```\n[\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n]\n```\n","x-oaiExpandable":true,"items":{"type":"object","title":"Drag path coordinates","description":"A series of x/y coordinate pairs in the drag path.\n","properties":{"x":{"type":"integer","description":"The x-coordinate.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.2.path.items.[INDEX].x","typeLabel":"integer"},"y":{"type":"integer","description":"The y-coordinate.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.2.path.items.[INDEX].y","typeLabel":"integer"}},"required":["x","y"],"x-oaiExpandable":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.2.path.items.[INDEX]","typeLabel":"Drag path coordinates · object"},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.2.path","typeLabel":"Drag path coordinates · object[]"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.2","typeLabel":"Drag · object"},{"type":"object","title":"KeyPress","description":"A collection of keypresses the model would like to perform.\n","required":["type","keys"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["keypress"],"default":"keypress","description":"Specifies the event type. For a keypress action, this property is \nalways set to `keypress`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.3.type","typeLabel":"enum\u003cstring>"},"keys":{"type":"array","items":{"type":"string","description":"One of the keys the model is requesting to be pressed.\n","uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.3.keys.items.[INDEX]","typeLabel":"string"},"description":"The combination of keys the model is requesting to be pressed. This is an\narray of strings, each representing a key.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.3.keys","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.3","typeLabel":"KeyPress · object"},{"type":"object","title":"Move","description":"A mouse move action.\n","required":["type","x","y"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["move"],"default":"move","description":"Specifies the event type. For a move action, this property is \nalways set to `move`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.4.type","typeLabel":"enum\u003cstring>"},"x":{"type":"integer","description":"The x-coordinate to move to.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.4.x","typeLabel":"integer"},"y":{"type":"integer","description":"The y-coordinate to move to.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.4.y","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.4","typeLabel":"Move · object"},{"type":"object","title":"Screenshot","description":"A screenshot action.\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["screenshot"],"default":"screenshot","description":"Specifies the event type. For a screenshot action, this property is \nalways set to `screenshot`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.5","typeLabel":"Screenshot · object"},{"type":"object","title":"Scroll","description":"A scroll action.\n","required":["type","x","y","scroll_x","scroll_y"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["scroll"],"default":"scroll","description":"Specifies the event type. For a scroll action, this property is \nalways set to `scroll`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.6.type","typeLabel":"enum\u003cstring>"},"x":{"type":"integer","description":"The x-coordinate where the scroll occurred.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.6.x","typeLabel":"integer"},"y":{"type":"integer","description":"The y-coordinate where the scroll occurred.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.6.y","typeLabel":"integer"},"scroll_x":{"type":"integer","description":"The horizontal scroll distance.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.6.scroll_x","typeLabel":"integer"},"scroll_y":{"type":"integer","description":"The vertical scroll distance.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.6.scroll_y","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.6","typeLabel":"Scroll · object"},{"type":"object","title":"Type","description":"An action to type in text.\n","required":["type","text"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["type"],"default":"type","description":"Specifies the event type. For a type action, this property is \nalways set to `type`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.7.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text to type.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.7.text","typeLabel":"string"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.7","typeLabel":"Type · object"},{"type":"object","title":"Wait","description":"A wait action.\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["wait"],"default":"wait","description":"Specifies the event type. For a wait action, this property is \nalways set to `wait`.\n","x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.8.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action.oneOf.8","typeLabel":"Wait · object"}],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.action","typeLabel":"Click · object | DoubleClick · object | Drag · object | KeyPress · object | Move · object | Screenshot · object | Scroll · object | Type · object | Wait · object"},"pending_safety_checks":{"type":"array","x-oaiExpandable":true,"items":{"type":"object","description":"A pending safety check for the computer call.\n","properties":{"id":{"type":"string","description":"The ID of the pending safety check.","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.pending_safety_checks.items.[INDEX].id","typeLabel":"string"},"code":{"type":"string","description":"The type of the pending safety check.","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.pending_safety_checks.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Details about the pending safety check.","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.pending_safety_checks.items.[INDEX].message","typeLabel":"string"}},"required":["id","code","message"],"uniqueKey":"output.items.[INDEX].oneOf.4.pending_safety_checks.items.[INDEX]","typeLabel":"object"},"description":"The pending safety checks for the computer call.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.pending_safety_checks","typeLabel":"object[]"},"status":{"type":"string","description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX].oneOf.4","typeLabel":"Computer tool call · object"},{"type":"object","title":"Reasoning","description":"A description of the chain of thought used by a reasoning model while generating\na response.\n","required":["id","summary","type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of the object. Always `reasoning`.\n","enum":["reasoning"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier of the reasoning content.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.5.id","typeLabel":"string"},"summary":{"type":"array","description":"Reasoning text contents.\n","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the object. Always `summary_text`.\n","enum":["summary_text"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.5.summary.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"A short summary of the reasoning used by the model when generating\nthe response.\n","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.5.summary.items.[INDEX].text","typeLabel":"string"}},"required":["type","text"],"uniqueKey":"output.items.[INDEX].oneOf.5.summary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.5.summary","typeLabel":"object[]"},"status":{"type":"string","description":"The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n","enum":["in_progress","completed","incomplete"],"uniqueKey":"output.items.[INDEX].oneOf.5.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX].oneOf.5","typeLabel":"Reasoning · object"}],"uniqueKey":"output.items.[INDEX]","typeLabel":"Output message · object | File search tool call · object | Function tool call · object | Web search tool call · object | Computer tool call · object | Reasoning · object"},"isRequired":true,"uniqueKey":"output","typeLabel":"(Output message · object | File search tool call · object | Function tool call · object | Web search tool call · object | Computer tool call · object | Reasoning · object)[]"},"parallel_tool_calls":{"type":"boolean","description":"Whether to allow the model to run tool calls in parallel.\n","default":true,"isRequired":true,"uniqueKey":"parallel_tool_calls","typeLabel":"boolean"},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n","uniqueKey":"user","typeLabel":"string"},"previous_response_id":{"oneOf":[{"type":"string","description":"The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about \n[conversation state](/docs/guides/conversation-state).\n","uniqueKey":"previous_response_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about \n[conversation state](/docs/guides/conversation-state).\n","uniqueKey":"previous_response_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"previous_response_id","typeLabel":"string | null"},"reasoning":{"oneOf":[{"type":"object","description":"**o-series models only**\n\nConfiguration options for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n","title":"Reasoning","x-oaiExpandable":true,"properties":{"effort":{"oneOf":[{"type":"string","enum":["low","medium","high"],"default":"medium","description":"**o-series models only** \n\nConstrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n","uniqueKey":"reasoning.oneOf.0.effort.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["low","medium","high"],"default":"medium","description":"**o-series models only** \n\nConstrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n","uniqueKey":"reasoning.oneOf.0.effort.oneOf.1","typeLabel":"null"}],"uniqueKey":"reasoning.oneOf.0.effort","typeLabel":"enum\u003cstring> | null"},"generate_summary":{"oneOf":[{"type":"string","description":"**computer_use_preview only**\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `concise` or `detailed`.\n","enum":["concise","detailed"],"uniqueKey":"reasoning.oneOf.0.generate_summary.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"**computer_use_preview only**\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `concise` or `detailed`.\n","enum":["concise","detailed"],"uniqueKey":"reasoning.oneOf.0.generate_summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"reasoning.oneOf.0.generate_summary","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"reasoning.oneOf.0","typeLabel":"Reasoning · object"},{"type":"null","description":"**o-series models only**\n\nConfiguration options for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n","title":"Reasoning","x-oaiExpandable":true,"properties":{"effort":{"oneOf":[{"type":"string","enum":["low","medium","high"],"default":"medium","description":"**o-series models only** \n\nConstrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n"},{"type":"null","enum":["low","medium","high"],"default":"medium","description":"**o-series models only** \n\nConstrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n"}]},"generate_summary":{"oneOf":[{"type":"string","description":"**computer_use_preview only**\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `concise` or `detailed`.\n","enum":["concise","detailed"]},{"type":"null","description":"**computer_use_preview only**\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `concise` or `detailed`.\n","enum":["concise","detailed"]}]}},"uniqueKey":"reasoning.oneOf.1","typeLabel":"null"}],"uniqueKey":"reasoning","typeLabel":"Reasoning · object | null"},"max_output_tokens":{"oneOf":[{"description":"An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"integer","uniqueKey":"max_output_tokens.oneOf.0","typeLabel":"integer"},{"description":"An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"null","uniqueKey":"max_output_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_output_tokens","typeLabel":"integer | null"},"text":{"type":"object","description":"Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Structured Outputs](/docs/guides/structured-outputs)\n","properties":{"format":{"oneOf":[{"type":"object","title":"Text","description":"An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of response format being defined. Always `text`.","enum":["text"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"text.format.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"text.format.oneOf.0","typeLabel":"Text · object"},{"type":"object","title":"JSON schema","description":"An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n","required":["type","schema"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of response format being defined. Always `json_schema`.","enum":["json_schema"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"text.format.oneOf.1.type","typeLabel":"enum\u003cstring>"},"schema":{"type":"object","title":"JSON schema","description":"The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n","additionalProperties":true,"isRequired":true,"uniqueKey":"text.format.oneOf.1.schema","typeLabel":"JSON schema · object"},"description":{"type":"string","description":"A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n","uniqueKey":"text.format.oneOf.1.description","typeLabel":"string"},"name":{"type":"string","description":"The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n","uniqueKey":"text.format.oneOf.1.name","typeLabel":"string"},"strict":{"oneOf":[{"type":"boolean","default":false,"description":"Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n","uniqueKey":"text.format.oneOf.1.strict.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n","uniqueKey":"text.format.oneOf.1.strict.oneOf.1","typeLabel":"null"}],"uniqueKey":"text.format.oneOf.1.strict","typeLabel":"boolean | null"}},"uniqueKey":"text.format.oneOf.1","typeLabel":"JSON schema · object"},{"type":"object","title":"JSON object","description":"An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of response format being defined. Always `json_object`.","enum":["json_object"],"x-stainless-const":true,"isRequired":true,"uniqueKey":"text.format.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"text.format.oneOf.2","typeLabel":"JSON object · object"}],"uniqueKey":"text.format","typeLabel":"Text · object | JSON schema · object | JSON object · object"}},"uniqueKey":"text","typeLabel":"object"},"truncation":{"oneOf":[{"type":"string","description":"The truncation strategy to use for the model response.\n- `auto`: If the context of this response and previous ones exceeds\n the model's context window size, the model will truncate the \n response to fit the context window by dropping input items in the\n middle of the conversation. \n- `disabled` (default): If a model response will exceed the context window \n size for a model, the request will fail with a 400 error.\n","enum":["auto","disabled"],"default":"disabled","uniqueKey":"truncation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The truncation strategy to use for the model response.\n- `auto`: If the context of this response and previous ones exceeds\n the model's context window size, the model will truncate the \n response to fit the context window by dropping input items in the\n middle of the conversation. \n- `disabled` (default): If a model response will exceed the context window \n size for a model, the request will fail with a 400 error.\n","enum":["auto","disabled"],"default":"disabled","uniqueKey":"truncation.oneOf.1","typeLabel":"null"}],"uniqueKey":"truncation","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","description":"The status of the response generation. One of `completed`, `failed`, \n`in_progress`, or `incomplete`.\n","enum":["completed","failed","in_progress","incomplete"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"output_text":{"oneOf":[{"type":"string","description":"SDK-only convenience property that contains the aggregated text output \nfrom all `output_text` items in the `output` array, if any are present. \nSupported in the Python and JavaScript SDKs.\n","x-oaiSupportedSDKs":["python","javascript"],"uniqueKey":"output_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"SDK-only convenience property that contains the aggregated text output \nfrom all `output_text` items in the `output` array, if any are present. \nSupported in the Python and JavaScript SDKs.\n","x-oaiSupportedSDKs":["python","javascript"],"uniqueKey":"output_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"output_text","typeLabel":"string | null"},"usage":{"type":"object","description":"Represents token usage details including input tokens, output tokens,\na breakdown of output tokens, and the total tokens used.\n","properties":{"input_tokens":{"type":"integer","description":"The number of input tokens.","isRequired":true,"uniqueKey":"usage.input_tokens","typeLabel":"integer"},"input_tokens_details":{"type":"object","description":"A detailed breakdown of the input tokens.","properties":{"cached_tokens":{"type":"integer","description":"The number of tokens that were retrieved from the cache. \n[More on prompt caching](/docs/guides/prompt-caching).\n","isRequired":true,"uniqueKey":"usage.input_tokens_details.cached_tokens","typeLabel":"integer"}},"required":["cached_tokens"],"isRequired":true,"uniqueKey":"usage.input_tokens_details","typeLabel":"object"},"output_tokens":{"type":"integer","description":"The number of output tokens.","isRequired":true,"uniqueKey":"usage.output_tokens","typeLabel":"integer"},"output_tokens_details":{"type":"object","description":"A detailed breakdown of the output tokens.","properties":{"reasoning_tokens":{"type":"integer","description":"The number of reasoning tokens.","isRequired":true,"uniqueKey":"usage.output_tokens_details.reasoning_tokens","typeLabel":"integer"}},"required":["reasoning_tokens"],"isRequired":true,"uniqueKey":"usage.output_tokens_details","typeLabel":"object"},"total_tokens":{"type":"integer","description":"The total number of tokens used.","isRequired":true,"uniqueKey":"usage.total_tokens","typeLabel":"integer"}},"required":["input_tokens","input_tokens_details","output_tokens","output_tokens_details","total_tokens"],"uniqueKey":"usage","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"metadata":{},"temperature":1,"top_p":1,"model":"gpt-4o","instructions":"\u003cstring>","tools":[{"type":"file_search","vector_store_ids":["\u003cstring>"],"max_num_results":123,"filters":{"type":"eq","key":"\u003cstring>","value":"\u003cstring>"},"ranking_options":{"ranker":"auto","score_threshold":0}}],"tool_choice":"none","id":"\u003cstring>","object":"response","created_at":123,"error":{"code":"server_error","message":"\u003cstring>"},"incomplete_details":{"reason":"max_output_tokens"},"output":[{"id":"\u003cstring>","type":"message","role":"assistant","content":[{"type":"output_text","text":"\u003cstring>","annotations":[{"type":"file_citation","index":123,"file_id":"\u003cstring>"}]}],"status":"in_progress"}],"parallel_tool_calls":true,"user":"user-1234","previous_response_id":"\u003cstring>","reasoning":{"effort":"medium","generate_summary":"concise"},"max_output_tokens":123,"text":{"format":{"type":"text"}},"truncation":"disabled","status":"completed","output_text":"\u003cstring>","usage":{"input_tokens":123,"input_tokens_details":{"cached_tokens":123},"output_tokens":123,"output_tokens_details":{"reasoning_tokens":123},"total_tokens":123}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0a39a621-96fb-4cc7-a41c-1678aaeda3a9":{"Portkey-Key":{"type":"apiKey","in":"header","name":"x-portkey-api-key","scopes":[],"schemeName":"Portkey-Key"}}},"servers":{"904f68fe-5e29-4f26-8ddc-97ed98e0aa9a":{"url":"https://api.portkey.ai/v1","description":"Portkey API Public Endpoint"},"149303d8-a0a9-41d8-8a01-182fd472895a":{"url":"SELF_HOSTED_GATEWAY_URL","description":"Self-Hosted Gateway URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-portkey-api-key","scopes":[],"schemeName":"Portkey-Key"},"schema":{"title":"x-portkey-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Portkey-Key","name":"x-portkey-api-key"}],"title":"Portkey-Key"}]},"originalFileLocation":"https://raw.githubusercontent.com/Portkey-AI/openapi/refs/heads/master/openapi.yaml"},"subdomain":"portkey-docs","siteName":"Portkey (Prisma AIRS AI Gateway) Docs","title":"Get a Response - Portkey (Prisma AIRS AI Gateway) Docs","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6aa971b90031bd0287c96632","deploymentId":"67086365a151447bf2fa5021","questionText":"How do I retrieve a response?","status":"active","generatedBy":"contextual","path":"api-reference/inference-api/responses/retrieve-response","createdAt":"2026-09-15T16:26:33.599Z","updatedAt":"2026-09-15T16:26:33.599Z","__v":0},{"_id":"6aa971b90031bd0287c96633","deploymentId":"67086365a151447bf2fa5021","questionText":"What is the response API?","status":"active","generatedBy":"contextual","path":"api-reference/inference-api/responses/retrieve-response","createdAt":"2026-09-15T16:26:33.599Z","updatedAt":"2026-09-15T16:26:33.599Z","__v":0},{"_id":"6aa971b90031bd0287c96634","deploymentId":"67086365a151447bf2fa5021","questionText":"How do I use this endpoint?","status":"active","generatedBy":"contextual","path":"api-reference/inference-api/responses/retrieve-response","createdAt":"2026-09-15T16:26:33.599Z","updatedAt":"2026-09-15T16:26:33.599Z","__v":0}],"navMaps":{"firstHrefInVersion":{"Latest":{"href":"/api-reference/inference-api/responses/retrieve-response","matchLevel":0},"Prisma AIRS":{"href":"/aigw/introduction/welcome","matchLevel":4},"Virtual Keys (Deprecated)":{"href":"/api-reference/inference-api/responses/retrieve-response","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-15T13:55:28.644Z","gitLastModified":"2026-08-06T05:55:04.000Z","originalFileLocation":"api-reference/inference-api/responses/retrieve-response.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a Response - Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Portkey AI Gateway Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://portkey-docs.mintlify.app/_mintlify/api/og/v2?division=Responses\u0026amp;title=Get+a+Response\u0026amp;theme=262137c9f2583e48984715e7\u0026amp;signature=245d4571290372f0dfb481f8d4766b7c956fd4cbc6beaa2e34f4309f4e2d1872\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a Response - Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://portkey-docs.mintlify.app/_mintlify/api/og/v2?division=Responses\u0026amp;title=Get+a+Response\u0026amp;theme=262137c9f2583e48984715e7\u0026amp;signature=245d4571290372f0dfb481f8d4766b7c956fd4cbc6beaa2e34f4309f4e2d1872\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0891B2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/inference-api/responses/retrieve-response.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.portkey.ai/#organization\",\"name\":\"Portkey (Prisma AIRS AI Gateway) Docs\",\"url\":\"https://docs.portkey.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/portkey-docs/tHk-hgNjLbEj4dhh/images/portkey-PANW-company-logo-positive.png?fit=max\u0026auto=format\u0026n=tHk-hgNjLbEj4dhh\u0026q=85\u0026s=c5fb09014ff79616583b1d3bffe27450\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.portkey.ai/docs#website\",\"name\":\"Portkey (Prisma AIRS AI Gateway) Docs\",\"url\":\"https://docs.portkey.ai/docs\",\"publisher\":{\"@id\":\"https://docs.portkey.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response#webpage\",\"url\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response\",\"name\":\"Get a Response\",\"dateModified\":\"2026-08-06T05:55:04.000Z\",\"isPartOf\":{\"@id\":\"https://docs.portkey.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Responses\",\"item\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/responses\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a Response\",\"item\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response#apireference\",\"headline\":\"Get a Response\",\"name\":\"Get a Response\",\"url\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response\",\"mainEntityOfPage\":{\"@id\":\"https://docs.portkey.ai/docs/api-reference/inference-api/responses/retrieve-response#webpage\"},\"dateModified\":\"2026-08-06T05:55:04.000Z\",\"publisher\":{\"@id\":\"https://docs.portkey.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.portkey.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Portkey (Prisma AIRS AI Gateway) Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Portkey (Prisma AIRS AI Gateway) Docs","nav":{"global":null,"versions":[{"version":"Latest","tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/introduction/what-is-portkey"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/ecosystem"}]},{"tab":"Gateway APIs","groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/inference-api/introduction"},{"title":"Agentic Usage","href":"/api-reference/inference-api/agentic-usage"},{"title":"Supported Providers","href":"/api-reference/inference-api/supported-providers"},{"title":"Authentication","href":"/api-reference/inference-api/authentication"},{"title":"Headers","href":"/api-reference/inference-api/headers"},{"title":"Errors","href":"/api-reference/inference-api/error-codes"},{"title":"Response Schema","href":"/api-reference/inference-api/response-schema"},{"group":"More","pages":[{"title":"Gateway Config Object","href":"/api-reference/inference-api/config-object"},{"title":"OpenAPI Specification","url":"https://github.com/Portkey-AI/openapi","href":"/api-reference/inference-api/open-api-specification"}]}]},{"group":"SDK","pages":[{"title":"Supported SDKs","href":"/api-reference/sdk/list"},{"title":"Python","href":"/api-reference/sdk/python"},{"title":"Node.js","href":"/api-reference/sdk/node"},{"title":"C# (.NET)","href":"/api-reference/sdk/c-sharp"}]},{"group":"Chat Completions","pages":[{"title":"Chat","openapi":"post /chat/completions","href":"/api-reference/inference-api/chat"}]},{"group":"Responses","pages":[{"title":"Create a Response","openapi":"post /responses","description":"","href":"/api-reference/inference-api/responses/responses"},{"title":"Get a Response","openapi":"get /responses/{response_id}","href":"/api-reference/inference-api/responses/retrieve-response"},{"title":"Delete a Response","openapi":"delete /responses/{response_id}","description":"","href":"/api-reference/inference-api/responses/delete-response"},{"title":"List Input Items","openapi":"get /responses/{response_id}/input_items","href":"/api-reference/inference-api/responses/retrieve-inputs"}]},{"group":"Portkey Endpoints","pages":[{"title":"Prompt Completions","openapi":"post /prompts/{promptId}/completions","href":"/api-reference/inference-api/prompts/prompt-completion"},{"title":"Prompt Render","openapi":"post /prompts/{promptId}/render","href":"/api-reference/inference-api/prompts/render"},{"title":"Insert a Log","openapi":"post /logs","href":"/api-reference/admin-api/data-plane/logs/insert-a-log"},{"title":"Create Feedback","openapi":"post /feedback","href":"/api-reference/admin-api/data-plane/feedback/create-feedback"},{"title":"Update Feedback","openapi":"put /feedback/{id}","href":"/api-reference/admin-api/data-plane/feedback/update-feedback"},{"group":"Log Exports","pages":[{"title":"Retrieve a Log Export","openapi":"get /logs/exports/{exportId}","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/retrieve-a-log-export"},{"title":"Update a Log Export","openapi":"put /logs/exports/{exportId}","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/update-a-log-export"},{"title":"List a Log Export","openapi":"get /logs/exports","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/list-log-exports"},{"title":"Create a Log Export","openapi":"post /logs/exports","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/create-a-log-export"},{"title":"Start a Log Export","openapi":"post /logs/exports/{exportId}/start","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/start-a-log-export"},{"title":"Cancel a Log Export","openapi":"post /logs/exports/{exportId}/cancel","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/cancel-a-log-export"},{"title":"Delete a Log Export","openapi":"delete /logs/exports/{exportId}","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/delete-a-log-export"},{"title":"Download a Log Export","openapi":"get /logs/exports/{exportId}/download","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/download-a-log-export"}]}]},{"group":"Embeddings","pages":[{"title":"Embeddings","openapi":"post /embeddings","href":"/api-reference/inference-api/embeddings"}]},{"group":"Rerank","pages":[{"title":"Rerank","openapi":"post /rerank","href":"/api-reference/inference-api/rerank"}]},{"group":"Decisions","pages":[{"title":"Decisions","openapi":"post /decisions","href":"/api-reference/inference-api/decisions"}]},{"group":"OCR","pages":[{"title":"OCR","openapi":"post /ocr","href":"/api-reference/inference-api/ocr"}]},{"group":"Images","pages":[{"title":"Create Image","openapi":"post /images/generations","href":"/api-reference/inference-api/images/create-image"},{"title":"Create Image Edit","openapi":"post /images/edits","href":"/api-reference/inference-api/images/create-image-edit"},{"title":"Create Image Variation","openapi":"post /images/variations","href":"/api-reference/inference-api/images/create-image-variation"}]},{"group":"Models","pages":[{"title":"Models","openapi":"get /models","href":"/api-reference/inference-api/models/models"}]},{"group":"Audio","pages":[{"title":"Create Speech","openapi":"post /audio/speech","href":"/api-reference/inference-api/audio/create-speech"},{"title":"Create Transcription","openapi":"post /audio/transcriptions","href":"/api-reference/inference-api/audio/create-transcription"},{"title":"Create Translation","openapi":"post /audio/translations","href":"/api-reference/inference-api/audio/create-translation"}]},{"group":"Other APIs","pages":[{"title":"Gateway to Other APIs","icon":"chart-network","href":"/api-reference/inference-api/gateway-for-other-apis"}]},{"group":"Completions","pages":[{"title":"Completions","openapi":"post /completions","href":"/api-reference/inference-api/completions"}]},{"group":"Moderations","pages":[{"title":"Moderations","openapi":"post /moderations","href":"/api-reference/inference-api/moderations"}]},{"group":"Fine-tuning","pages":[{"title":"Create Fine-tuning Job","openapi":"post /fine_tuning/jobs","href":"/api-reference/inference-api/fine-tuning/create-fine-tuning-job"},{"title":"List Fine-tuning Jobs","openapi":"get /fine_tuning/jobs","href":"/api-reference/inference-api/fine-tuning/list-fine-tuning-jobs"},{"title":"Retrieve Fine-tuning Job","openapi":"get /fine_tuning/jobs/{fine_tuning_job_id}","href":"/api-reference/inference-api/fine-tuning/retrieve-fine-tuning-job"},{"title":"List Fine-tuning Events","openapi":"get /fine_tuning/jobs/{fine_tuning_job_id}/events","href":"/api-reference/inference-api/fine-tuning/list-fine-tuning-events"},{"title":"List Fine-tuning Checkpoints","openapi":"get /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints","href":"/api-reference/inference-api/fine-tuning/list-fine-tuning-checkpoints"},{"title":"Cancel Fine-tuning","openapi":"post /fine_tuning/jobs/{fine_tuning_job_id}/cancel","href":"/api-reference/inference-api/fine-tuning/cancel-fine-tuning"}]},{"group":"Batch","pages":[{"title":"Create Batch","openapi":"post /batches","href":"/api-reference/inference-api/batch/create-batch"},{"title":"List Batch","openapi":"get /batches","href":"/api-reference/inference-api/batch/list-batch"},{"title":"Retrieve Batch","openapi":"get /batches/{batch_id}","href":"/api-reference/inference-api/batch/retrieve-batch"},{"title":"Cancel Batch","openapi":"post /batches/{batch_id}/cancel","href":"/api-reference/inference-api/batch/cancel-batch"}]},{"group":"Files","pages":[{"title":"Upload File","openapi":"post /files","href":"/api-reference/inference-api/files/upload-file"},{"title":"List Files","openapi":"get /files","href":"/api-reference/inference-api/files/list-files"},{"title":"Retrieve File","openapi":"get /files/{file_id}","href":"/api-reference/inference-api/files/retrieve-file"},{"title":"Retrieve File Content","openapi":"get /files/{file_id}/content","href":"/api-reference/inference-api/files/retrieve-file-content"},{"title":"Delete File","openapi":"delete /files/{file_id}","href":"/api-reference/inference-api/files/delete-file"}]},{"group":"Assistants","pages":[{"group":"Assistants","pages":[{"title":"Create Assistant","openapi":"post /assistants","href":"/api-reference/inference-api/assistants-api/assistants/create-assistant"},{"title":"List Assistant","openapi":"get /assistants","href":"/api-reference/inference-api/assistants-api/assistants/list-assistants"},{"title":"Retrieve Assistant","openapi":"get /assistants/{assistant_id}","href":"/api-reference/inference-api/assistants-api/assistants/retrieve-assistant"},{"title":"Modify Assistant","openapi":"post /assistants/{assistant_id}","href":"/api-reference/inference-api/assistants-api/assistants/modify-assistant"},{"title":"Delete Assistant","openapi":"delete /assistants/{assistant_id}","href":"/api-reference/inference-api/assistants-api/assistants/delete-assistant"}]},{"group":"Threads","pages":[{"title":"Create Thread","openapi":"post /threads","href":"/api-reference/inference-api/assistants-api/threads/create-thread"},{"title":"Retrieve Thread","openapi":"get /threads/{thread_id}","href":"/api-reference/inference-api/assistants-api/threads/retrieve-thread"},{"title":"Modify Thread","openapi":"post /threads/{thread_id}","href":"/api-reference/inference-api/assistants-api/threads/modify-thread"},{"title":"Delete Thread","openapi":"delete /threads/{thread_id}","href":"/api-reference/inference-api/assistants-api/threads/delete-thread"}]},{"group":"Messages","pages":[{"title":"Create Message","openapi":"post /threads/{thread_id}/messages","href":"/api-reference/inference-api/assistants-api/messages/create-message"},{"title":"List Message","openapi":"get /threads/{thread_id}/messages","href":"/api-reference/inference-api/assistants-api/messages/list-messages"},{"title":"Retrieve Message","openapi":"get /threads/{thread_id}/messages/{message_id}","href":"/api-reference/inference-api/assistants-api/messages/retrieve-message"},{"title":"Modify Message","openapi":"post /threads/{thread_id}/messages/{message_id}","href":"/api-reference/inference-api/assistants-api/messages/modify-message"},{"title":"Delete Message","openapi":"delete /threads/{thread_id}/messages/{message_id}","href":"/api-reference/inference-api/assistants-api/messages/delete-message"}]},{"group":"Runs","pages":[{"title":"Create Run","openapi":"post /threads/{thread_id}/runs","href":"/api-reference/inference-api/assistants-api/runs/create-run"},{"title":"Create thread and Run","openapi":"post /threads/runs","href":"/api-reference/inference-api/assistants-api/runs/create-thread-and-run"},{"title":"list Run","openapi":"get /threads/{thread_id}/runs","href":"/api-reference/inference-api/assistants-api/runs/list-runs"},{"title":"Retrieve Run","openapi":"get /threads/{thread_id}/runs/{run_id}","href":"/api-reference/inference-api/assistants-api/runs/retrieve-run"},{"title":"Modify Run","openapi":"post /threads/{thread_id}/runs/{run_id}","href":"/api-reference/inference-api/assistants-api/runs/modify-run"},{"title":"Submit Tool Outputs to Run","openapi":"post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs","href":"/api-reference/inference-api/assistants-api/runs/submit-tool-outputs-to-run"},{"title":"Cancel Run","openapi":"post /threads/{thread_id}/runs/{run_id}/cancel","href":"/api-reference/inference-api/assistants-api/runs/cancel-run"}]},{"group":"Run Steps","pages":[{"title":"List Run Steps","openapi":"get /threads/{thread_id}/runs/{run_id}/steps","href":"/api-reference/inference-api/assistants-api/run-steps/list-run-steps"},{"title":"Retrieve Run Steps","openapi":"get /threads/{thread_id}/runs/{run_id}/steps/{step_id}","href":"/api-reference/inference-api/assistants-api/run-steps/retrieve-run-steps"}]}]}]},{"tab":"Admin APIs","pages":[{"title":"Admin APIs","href":"/api-reference/admin-api/introduction"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/guides/use-cases/run-batch-evals"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026/september"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help-center/you-do-not-have-enough-permissions"}]}]},{"version":"Prisma AIRS","pages":[{"title":"Prisma AIRS","href":"/aigw/introduction/welcome"}]},{"version":"Virtual Keys (Deprecated)","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/virtual_key_old/introduction/what-is-portkey"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/virtual_key_old/integrations/ecosystem"}]},{"tab":"Inference API","groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/inference-api/introduction"},{"title":"Agentic Usage","href":"/api-reference/inference-api/agentic-usage"},{"title":"Supported Providers","href":"/api-reference/inference-api/supported-providers"},{"title":"Authentication","href":"/api-reference/inference-api/authentication"},{"title":"Headers","href":"/api-reference/inference-api/headers"},{"title":"Errors","href":"/api-reference/inference-api/error-codes"},{"title":"Response Schema","href":"/api-reference/inference-api/response-schema"},{"group":"More","pages":[{"title":"Gateway Config Object","href":"/api-reference/inference-api/config-object"},{"title":"OpenAPI Specification","url":"https://github.com/Portkey-AI/openapi","href":"/api-reference/inference-api/open-api-specification"}]}]},{"group":"SDK","pages":[{"title":"Supported SDKs","href":"/api-reference/sdk/list"},{"title":"Python","href":"/api-reference/sdk/python"},{"title":"Node.js","href":"/api-reference/sdk/node"},{"title":"C# (.NET)","href":"/api-reference/sdk/c-sharp"}]},{"group":"Chat Completions","pages":[{"title":"Chat","openapi":"post /chat/completions","href":"/api-reference/inference-api/chat"}]},{"group":"Responses","pages":[{"title":"Create a Response","openapi":"post /responses","description":"","href":"/api-reference/inference-api/responses/responses"},{"title":"Get a Response","openapi":"get /responses/{response_id}","href":"/api-reference/inference-api/responses/retrieve-response"},{"title":"Delete a Response","openapi":"delete /responses/{response_id}","description":"","href":"/api-reference/inference-api/responses/delete-response"},{"title":"List Input Items","openapi":"get /responses/{response_id}/input_items","href":"/api-reference/inference-api/responses/retrieve-inputs"}]},{"group":"Portkey Endpoints","pages":[{"title":"Prompt Completions","openapi":"post /prompts/{promptId}/completions","href":"/api-reference/inference-api/prompts/prompt-completion"},{"title":"Prompt Render","openapi":"post /prompts/{promptId}/render","href":"/api-reference/inference-api/prompts/render"},{"title":"Insert a Log","openapi":"post /logs","href":"/api-reference/admin-api/data-plane/logs/insert-a-log"},{"title":"Create Feedback","openapi":"post /feedback","href":"/api-reference/admin-api/data-plane/feedback/create-feedback"},{"title":"Update Feedback","openapi":"put /feedback/{id}","href":"/api-reference/admin-api/data-plane/feedback/update-feedback"},{"group":"Log Exports","pages":[{"title":"Retrieve a Log Export","openapi":"get /logs/exports/{exportId}","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/retrieve-a-log-export"},{"title":"Update a Log Export","openapi":"put /logs/exports/{exportId}","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/update-a-log-export"},{"title":"List a Log Export","openapi":"get /logs/exports","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/list-log-exports"},{"title":"Create a Log Export","openapi":"post /logs/exports","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/create-a-log-export"},{"title":"Start a Log Export","openapi":"post /logs/exports/{exportId}/start","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/start-a-log-export"},{"title":"Cancel a Log Export","openapi":"post /logs/exports/{exportId}/cancel","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/cancel-a-log-export"},{"title":"Delete a Log Export","openapi":"delete /logs/exports/{exportId}","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/delete-a-log-export"},{"title":"Download a Log Export","openapi":"get /logs/exports/{exportId}/download","href":"/api-reference/admin-api/data-plane/logs/log-exports-beta/download-a-log-export"}]}]},{"group":"Embeddings","pages":[{"title":"Embeddings","openapi":"post /embeddings","href":"/api-reference/inference-api/embeddings"}]},{"group":"Rerank","pages":[{"title":"Rerank","openapi":"post /rerank","href":"/api-reference/inference-api/rerank"}]},{"group":"Decisions","pages":[{"title":"Decisions","openapi":"post /decisions","href":"/api-reference/inference-api/decisions"}]},{"group":"OCR","pages":[{"title":"OCR","openapi":"post /ocr","href":"/api-reference/inference-api/ocr"}]},{"group":"Images","pages":[{"title":"Create Image","openapi":"post /images/generations","href":"/api-reference/inference-api/images/create-image"},{"title":"Create Image Edit","openapi":"post /images/edits","href":"/api-reference/inference-api/images/create-image-edit"},{"title":"Create Image Variation","openapi":"post /images/variations","href":"/api-reference/inference-api/images/create-image-variation"}]},{"group":"Audio","pages":[{"title":"Create Speech","openapi":"post /audio/speech","href":"/api-reference/inference-api/audio/create-speech"},{"title":"Create Transcription","openapi":"post /audio/transcriptions","href":"/api-reference/inference-api/audio/create-transcription"},{"title":"Create Translation","openapi":"post /audio/translations","href":"/api-reference/inference-api/audio/create-translation"}]},{"group":"Other APIs","pages":[{"title":"Gateway to Other APIs","icon":"chart-network","href":"/api-reference/inference-api/gateway-for-other-apis"}]},{"group":"Completions","pages":[{"title":"Completions","openapi":"post /completions","href":"/api-reference/inference-api/completions"}]},{"group":"Moderations","pages":[{"title":"Moderations","openapi":"post /moderations","href":"/api-reference/inference-api/moderations"}]},{"group":"Fine-tuning","pages":[{"title":"Create Fine-tuning Job","openapi":"post /fine_tuning/jobs","href":"/api-reference/inference-api/fine-tuning/create-fine-tuning-job"},{"title":"List Fine-tuning Jobs","openapi":"get /fine_tuning/jobs","href":"/api-reference/inference-api/fine-tuning/list-fine-tuning-jobs"},{"title":"Retrieve Fine-tuning Job","openapi":"get /fine_tuning/jobs/{fine_tuning_job_id}","href":"/api-reference/inference-api/fine-tuning/retrieve-fine-tuning-job"},{"title":"List Fine-tuning Events","openapi":"get /fine_tuning/jobs/{fine_tuning_job_id}/events","href":"/api-reference/inference-api/fine-tuning/list-fine-tuning-events"},{"title":"List Fine-tuning Checkpoints","openapi":"get /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints","href":"/api-reference/inference-api/fine-tuning/list-fine-tuning-checkpoints"},{"title":"Cancel Fine-tuning","openapi":"post /fine_tuning/jobs/{fine_tuning_job_id}/cancel","href":"/api-reference/inference-api/fine-tuning/cancel-fine-tuning"}]},{"group":"Batch","pages":[{"title":"Create Batch","openapi":"post /batches","href":"/api-reference/inference-api/batch/create-batch"},{"title":"List Batch","openapi":"get /batches","href":"/api-reference/inference-api/batch/list-batch"},{"title":"Retrieve Batch","openapi":"get /batches/{batch_id}","href":"/api-reference/inference-api/batch/retrieve-batch"},{"title":"Cancel Batch","openapi":"post /batches/{batch_id}/cancel","href":"/api-reference/inference-api/batch/cancel-batch"}]},{"group":"Files","pages":[{"title":"Upload File","openapi":"post /files","href":"/api-reference/inference-api/files/upload-file"},{"title":"List Files","openapi":"get /files","href":"/api-reference/inference-api/files/list-files"},{"title":"Retrieve File","openapi":"get /files/{file_id}","href":"/api-reference/inference-api/files/retrieve-file"},{"title":"Retrieve File Content","openapi":"get /files/{file_id}/content","href":"/api-reference/inference-api/files/retrieve-file-content"},{"title":"Delete File","openapi":"delete /files/{file_id}","href":"/api-reference/inference-api/files/delete-file"}]},{"group":"Assistants","pages":[{"group":"Assistants","pages":[{"title":"Create Assistant","openapi":"post /assistants","href":"/api-reference/inference-api/assistants-api/assistants/create-assistant"},{"title":"List Assistant","openapi":"get /assistants","href":"/api-reference/inference-api/assistants-api/assistants/list-assistants"},{"title":"Retrieve Assistant","openapi":"get /assistants/{assistant_id}","href":"/api-reference/inference-api/assistants-api/assistants/retrieve-assistant"},{"title":"Modify Assistant","openapi":"post /assistants/{assistant_id}","href":"/api-reference/inference-api/assistants-api/assistants/modify-assistant"},{"title":"Delete Assistant","openapi":"delete /assistants/{assistant_id}","href":"/api-reference/inference-api/assistants-api/assistants/delete-assistant"}]},{"group":"Threads","pages":[{"title":"Create Thread","openapi":"post /threads","href":"/api-reference/inference-api/assistants-api/threads/create-thread"},{"title":"Retrieve Thread","openapi":"get /threads/{thread_id}","href":"/api-reference/inference-api/assistants-api/threads/retrieve-thread"},{"title":"Modify Thread","openapi":"post /threads/{thread_id}","href":"/api-reference/inference-api/assistants-api/threads/modify-thread"},{"title":"Delete Thread","openapi":"delete /threads/{thread_id}","href":"/api-reference/inference-api/assistants-api/threads/delete-thread"}]},{"group":"Messages","pages":[{"title":"Create Message","openapi":"post /threads/{thread_id}/messages","href":"/api-reference/inference-api/assistants-api/messages/create-message"},{"title":"List Message","openapi":"get /threads/{thread_id}/messages","href":"/api-reference/inference-api/assistants-api/messages/list-messages"},{"title":"Retrieve Message","openapi":"get /threads/{thread_id}/messages/{message_id}","href":"/api-reference/inference-api/assistants-api/messages/retrieve-message"},{"title":"Modify Message","openapi":"post /threads/{thread_id}/messages/{message_id}","href":"/api-reference/inference-api/assistants-api/messages/modify-message"},{"title":"Delete Message","openapi":"delete /threads/{thread_id}/messages/{message_id}","href":"/api-reference/inference-api/assistants-api/messages/delete-message"}]},{"group":"Runs","pages":[{"title":"Create Run","openapi":"post /threads/{thread_id}/runs","href":"/api-reference/inference-api/assistants-api/runs/create-run"},{"title":"Create thread and Run","openapi":"post /threads/runs","href":"/api-reference/inference-api/assistants-api/runs/create-thread-and-run"},{"title":"list Run","openapi":"get /threads/{thread_id}/runs","href":"/api-reference/inference-api/assistants-api/runs/list-runs"},{"title":"Retrieve Run","openapi":"get /threads/{thread_id}/runs/{run_id}","href":"/api-reference/inference-api/assistants-api/runs/retrieve-run"},{"title":"Modify Run","openapi":"post /threads/{thread_id}/runs/{run_id}","href":"/api-reference/inference-api/assistants-api/runs/modify-run"},{"title":"Submit Tool Outputs to Run","openapi":"post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs","href":"/api-reference/inference-api/assistants-api/runs/submit-tool-outputs-to-run"},{"title":"Cancel Run","openapi":"post /threads/{thread_id}/runs/{run_id}/cancel","href":"/api-reference/inference-api/assistants-api/runs/cancel-run"}]},{"group":"Run Steps","pages":[{"title":"List Run Steps","openapi":"get /threads/{thread_id}/runs/{run_id}/steps","href":"/api-reference/inference-api/assistants-api/run-steps/list-run-steps"},{"title":"Retrieve Run Steps","openapi":"get /threads/{thread_id}/runs/{run_id}/steps/{step_id}","href":"/api-reference/inference-api/assistants-api/run-steps/retrieve-run-steps"}]}]}]},{"tab":"Admin API","pages":[{"title":"Admin API","href":"/api-reference/admin-api/introduction"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/guides/use-cases/run-batch-evals"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2025/may"}]},{"tab":"Help articles","pages":[{"title":"Help articles","href":"/help-center/you-do-not-have-enough-permissions"}]}]}]},"title":"Get a Response - Portkey (Prisma AIRS AI Gateway) Docs","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}