Point your agent’s Responses requests at Sphinx to receive context-augmented answers in the Responses format.
The Sphinx Responses API augments your agent’s inference requests with learned context. Sphinx can inject context over multiple rounds and returns a response in OpenAI’s Responses format.
Before you start
Ask Sphinx to enable API access for your organization and confirm the workspace and model configuration for your integration.
Obtain a Sphinx API key for that setup.
Use an agent that sends Responses API requests and lets you change the endpoint and authentication.
Configure your agent
Setting
Value
Full Responses endpoint
https://api.prod.sphinx.ai/v1/responses
API base URL, if the client appends /responses
https://api.prod.sphinx.ai/v1
Authentication
Authorization: Bearer YOUR_SPHINX_API_KEY
Model
A supported model ID from the list below
Replace your agent’s inference endpoint and credentials with the Sphinx values.
Supported OpenAI models
Set the request’s model field to one of these exact IDs, without an openai/ prefix:
Family
Supported model IDs
GPT-6.2
gpt-6.2-astra, gpt-6.2-sol
GPT-6.1
gpt-6.1-sol, gpt-6.1-terra
GPT-6
gpt-6-astra, gpt-6-sol, gpt-6-luna
GPT-5.6
gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna
GPT-5.5
gpt-5.5
GPT-5.4
gpt-5.4, gpt-5.4-mini
Codex
gpt-5.3-codex, gpt-5.2-codex
GPT-5.2
gpt-5.2
GPT-5
gpt-5, gpt-5-mini, gpt-5-nano
GPT-4.1
gpt-4.1, gpt-4.1-mini, gpt-4.1-nano
These are the OpenAI model IDs supported by the Responses API. Availability also depends on your deployment’s provider configuration; confirm access with Sphinx. Unlisted model names, including unlisted aliases or dated snapshots, are rejected with model_not_found.
Use a Sphinx API key for this endpoint. The MCP endpoint is https://api.prod.sphinx.ai/mcp and has a separate client setup flow.
Send a first request
Set SPHINX_API_KEY to your Sphinx key and SPHINX_MODEL to the enabled model name in your environment, then send a minimal request:
curl --fail-with-body https://api.prod.sphinx.ai/v1/responses \ -H "Authorization: Bearer ${SPHINX_API_KEY}" \ -H "Content-Type: application/json" \ -d "$(python3 -c 'import json, os; print(json.dumps({"model": os.environ["SPHINX_MODEL"], "input": "Explain our definition of customer lifetime value and distinguish current and historical methodology."}))')"
Choose a question covered by your workspace’s knowledge. Check that the request succeeds, your agent can read the Responses-format result, and the answer uses the intended business definitions.
Keep the key in your environment or secret store. Do not embed it in source code, publish it in configuration, or include it in screenshots and logs.
Integrate with an existing agent
Keep your agent’s task instructions and source-access tools in place. If it needs local documents, specify their location in its system instructions. If it needs a database, provide the appropriate query tools and access separately.Test the request options your agent uses, including streaming or tool interactions, before switching a production workflow. Contact Sphinx about any client-specific compatibility requirements.
Evaluate the integration
Compare the same agent and tasks with and without Sphinx. Hold the model, source access, and success criteria constant, then compare answer quality, cost, and latency. Include new tasks that were not used to develop the learned context.For incorrect answers, inspect the relevant knowledge, correct the issue, and rerun your evaluation. Use Benchmarks (beta) for recurring checks; contact Sphinx to activate it.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Sphinx Docs","colors":{"primary":"#704643","light":"#ede2d6","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/sphinx-977f1673/P__T7c22F_M_IxmY/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=P__T7c22F_M_IxmY\u0026q=85\u0026s=f9db2de016b08aba238741c2d0e90e74","dark":"https://mintcdn.com/sphinx-977f1673/P__T7c22F_M_IxmY/logo/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=P__T7c22F_M_IxmY\u0026q=85\u0026s=b7100a9af095e59e46a99f6b8507bf12"},"favicon":"https://mintcdn.com/sphinx-977f1673/1wWAviaQrCe_7dvG/logo/sphinx.svg?fit=max\u0026auto=format\u0026n=1wWAviaQrCe_7dvG\u0026q=85\u0026s=3f3d9bb107547b1e4075269ff8505a2c","navbar":{"links":[{"href":"mailto:support@sphinx.ai","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/getsphinx","linkedin":"https://www.linkedin.com/company/sphinx-ml"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://sphinx.ai/blog/filters/all"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sphinx-977f1673","hasAudioNarration":false,"actualSubdomain":"sphinx-977f1673","customDomains":["docs.sphinx.ai"],"gitSource":{"type":"github","owner":"sphinx-ml","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b00d88c303173b0b1900bfc","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"default","tag":"Documentation","count":22},{"language":"default","tag":"Knowledge base","count":7},{"language":"default","tag":"Sphinx MCP","count":4},{"language":"default","tag":"Sphinx Private Gateway","count":4},{"language":"default","tag":"Connect Sphinx MCP to your agent","count":3},{"language":"default","tag":"How Sphinx works","count":3},{"language":"default","tag":"Python SDK","count":2},{"language":"default","tag":"Examples","count":1},{"language":"default","tag":"Sphinx Responses API","count":1}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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":false},"customCss":[]}
{"page":{"pagePath":"responses-api/overview","slug":"/responses-api/overview","pageMetadata":{"title":"Use the Sphinx Responses API","description":"Point your agent's Responses requests at Sphinx to receive context-augmented answers in the Responses format.","href":"/responses-api/overview"},"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: \"Point your agent’s Responses requests at Sphinx to receive context-augmented answers in the Responses format.\"\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`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Sphinx Responses API augments your agent’s inference requests with learned context. Sphinx can inject context over multiple rounds and returns a response in OpenAI’s Responses format.`}),`\n`,_jsx(Heading,{level:`2`,id:`before-you-start`,children:`Before you start`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Ask Sphinx to enable API access for your organization and confirm the workspace and model configuration for your integration.`}),`\n`,_jsx(_components.li,{children:`Obtain a Sphinx API key for that setup.`}),`\n`,_jsx(_components.li,{children:`Use an agent that sends Responses API requests and lets you change the endpoint and authentication.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`configure-your-agent`,children:`Configure your agent`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Setting`}),_jsx(_components.th,{children:`Value`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Full Responses endpoint`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://api.prod.sphinx.ai/v1/responses`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`API base URL, if the client appends `,_jsx(_components.code,{children:`/responses`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://api.prod.sphinx.ai/v1`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Authentication`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`Authorization: Bearer YOUR_SPHINX_API_KEY`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Model`}),_jsx(_components.td,{children:`A supported model ID from the list below`})]})]})]}),`\n`,_jsx(_components.p,{children:`Replace your agent’s inference endpoint and credentials with the Sphinx values.`}),`\n`,_jsx(Heading,{level:`2`,id:`supported-openai-models`,children:`Supported OpenAI models`}),`\n`,_jsxs(_components.p,{children:[`Set the request’s `,_jsx(_components.code,{children:`model`}),` field to one of these exact IDs, without an `,_jsx(_components.code,{children:`openai/`}),` prefix:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Family`}),_jsx(_components.th,{children:`Supported model IDs`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-6.2`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-6.2-astra`}),`, `,_jsx(_components.code,{children:`gpt-6.2-sol`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-6.1`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-6.1-sol`}),`, `,_jsx(_components.code,{children:`gpt-6.1-terra`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-6`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-6-astra`}),`, `,_jsx(_components.code,{children:`gpt-6-sol`}),`, `,_jsx(_components.code,{children:`gpt-6-luna`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-5.6`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-5.6-sol`}),`, `,_jsx(_components.code,{children:`gpt-5.6-terra`}),`, `,_jsx(_components.code,{children:`gpt-5.6-luna`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-5.5`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`gpt-5.5`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-5.4`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-5.4`}),`, `,_jsx(_components.code,{children:`gpt-5.4-mini`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Codex`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-5.3-codex`}),`, `,_jsx(_components.code,{children:`gpt-5.2-codex`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-5.2`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`gpt-5.2`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-5`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-5`}),`, `,_jsx(_components.code,{children:`gpt-5-mini`}),`, `,_jsx(_components.code,{children:`gpt-5-nano`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GPT-4.1`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`gpt-4.1`}),`, `,_jsx(_components.code,{children:`gpt-4.1-mini`}),`, `,_jsx(_components.code,{children:`gpt-4.1-nano`})]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`These are the OpenAI model IDs supported by the Responses API. Availability also depends on your deployment’s provider configuration; confirm access with Sphinx. Unlisted model names, including unlisted aliases or dated snapshots, are rejected with `,_jsx(_components.code,{children:`model_not_found`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Use a Sphinx API key for this endpoint. The MCP endpoint is `,_jsx(_components.code,{children:`https://api.prod.sphinx.ai/mcp`}),` and has a separate client setup flow.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`send-a-first-request`,children:`Send a first request`}),`\n`,_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`SPHINX_API_KEY`}),` to your Sphinx key and `,_jsx(_components.code,{children:`SPHINX_MODEL`}),` to the enabled model name in your environment, then send a minimal request:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --fail-with-body`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.prod.sphinx.ai/v1/responses`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:' \"Authorization: Bearer ${'}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`SPHINX_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"$(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`python3`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'import json, os; print(json.dumps({\"model\": os.environ[\"SPHINX_MODEL\"], \"input\": \"Explain our definition of customer lifetime value and distinguish current and historical methodology.\"}))')\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Choose a question covered by your workspace’s knowledge. Check that the request succeeds, your agent can read the Responses-format result, and the answer uses the intended business definitions.`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Keep the key in your environment or secret store. Do not embed it in source code, publish it in configuration, or include it in screenshots and logs.`})}),`\n`,_jsx(Heading,{level:`2`,id:`integrate-with-an-existing-agent`,children:`Integrate with an existing agent`}),`\n`,_jsx(_components.p,{children:`Keep your agent’s task instructions and source-access tools in place. If it needs local documents, specify their location in its system instructions. If it needs a database, provide the appropriate query tools and access separately.`}),`\n`,_jsx(_components.p,{children:`Test the request options your agent uses, including streaming or tool interactions, before switching a production workflow. Contact Sphinx about any client-specific compatibility requirements.`}),`\n`,_jsx(Heading,{level:`2`,id:`evaluate-the-integration`,children:`Evaluate the integration`}),`\n`,_jsx(_components.p,{children:`Compare the same agent and tasks with and without Sphinx. Hold the model, source access, and success criteria constant, then compare answer quality, cost, and latency. Include new tasks that were not used to develop the learned context.`}),`\n`,_jsxs(_components.p,{children:[`For incorrect answers, `,_jsx(_components.a,{href:`/concepts/interpretability`,children:`inspect the relevant knowledge`}),`, correct the issue, and rerun your evaluation. Use `,_jsx(_components.a,{href:`/benchmarks`,children:`Benchmarks (beta)`}),` for recurring checks; contact Sphinx to activate it.`]})]})}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":"Use the Sphinx Responses API","description":"Point your agent's Responses requests at Sphinx to receive context-augmented answers in the Responses format.","href":"/responses-api/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Before you start","slug":"before-you-start","depth":2,"children":[]},{"title":"Configure your agent","slug":"configure-your-agent","depth":2,"children":[]},{"title":"Supported OpenAI models","slug":"supported-openai-models","depth":2,"children":[]},{"title":"Send a first request","slug":"send-a-first-request","depth":2,"children":[]},{"title":"Integrate with an existing agent","slug":"integrate-with-an-existing-agent","depth":2,"children":[]},{"title":"Evaluate the integration","slug":"evaluate-the-integration","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"sphinx-977f1673","siteName":"Sphinx Docs","title":"Use the Sphinx Responses API - Sphinx Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T21:00:16.789Z","originalFileLocation":"responses-api/overview.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=\"description\" content=\"Point your agent\u0026#x27;s Responses requests at Sphinx to receive context-augmented answers in the Responses format.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sphinx Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_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=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Use the Sphinx Responses API - Sphinx Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Point your agent\u0026#x27;s Responses requests at Sphinx to receive context-augmented answers in the Responses format.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sphinx Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sphinx.ai/responses-api/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sphinx-977f1673.mintlify.site/_mintlify/api/og/v2?division=Sphinx+Responses+API\u0026amp;title=Use+the+Sphinx+Responses+API\u0026amp;description=Point+your+agent%27s+Responses+requests+at+Sphinx+to+receive+context-augmented+answers+in+the+Responses+format.\u0026amp;theme=2e0ca79c820e075d549cbc7f\u0026amp;signature=acc00586ec69d7cf640a43561eb567fabf1898057b74dcb01e84d97906b5e393\">\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=\"Use the Sphinx Responses API - Sphinx Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Point your agent\u0026#x27;s Responses requests at Sphinx to receive context-augmented answers in the Responses format.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sphinx-977f1673.mintlify.site/_mintlify/api/og/v2?division=Sphinx+Responses+API\u0026amp;title=Use+the+Sphinx+Responses+API\u0026amp;description=Point+your+agent%27s+Responses+requests+at+Sphinx+to+receive+context-augmented+answers+in+the+Responses+format.\u0026amp;theme=2e0ca79c820e075d549cbc7f\u0026amp;signature=acc00586ec69d7cf640a43561eb567fabf1898057b74dcb01e84d97906b5e393\">\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=\"/mintlify-assets/_mintlify/favicons/sphinx-977f1673/8idukxGllAmRhGRj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sphinx Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#704643\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sphinx.ai/responses-api/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/responses-api/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sphinx.ai/#organization\",\"name\":\"Sphinx Docs\",\"url\":\"https://docs.sphinx.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sphinx-977f1673/P__T7c22F_M_IxmY/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=P__T7c22F_M_IxmY\u0026q=85\u0026s=f9db2de016b08aba238741c2d0e90e74\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sphinx.ai#website\",\"name\":\"Sphinx Docs\",\"url\":\"https://docs.sphinx.ai\",\"publisher\":{\"@id\":\"https://docs.sphinx.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sphinx.ai/responses-api/overview#webpage\",\"url\":\"https://docs.sphinx.ai/responses-api/overview\",\"name\":\"Use the Sphinx Responses API\",\"description\":\"Point your agent's Responses requests at Sphinx to receive context-augmented answers in the Responses format.\",\"dateModified\":\"2026-11-17T21:00:16.789Z\",\"isPartOf\":{\"@id\":\"https://docs.sphinx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sphinx.ai/responses-api/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sphinx.ai/responses-api/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sphinx Docs\",\"item\":\"https://docs.sphinx.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Use the Sphinx Responses API\",\"item\":\"https://docs.sphinx.ai/responses-api/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.sphinx.ai/responses-api/overview#article\",\"headline\":\"Use the Sphinx Responses API\",\"name\":\"Use the Sphinx Responses API\",\"description\":\"Point your agent's Responses requests at Sphinx to receive context-augmented answers in the Responses format.\",\"url\":\"https://docs.sphinx.ai/responses-api/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sphinx.ai/responses-api/overview#webpage\"},\"dateModified\":\"2026-11-17T21:00:16.789Z\",\"publisher\":{\"@id\":\"https://docs.sphinx.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sphinx.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sphinx Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sphinx Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/responses-api/overview.md","siteName":"Sphinx Docs","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://sphinx.ai/blog/filters/all"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"How Sphinx works","pages":[{"title":"How Sphinx works","href":"/how-sphinx-works"},{"title":"Learning organizational context","href":"/concepts/context-learning"},{"title":"Inspect and govern learned knowledge","href":"/concepts/interpretability"}]},{"group":"Knowledge base","pages":[{"title":"Browse the Sphinx UI","href":"/knowledge-base/browse"},{"title":"Ingest and train on data and documents","href":"/knowledge-base/ingest"},{"title":"Ingest directly from a Git repository","icon":"github","href":"/git-ingest"},{"title":"Write a good ingest prompt","icon":"pen-to-square","href":"/ingest-prompts"},{"title":"Review and accept knowledge changes","href":"/knowledge-base/review-changes"},{"title":"Resolve controversies","href":"/knowledge-base/controversies"},{"title":"Benchmarks (beta)","description":"Evaluate Sphinx answers against your questions and criteria, inspect results, and track scores over time.","href":"/benchmarks"}]},{"group":"Sphinx Responses API","pages":[{"title":"Use the Sphinx Responses API","href":"/responses-api/overview"}]},{"group":"Sphinx MCP","pages":[{"title":"Use the Sphinx MCP server","description":"Connect your agent to Sphinx with OAuth or an API key, search your knowledge base, and propose updates.","href":"/mcp/overview"},{"group":"Connect Sphinx MCP to your agent","pages":[{"title":"Sphinx plugin onboarding for Claude","href":"/claude/sphinx-plugin-onboarding"},{"title":"API key setup for Claude Code CLI","href":"/claude-code-cli/api-key-setup"},{"title":"Install Sphinx MCP in ChatGPT Desktop","href":"/chatgpt-desktop/install-sphinx-mcp"}]}]},{"group":"Sphinx Private Gateway","pages":[{"title":"Sphinx Private Gateway","href":"/private-gateway/overview"},{"title":"Connect Claude Desktop to an API gateway","href":"/claude-desktop/api-gateway-setup"},{"title":"Setup ChatGPT Desktop LLM Gateway","href":"/chatgpt-desktop/setup-llm-gateway"},{"title":"Use Sphinx MCP with Claude Private Gateway","href":"/claude-desktop/sphinx-mcp/install-sphinx-mcp"}]},{"group":"Python SDK","pages":[{"title":"Python SDK reference","href":"/python-sdk/fit"},{"title":"Run your first ingest job","href":"/python-sdk/quickstart"}]},{"group":"Examples","pages":[{"title":"Train AI on a Business, using Sphinx","icon":"graduation-cap","href":"/examples/business-training"}]}]}]},"basePath":"","title":"Use the Sphinx Responses API - Sphinx Docs","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":[],"chunks":[]}