previous_response_id, and item_reference input items: send the history in input instead.
store: true and background: true.
There are no endpoints to retrieve, delete, or cancel a stored response, and no WebSocket transport. Disconnecting a request can still incur usage for generated tokens. See the SDK example for a multi-turn loop.
Reasoning
Set the effort with "reasoning": {"effort": "high"}. Levels a model doesn’t serve round up to the next one it does, and the response echoes the applied level in reasoning.effort. "effort": "none" turns thinking off; GLM-5.3 and GLM-5.3-Flash always think and return 400. max_output_tokens covers the reasoning and the answer. See how effort levels map.
Authorizations
Authorization
string
header
required
Bearer followed by an inference API key (sk-prl-infapi-). Create keys on the API Keys page. Management keys (sk-prl-mgmt-) cannot call models.
Body
application/json
model
string
required
A chat model ID from GET /models. A model that doesn't serve Responses returns 404.
input
stringarray · object[]
required
A string, or an array of input items: messages, plus the output items earlier turns returned (reasoning, function calls) and your function_call_output items. Send the whole history each turn; item references are refused.
instructions
string
A system message for this request.
max_output_tokens
integer
Cap on generated tokens, reasoning included.
stream
boolean
Stream server-sent events instead of one JSON response.
store
enum<boolean>
default:false
Must be false or omitted (omitted is sent as false). Responses are stateless, so true returns 400.
Available options:
false
reasoning
object
{"effort": …}, one of none, minimal, low, medium, high, xhigh, max; see Reasoning.
Show child attributes
tools
object[]
Function tools the model may call. Support varies by model.
The completion, or an event stream when streaming.
id
string
Response ID.
object
enum<string>
Always response.
Available options:
response
created_at
integer
Unix timestamp (seconds).
status
enum<string>
completed, incomplete (stopped early, for example at max_output_tokens), or cancelled. Check it before using output.
Available options:
completed,
incomplete,
cancelled
model
string
The model that served the request.
output
object[]
Output items in order: reasoning models add a reasoning item, then a message with output_text content, or function_call items when the model calls tools. Replay them in the next turn's input.
Show child attributes
usage
object
input_tokens and output_tokens, what you're billed on, with input_tokens_details.cached_tokens and output_tokens_details.reasoning_tokens when the model reports them.
Show child attributes
reasoning
object
Levels a model doesn't serve round up to the next one it does, and the response echoes the applied level in reasoning.effort.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pearl Inference Platform","colors":{"primary":"#2A2623","light":"#EFEDEA","dark":"#2A2623"},"logo":{"light":"https://mintcdn.com/pearl-research/qjVPdghcpi_iWwgo/logo/light.svg?fit=max\u0026auto=format\u0026n=qjVPdghcpi_iWwgo\u0026q=85\u0026s=a969569c61ca3aa40012ac0f3dbbe445","dark":"https://mintcdn.com/pearl-research/qjVPdghcpi_iWwgo/logo/dark.svg?fit=max\u0026auto=format\u0026n=qjVPdghcpi_iWwgo\u0026q=85\u0026s=eacd546258e1218dea6ff14f55e89b4c"},"favicon":{"light":"https://mintcdn.com/pearl-research/jPtzRu8ZOdp5WYZT/favicon/pearl-light.svg?fit=max\u0026auto=format\u0026n=jPtzRu8ZOdp5WYZT\u0026q=85\u0026s=97c85bf573b7866d8612883b555a32c7","dark":"https://mintcdn.com/pearl-research/jPtzRu8ZOdp5WYZT/favicon/pearl-dark.svg?fit=max\u0026auto=format\u0026n=jPtzRu8ZOdp5WYZT\u0026q=85\u0026s=9dc503cf63b998d03fa165c37e0921e1"},"api":{"playground":{"display":"interactive"},"examples":{"prefill":true,"autogenerate":false},"url":"full"},"appearance":{"default":"light","strict":true},"background":{"color":{"light":"#EFEEEB"}},"navbar":{"links":[{"href":"mailto:support@pearlresearch.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://platform.pearlresearch.ai"}},"seo":{"metatags":{"canonical":"https://platform.pearlresearch.ai/docs"}},"fonts":{"heading":{"family":"Urbanist"},"body":{"family":"Inter"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pearl-research","hasAudioNarration":false,"actualSubdomain":"pearl-research","customDomains":[],"gitSource":{"type":"github","owner":"duplex-foundation","repo":"cloud-platform-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6afac147dd50ae575c58a540"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff1808a4a19f80cc241c5b","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Docs","count":37},{"language":"default","tag":"Integrations","count":16},{"language":"default","tag":"Inference API","count":14},{"language":"default","tag":"API Reference","count":12},{"language":"default","tag":"Account \u0026 Billing","count":6},{"language":"default","tag":"Get Started","count":6},{"language":"default","tag":"Management API","count":5},{"language":"default","tag":"Guides","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"site-roles","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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"reference/responses","slug":"/reference/responses","pageMetadata":{"title":"Responses","description":"Stateless response creation with native JSON and SSE responses.","deprecated":null,"version":null,"sidebarTitle":"Responses","openapi":"/openapi/inference.yaml post /responses","href":"/reference/responses","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Stateless response creation with native JSON and SSE responses.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`unsupported`,children:`Not supported`}),`\n`,_jsxs(_components.p,{children:[`Responses are stateless. These return `,_jsx(_components.code,{children:`400`}),`:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`previous_response_id`}),`, and `,_jsx(_components.code,{children:`item_reference`}),` input items: send the history in `,_jsx(_components.code,{children:`input`}),` instead.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`store: true`}),` and `,_jsx(_components.code,{children:`background: true`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`There are no endpoints to retrieve, delete, or cancel a stored response, and no WebSocket transport. Disconnecting a request can still incur usage for generated tokens. See the `,_jsx(_components.a,{href:`/integrations/openai-responses`,children:`SDK example`}),` for a multi-turn loop.`]}),`\n`,_jsx(Heading,{level:`2`,id:`reasoning`,children:`Reasoning`}),`\n`,_jsxs(_components.p,{children:[`Set the effort with `,_jsx(_components.code,{children:`\"reasoning\": {\"effort\": \"high\"}`}),`. Levels a model doesn’t serve round up to the next one it does, and the response echoes the applied level in `,_jsx(_components.code,{children:`reasoning.effort`}),`. `,_jsx(_components.code,{children:`\"effort\": \"none\"`}),` turns thinking off; GLM-5.3 and GLM-5.3-Flash always think and return `,_jsx(_components.code,{children:`400`}),`. `,_jsx(_components.code,{children:`max_output_tokens`}),` covers the reasoning and the answer. See `,_jsx(_components.a,{href:`/reasoning#effort-mapping`,children:`how effort levels map`}),`.`]})]})}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":{"config":{},"pageMetadata":{"title":"Responses","description":"Stateless response creation with native JSON and SSE responses.","deprecated":null,"version":null,"sidebarTitle":"Responses","openapi":"/openapi/inference.yaml post /responses","href":"/reference/responses","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Not supported","slug":"unsupported","depth":2,"children":[]},{"title":"Reasoning","slug":"reasoning","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createResponse","summary":"Responses","description":"Stateless response creation with native JSON and SSE responses.","x-mint":{"href":"/reference/responses","metadata":{"sidebarTitle":"Responses"},"content":"## Not supported {#unsupported}\n\nResponses are stateless. These return `400`:\n\n- `previous_response_id`, and `item_reference` input items: send the history in `input` instead.\n- `store: true` and `background: true`.\n\nThere are no endpoints to retrieve, delete, or cancel a stored response, and no WebSocket transport. Disconnecting a request can still incur usage for generated tokens. See the [SDK example](/integrations/openai-responses) for a multi-turn loop.\n\n## Reasoning {#reasoning}\n\nSet the effort with `\"reasoning\": {\"effort\": \"high\"}`. Levels a model doesn't serve round up to the next one it does, and the response echoes the applied level in `reasoning.effort`. `\"effort\": \"none\"` turns thinking off; GLM-5.3 and GLM-5.3-Flash always think and return `400`. `max_output_tokens` covers the reasoning and the answer. See [how effort levels map](/reasoning#effort-mapping).\n"},"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl https://inference.pearlresearch.ai/v1/responses \\\n -H \"Authorization: Bearer $PEARL_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\"YOUR_MODEL_ID\",\"input\":\"Hello\",\"store\":false,\"max_output_tokens\":8192}'\n"}],"requestBody":"72b27bb3-7b76-417b-9df1-401ca4913616","responses":{"200":"c7be40aa-c7df-4e79-aab3-dcdada15e526","400":"e0ed055f-c101-4477-a6f4-8f2966df4727","401":"9df94220-0a66-492f-a9ad-a67207e56b29","402":"58667c96-0c04-41d8-9a68-806a0643847a","403":"16ad2479-deb6-4a4a-bf3a-994504564271","404":"34d20879-8506-4176-a804-f24f36f74925","413":"9c635ad1-8164-4a10-859a-4d9a7dd41925","429":"609e54a8-5344-43ae-b82f-81506a3926e3","500":"fff7458b-6e03-4d9d-99e3-febbd4f79a8f","502":"e5f84b56-19e9-4421-84b8-1153b86c1cca","503":"cfcde883-f92c-4bd5-b2dc-1634d4078df4","529":"d98a225a-2407-4d03-9a08-47aeffb949e5"},"method":"post","type":"path","servers":["f6c31a79-dad6-4767-a559-ec5cffb3ed6a"],"security":["6625f6de-e10e-440e-ad17-e151c962928e"],"path":"/responses","baseUrlOptions":["https://inference.pearlresearch.ai/v1"],"title":"Responses","codeSamples":[{"label":"cURL","lang":"bash","source":"curl https://inference.pearlresearch.ai/v1/responses \\\n -H \"Authorization: Bearer $PEARL_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"model\":\"YOUR_MODEL_ID\",\"input\":\"Hello\",\"store\":false,\"max_output_tokens\":8192}'\n"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.model":"YOUR_MODEL_ID","body.input.oneOf.0":"Hello","body.max_output_tokens":8192,"body.store":false}],"urlDisplay":"full"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model","input"],"properties":{"model":{"type":"string","description":"A chat model ID from `GET /models`. A model that doesn't serve Responses returns `404`.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"input":{"oneOf":[{"type":"string","title":"string","description":"A string, or an array of input items: messages, plus the output items earlier turns returned (reasoning, function calls) and your `function_call_output` items. Send the whole history each turn; item references are refused.","isRequired":true,"uniqueKey":"input.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","uniqueKey":"input.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"array","description":"A string, or an array of input items: messages, plus the output items earlier turns returned (reasoning, function calls) and your `function_call_output` items. Send the whole history each turn; item references are refused.","isRequired":true,"uniqueKey":"input.oneOf.1","typeLabel":"array · object[]"}],"isRequired":true,"uniqueKey":"input","typeLabel":"string | array · object[]"},"instructions":{"type":"string","description":"A system message for this request.","uniqueKey":"instructions","typeLabel":"string"},"max_output_tokens":{"type":"integer","description":"Cap on generated tokens, reasoning included.","uniqueKey":"max_output_tokens","typeLabel":"integer"},"stream":{"type":"boolean","description":"Stream server-sent events instead of one JSON response.","uniqueKey":"stream","typeLabel":"boolean"},"store":{"type":"boolean","enum":[false],"default":false,"description":"Must be `false` or omitted (omitted is sent as `false`). Responses are stateless, so `true` returns `400`.","uniqueKey":"store","typeLabel":"enum\u003cboolean>"},"reasoning":{"type":"object","description":"`{\"effort\": …}`, one of `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`; see [Reasoning](#reasoning).","properties":{"effort":{"type":"string","enum":["none","minimal","low","medium","high","xhigh","max"],"uniqueKey":"reasoning.effort","typeLabel":"enum\u003cstring>"}},"uniqueKey":"reasoning","typeLabel":"object"},"tools":{"type":"array","description":"Function tools the model may call. Support varies by model.","items":{"type":"object","uniqueKey":"tools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tools","typeLabel":"object[]"},"temperature":{"type":"number","description":"Sampling parameter, as on [chat completions](/reference/chat-completions).","uniqueKey":"temperature","typeLabel":"number"},"top_p":{"type":"number","description":"Sampling parameter, as on [chat completions](/reference/chat-completions).","uniqueKey":"top_p","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"example":{"model":"YOUR_MODEL_ID","input":"Hello","store":false,"max_output_tokens":8192},"examples":{"Example":{"title":"Example","value":{"model":"YOUR_MODEL_ID","input":"Hello","store":false,"max_output_tokens":8192}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c7be40aa-c7df-4e79-aab3-dcdada15e526":{"description":"The completion, or an event stream when streaming.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Response ID.","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["response"],"description":"Always `response`.","uniqueKey":"object","typeLabel":"enum\u003cstring>"},"created_at":{"type":"integer","description":"Unix timestamp (seconds).","uniqueKey":"created_at","typeLabel":"integer"},"status":{"type":"string","enum":["completed","incomplete","cancelled"],"description":"`completed`, `incomplete` (stopped early, for example at `max_output_tokens`), or `cancelled`. Check it before using `output`.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"The model that served the request.","uniqueKey":"model","typeLabel":"string"},"output":{"type":"array","description":"Output items in order: reasoning models add a `reasoning` item, then a `message` with `output_text` content, or `function_call` items when the model calls tools. Replay them in the next turn's `input`.","items":{"type":"object","properties":{"type":{"type":"string","enum":["reasoning","message","function_call"],"uniqueKey":"output.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX]","typeLabel":"object"},"uniqueKey":"output","typeLabel":"object[]"},"usage":{"type":"object","description":"`input_tokens` and `output_tokens`, what you're billed on, with `input_tokens_details.cached_tokens` and `output_tokens_details.reasoning_tokens` when the model reports them.","properties":{"input_tokens":{"type":"integer","uniqueKey":"usage.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","uniqueKey":"usage.output_tokens","typeLabel":"integer"},"input_tokens_details":{"type":"object","properties":{"cached_tokens":{"type":"integer","uniqueKey":"usage.input_tokens_details.cached_tokens","typeLabel":"integer"}},"uniqueKey":"usage.input_tokens_details","typeLabel":"object"},"output_tokens_details":{"type":"object","properties":{"reasoning_tokens":{"type":"integer","uniqueKey":"usage.output_tokens_details.reasoning_tokens","typeLabel":"integer"}},"uniqueKey":"usage.output_tokens_details","typeLabel":"object"}},"uniqueKey":"usage","typeLabel":"object"},"reasoning":{"type":"object","description":"Levels a model doesn't serve round up to the next one it does, and the response echoes the applied level in `reasoning.effort`.","properties":{"effort":{"type":"string","uniqueKey":"reasoning.effort","typeLabel":"string"}},"uniqueKey":"reasoning","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","summary":"Response","value":{"id":"resp_…","object":"response","created_at":1785229039,"status":"completed","model":"YOUR_MODEL_ID","output":[{"type":"message","id":"msg_…","role":"assistant","status":"completed","content":[{"type":"output_text","text":"Hello! How can I help?","annotations":[]}]}],"usage":{"input_tokens":9,"input_tokens_details":{"cached_tokens":0},"output_tokens":12,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":21}}}},"exampleType":"examples"},"text/event-stream":{"schema":{"type":"string","description":"With `stream: true` the response is native Responses server-sent events: each one an `event:` line naming its type and a `data:` line with the JSON. A successful stream ends with `response.completed` or `response.incomplete`, whose `response` carries the usage; there is no `[DONE]` sentinel. A failed generation ends with `response.failed`, and an error after the stream has started arrives as an `error` event.","uniqueKey":"","typeLabel":"string"},"examples":{"streamError":{"title":"streamError","summary":"Error after the stream started","value":"event: error\ndata: {\"type\":\"error\",\"code\":\"server_error\",\"message\":\"upstream stream error\",\"param\":null}"}},"exampleType":"examples"}},"exampleType":"examples"},"e0ed055f-c101-4477-a6f4-8f2966df4727":{"description":"Invalid request: malformed JSON, a missing or wrongly typed field, a stateful feature (see Not supported), or an unsupported reasoning control.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"malformedJson":{"title":"malformedJson","summary":"Malformed JSON","value":{"error":{"message":"malformed JSON","type":"invalid_request_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9df94220-0a66-492f-a9ad-a67207e56b29":{"description":"Missing, unknown, revoked, or expired API key, a key over its credit limit, or a management key.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"unknownKey":{"title":"unknownKey","summary":"Unknown API key","value":{"error":{"message":"unknown API key","type":"authentication_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"58667c96-0c04-41d8-9a68-806a0643847a":{"description":"Your organization is out of credits. Top up on the [Billing](https://platform.pearlresearch.ai/billing) page, then retry.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"outOfCredits":{"title":"outOfCredits","summary":"Out of credits","value":{"error":{"message":"your organization is out of credits","type":"api_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"16ad2479-deb6-4a4a-bf3a-994504564271":{"description":"Wrong endpoint for your organization's [inference region](/data-residency).","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"wrongRegion":{"title":"wrongRegion","summary":"Wrong endpoint for the region","value":{"error":{"message":"wrong endpoint for your organization's inference region","type":"permission_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"34d20879-8506-4176-a804-f24f36f74925":{"description":"Unknown model (code `model_not_found`), or one this endpoint doesn't serve.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"unknownModel":{"title":"unknownModel","summary":"Unknown model","value":{"error":{"message":"unknown model","type":"invalid_request_error","code":"model_not_found","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9c635ad1-8164-4a10-859a-4d9a7dd41925":{"description":"Request body over 20 MiB.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"bodyTooLarge":{"title":"bodyTooLarge","summary":"Body over 20 MiB","value":{"error":{"message":"request body over 20 MiB","type":"invalid_request_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"609e54a8-5344-43ae-b82f-81506a3926e3":{"description":"A [rate limit](/plans) for your organization and the model was reached. Wait for the `Retry-After` header's seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rateLimited":{"title":"rateLimited","summary":"Rate limit reached","value":{"error":{"message":"rate limit reached","type":"rate_limit_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"fff7458b-6e03-4d9d-99e3-febbd4f79a8f":{"description":"Internal error. Safe to retry with backoff.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"internalError":{"title":"internalError","summary":"Internal error","value":{"error":{"message":"internal error","type":"api_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"e5f84b56-19e9-4421-84b8-1153b86c1cca":{"description":"The model server failed or returned a malformed response. Retry with backoff.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"modelServerFailed":{"title":"modelServerFailed","summary":"Model server failed","value":{"error":{"message":"the model server failed","type":"api_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"cfcde883-f92c-4bd5-b2dc-1634d4078df4":{"description":"Temporarily unavailable, for example during a deploy. Retry after the `Retry-After` header's seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"unavailable":{"title":"unavailable","summary":"Temporarily unavailable","value":{"error":{"message":"temporarily unavailable","type":"api_error","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d98a225a-2407-4d03-9a08-47aeffb949e5":{"description":"No capacity for the model right now (code `no_capacity`). Retry with backoff.","headers":{"X-Request-ID":{"description":"The request ID. Send your own UUID in `X-Request-ID` to use it as the ID. Include the ID when you contact support.","schema":{"type":"string"},"example":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}},"content":{"application/json":{"schema":{"type":"object","description":"Errors are JSON in OpenAI's shape, with the request ID in the body.","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Present only when set, for example `model_not_found` or `no_capacity`.","uniqueKey":"error.code","typeLabel":"string"},"request_id":{"type":"string","description":"The request ID.","uniqueKey":"error.request_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"noCapacity":{"title":"noCapacity","summary":"No capacity","value":{"error":{"message":"no capacity for the model right now","type":"api_error","code":"no_capacity","request_id":"6f0b6e0a-6a8f-4c62-9b1e-3d2c1a0f9e87"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6625f6de-e10e-440e-ad17-e151c962928e":{"inferenceKey":{"type":"http","scheme":"bearer","description":"`Bearer` followed by an inference API key (`sk-prl-infapi-`). Create keys on the [API Keys](https://platform.pearlresearch.ai/api-keys) page. Management keys (`sk-prl-mgmt-`) cannot call models.","scopes":[],"schemeName":"inferenceKey"}}},"servers":{"f6c31a79-dad6-4767-a559-ec5cffb3ed6a":{"url":"https://inference.pearlresearch.ai/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"`Bearer` followed by an inference API key (`sk-prl-infapi-`). Create keys on the [API Keys](https://platform.pearlresearch.ai/api-keys) page. Management keys (`sk-prl-mgmt-`) cannot call models.","scopes":[],"schemeName":"inferenceKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"`Bearer` followed by an inference API key (`sk-prl-infapi-`). Create keys on the [API Keys](https://platform.pearlresearch.ai/api-keys) page. Management keys (`sk-prl-mgmt-`) cannot call models.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"inferenceKey","name":"Authorization"}],"title":"inferenceKey"}]},"originalFileLocation":"openapi/inference.yaml"},"subdomain":"pearl-research","siteName":"Pearl Inference Platform","title":"Responses - Pearl Inference Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T15:31:08.161Z","originalFileLocation":"reference/responses.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"description\" content=\"Stateless response creation with native JSON and SSE responses.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pearl Inference Platform\">\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/pearl-research/k9be1f6J_artjsFA/_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/pearl-research/k9be1f6J_artjsFA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/pearl-research/k9be1f6J_artjsFA/_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/pearl-research/k9be1f6J_artjsFA/_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/pearl-research/k9be1f6J_artjsFA/_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/pearl-research/k9be1f6J_artjsFA/_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/pearl-research/k9be1f6J_artjsFA/_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/pearl-research/k9be1f6J_artjsFA/_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/pearl-research/k9be1f6J_artjsFA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Responses - Pearl Inference Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Stateless response creation with native JSON and SSE responses.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pearl Inference Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://platform.pearlresearch.ai/docs/reference/responses\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pearl-research.mintlify.site/docs/_mintlify/api/og/v2?division=Inference+API\u0026amp;title=Responses\u0026amp;description=Stateless+response+creation+with+native+JSON+and+SSE+responses.\u0026amp;theme=8053f473600c09a776e77e44\u0026amp;signature=1b8c2ad5dc05cb0b77a157989638193ccc270f46e78854650c091fb625ea5be1\">\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=\"Responses - Pearl Inference Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Stateless response creation with native JSON and SSE responses.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pearl-research.mintlify.site/docs/_mintlify/api/og/v2?division=Inference+API\u0026amp;title=Responses\u0026amp;description=Stateless+response+creation+with+native+JSON+and+SSE+responses.\u0026amp;theme=8053f473600c09a776e77e44\u0026amp;signature=1b8c2ad5dc05cb0b77a157989638193ccc270f46e78854650c091fb625ea5be1\">\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/pearl-research/k9be1f6J_artjsFA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pearl Inference Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2A2623\">\u003clink data-mint-head rel=\"canonical\" href=\"https://platform.pearlresearch.ai/docs/reference/responses\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/reference/responses.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://platform.pearlresearch.ai/#organization\",\"name\":\"Pearl Inference Platform\",\"url\":\"https://platform.pearlresearch.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pearl-research/qjVPdghcpi_iWwgo/logo/light.svg?fit=max\u0026auto=format\u0026n=qjVPdghcpi_iWwgo\u0026q=85\u0026s=a969569c61ca3aa40012ac0f3dbbe445\"}},{\"@type\":\"WebSite\",\"@id\":\"https://platform.pearlresearch.ai/docs#website\",\"name\":\"Pearl Inference Platform\",\"url\":\"https://platform.pearlresearch.ai/docs\",\"publisher\":{\"@id\":\"https://platform.pearlresearch.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://platform.pearlresearch.ai/docs/reference/responses#webpage\",\"url\":\"https://platform.pearlresearch.ai/docs/reference/responses\",\"name\":\"Responses\",\"description\":\"Stateless response creation with native JSON and SSE responses.\",\"dateModified\":\"2026-11-16T15:31:08.161Z\",\"isPartOf\":{\"@id\":\"https://platform.pearlresearch.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://platform.pearlresearch.ai/docs/reference/responses#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://platform.pearlresearch.ai/docs/reference/responses#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Inference API\",\"item\":\"https://platform.pearlresearch.ai/docs/reference/inference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Responses\",\"item\":\"https://platform.pearlresearch.ai/docs/reference/responses\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://platform.pearlresearch.ai/docs/reference/responses#apireference\",\"headline\":\"Responses\",\"name\":\"Responses\",\"description\":\"Stateless response creation with native JSON and SSE responses.\",\"url\":\"https://platform.pearlresearch.ai/docs/reference/responses\",\"mainEntityOfPage\":{\"@id\":\"https://platform.pearlresearch.ai/docs/reference/responses#webpage\"},\"dateModified\":\"2026-11-16T15:31:08.161Z\",\"publisher\":{\"@id\":\"https://platform.pearlresearch.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://platform.pearlresearch.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pearl Inference Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Pearl Inference Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/reference/responses.md","siteName":"Pearl Inference Platform","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API Reference","groups":[{"group":"Inference API","pages":[{"title":"Overview","href":"/reference/inference"},{"title":"Chat completions","description":"The primary inference endpoint, OpenAI-compatible chat with streaming, tools, JSON mode, reasoning, and vision.","deprecated":null,"version":null,"sidebarTitle":"Chat completions","openapi":"/openapi/inference.yaml post /chat/completions","href":"/reference/chat-completions"},{"title":"Responses","deprecated":null,"version":null,"sidebarTitle":"Responses","openapi":"/openapi/inference.yaml post /responses","href":"/reference/responses"},{"title":"Messages","description":"Native Anthropic Messages responses and SSE events for compatible models.","deprecated":null,"version":null,"sidebarTitle":"Messages","openapi":"/openapi/inference.yaml post /messages","href":"/reference/messages"},{"title":"Count tokens","deprecated":null,"version":null,"sidebarTitle":"Count tokens","openapi":"/openapi/inference.yaml post /messages/count_tokens","href":"/reference/messages/count-tokens"},{"title":"Completions (legacy)","deprecated":null,"version":null,"sidebarTitle":"Completions (legacy)","openapi":"/openapi/inference.yaml post /completions","href":"/reference/completions"},{"title":"List models","deprecated":null,"version":null,"sidebarTitle":"List models","openapi":"/openapi/inference.yaml get /models","href":"/reference/models"}]},{"group":"Management API","pages":[{"title":"Overview","href":"/reference/management"},{"title":"Rate limits","href":"/reference/management/rate-limits"},{"title":"Get credits","deprecated":null,"version":null,"sidebarTitle":"Credits","openapi":"/openapi/management.yaml get /credits","href":"/reference/management/credits"},{"title":"Get current API key","deprecated":null,"version":null,"sidebarTitle":"Current API key","openapi":"/openapi/management.yaml get /key","href":"/reference/management/key"},{"title":"Get activity","deprecated":null,"version":null,"sidebarTitle":"Activity","openapi":"/openapi/management.yaml get /activity","href":"/reference/management/activity"}]}]}]},"basePath":"","title":"Responses - Pearl Inference Platform","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}