Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be ’:’ for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or ‘custom::’ for a stored custom provider, e.g. ‘openai:gpt-4o’ or ‘anthropic:claude-sonnet-4-5’. Set stream: true for server-sent events of chat.completion.chunk payloads terminated by data: [DONE]. Tool calling is not supported.
Phoenix is not an AI gateway. The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.
Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Phoenix","colors":{"primary":"#00769E","light":"#39C7FF","dark":"#009DD2"},"logo":{"light":"https://mintcdn.com/arizeai-433a7140/fitXeWll7ezQrIcg/docs/logo/light.png?fit=max\u0026auto=format\u0026n=fitXeWll7ezQrIcg\u0026q=85\u0026s=78e92baf10dd9eced114496ccb88dbf1","dark":"https://mintcdn.com/arizeai-433a7140/fitXeWll7ezQrIcg/docs/logo/dark.png?fit=max\u0026auto=format\u0026n=fitXeWll7ezQrIcg\u0026q=85\u0026s=ef36a0515f1c575affb91f81496ce2f3"},"favicon":"https://mintcdn.com/arizeai-433a7140/fitXeWll7ezQrIcg/docs/favicon.png?fit=max\u0026auto=format\u0026n=fitXeWll7ezQrIcg\u0026q=85\u0026s=7c6d0d7347821750d998c57c334ca376","background":{"color":{"light":"#FFFFFF","dark":"#08090A"}},"navbar":{"links":[]},"footer":{"socials":{"slack":"https://join.slack.com/t/arize-ai/shared_invite/zt-3r07iavnk-ammtATWSlF0pSrd1DsMW7g","x":"https://x.com/ArizePhoenix","bluesky":"https://bsky.app/profile/arize-phoenix.bsky.social","linkedin":"https://www.linkedin.com/showcase/113218220","github":"https://github.com/Arize-ai/phoenix"},"links":[{"items":[{"label":"Blog","href":"https://arize.com/blog?cat=phoenix"}]},{"items":[{"label":"English","href":"/docs/phoenix"},{"label":"日本語 (Japanese)","href":"/docs/phoenix/documentation/jp"},{"label":"中文 (Chinese)","href":"/docs/phoenix/documentation/zh"}]}]},"seo":{"metatags":{"canonical":"https://arize.com"},"indexing":"all"},"fonts":{"heading":{"family":"Geist","weight":600},"body":{"family":"Geist"}},"styling":{"codeblocks":{"theme":{"light":"github-light-default","dark":"github-dark-default"}},"latex":true},"integrations":{"gtm":{"tagId":"GTM-W96XM35"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"arizeai-433a7140","hasAudioNarration":false,"actualSubdomain":"arizeai-433a7140","customDomains":[],"gitSource":{"type":"github","owner":"arize-ai","repo":"phoenix","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee6bb2ad4d0935cb80afb2","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Integrations","count":211},{"language":"default","tag":"Documentation","count":175},{"language":"default","tag":"Release Notes","count":175},{"language":"default","tag":"SDK \u0026 API Reference","count":145},{"language":"default","tag":"Rest API","count":106},{"language":"default","tag":"API Reference","count":105},{"language":"default","tag":"LLM Providers","count":71},{"language":"default","tag":"Python","count":69},{"language":"default","tag":"Tracing","count":64},{"language":"default","tag":"Evaluation","count":59}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@arize.com"}},"basePath":"","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":"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":"llms-txt-v2","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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"docs/style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nhtml:root{--font-family-mono-custom: 'Geist Mono'}html:root{--gray-50: 247 247 248;--gray-100: 241 242 243;--gray-200: 228 229 232;--gray-300: 201 203 208;--gray-400: 161 164 171;--gray-500: 124 128 136;--gray-600: 86 90 98;--gray-700: 61 64 70;--gray-800: 43 45 49;--gray-900: 21 22 22;--gray-950: 8 9 10}html:root{--px-radius-sm: 2px;--px-radius-md: 6px;--px-radius-lg: 8px;--px-accent-bg: #009DD2}html:not(.dark){--px-bg: #FFFFFF;--px-surface: #F7F7F8;--px-code-bg: #F1F2F3;--px-chip: #E9EAEC;--px-line: rgba(8, 9, 10, 0.18);--px-t1: #08090A;--px-t2: #2B2D31;--px-t3: #3D4046;--px-accent: #00769E;--px-accent-line: rgba(0, 157, 210, 0.55);--px-accent-soft: #E7F3FD;--px-on-accent: #08090A;--px-note: #E8F3EC;--px-note-line: rgba(30, 70, 50, 0.24);--px-note-t: #1B4230;--px-warn: #FBEEE0;--px-warn-line: rgba(90, 50, 0, 0.24);--px-warn-t: #54300A;--px-blue: #E7F3FD;--px-blue-line: rgba(0, 82, 125, 0.24);--px-blue-t: #00527D;--px-danger: #FFEBE9;--px-danger-line: rgba(207, 34, 46, 0.28);--px-danger-t: #A40E26}html.dark{--px-bg: #08090A;--px-surface: #151616;--px-code-bg: #050506;--px-chip: #1E2226;--px-line: rgba(194, 196, 234, 0.20);--px-t1: #FFFFFF;--px-t2: #D5D7DB;--px-t3: #A1A4AB;--px-accent: #39C7FF;--px-accent-line: rgba(57, 199, 255, 0.45);--px-accent-soft: #122F3B;--px-on-accent: #08090A;--px-note: #10241A;--px-note-line: rgba(159, 224, 188, 0.30);--px-note-t: #9FE0BC;--px-warn: #2A1B0A;--px-warn-line: rgba(255, 201, 138, 0.30);--px-warn-t: #FFC98A;--px-blue: #0A1A24;--px-blue-line: rgba(57, 195, 255, 0.30);--px-blue-t: #97D8FF;--px-danger: #2A0F12;--px-danger-line: rgba(255, 138, 148, 0.30);--px-danger-t: #FFB3B8}#content{line-height:1.75}#page-title,#content h1{font-size:clamp(2rem, 1.4rem + 2.1vw, 2.875rem);line-height:1.12;letter-spacing:-0.02em;font-weight:600}#content h2,#content h3,#content h4{letter-spacing:-0.01em;font-weight:600}#content code,#content kbd,#content samp{font-feature-settings:'tnum' 1}#content a:not(.card){color:var(--px-accent);text-decoration-thickness:1px;text-underline-offset:3px}:focus-visible{outline:2px solid var(--px-accent-line);outline-offset:2px}html.dark :focus-visible{outline-color:var(--px-accent-line)}::selection{background:var(--px-accent-soft)}#navbar{background:var(--px-bg);border-bottom:1px solid var(--px-line)}#navbar div:has(>.nav-tabs){position:relative}#navbar div:has(>.nav-tabs)::before{content:'';position:absolute;top:0;left:50%;width:100vw;margin-left:-50vw;border-top:1px solid var(--px-line);pointer-events:none}.nav-tabs-item[data-active]{box-shadow:inset 0 -2px 0 var(--px-accent)}#search-bar-entry{background:var(--px-surface);border:1px solid var(--px-line);border-radius:var(--px-radius-md)}#assistant-entry{background:var(--px-surface);border:1px solid var(--px-accent-line);border-radius:var(--px-radius-md)}#assistant-entry svg{color:var(--px-accent)}#page-context-menu{font-size:0.9375rem;align-items:stretch}.page-context-dropdown{font-size:0.9375rem;align-items:stretch}.product-selector{position:relative;display:inline-flex;align-items:stretch;flex:0 0 auto}.product-selector--desktop{margin-left:0.75rem;align-self:center}#page-context-menu-button{padding:10px 14px;border-radius:var(--px-radius-md) 0 0 var(--px-radius-md);background:var(--px-surface);border-color:var(--px-line)}.page-context-dropdown__label{display:inline-flex;align-items:center;padding:10px 14px;border:1px solid var(--px-line);border-radius:var(--px-radius-md) 0 0 var(--px-radius-md);background:var(--px-surface);border-color:var(--px-line);color:var(--px-t1);font-family:inherit;font-weight:400;text-decoration:none}#page-context-menu-button>div{font-size:0.9375rem;gap:9px}#page-context-menu>button[aria-haspopup]{height:auto;align-self:stretch;aspect-ratio:auto;padding:10px 11px;border-radius:0 var(--px-radius-md) var(--px-radius-md) 0;background:var(--px-surface);border-color:var(--px-line)}.page-context-dropdown__chevron{display:inline-flex;align-items:center;height:auto;align-self:stretch;aspect-ratio:auto;padding:10px 11px;border:1px solid var(--px-line);border-left:0;border-radius:0 var(--px-radius-md) var(--px-radius-md) 0;background:var(--px-surface);color:var(--px-t3);cursor:pointer}.page-context-dropdown__chevron svg{display:block;width:1rem;height:1rem;transition:transform 150ms ease}.page-context-dropdown__chevron[aria-expanded=\"true\"] svg{transform:rotate(180deg)}.page-context-dropdown__menu{position:absolute;z-index:60;top:calc(100% + 0.55rem);left:0;min-width:12.5rem;padding:0.4rem;background:var(--px-bg);border:1px solid var(--px-line);border-radius:var(--px-radius-md);box-shadow:0 0.75rem 1.5rem rgb(8 9 10 / 0.18)}.page-context-dropdown__menu[hidden]{display:none}.page-context-dropdown__item{display:flex;align-items:center;justify-content:space-between;min-height:2.5rem;padding:0.55rem 0.65rem;color:var(--px-t1);border-radius:var(--px-radius-sm);text-decoration:none}.page-context-dropdown__item:hover,.page-context-dropdown__item:focus-visible{color:var(--px-accent);background:var(--px-accent-soft)}.page-context-dropdown__item[data-selected=\"true\"]{color:var(--px-accent);font-weight:500}.page-context-dropdown__item[data-selected=\"true\"]::after{content:'✓';margin-left:1.5rem}@media (max-width: 767px){#navbar .product-selector--desktop{display:none}#mobile-nav-content .product-selector--mobile{margin:0.5rem 0 1rem}#mobile-nav-content .page-context-dropdown__label{flex:1 1 auto}#mobile-nav-content .page-context-dropdown__menu{position:static;margin-top:0.4rem}}#sidebar-content li[data-active]>a{background:var(--px-accent-soft);color:var(--px-accent);border-radius:var(--px-radius-md);font-weight:500}.sidebar-group-header{font-weight:600;color:var(--px-t1)}ul.sidebar-group:has(>li[id=\"/docs/phoenix/get-started\"]),ul.sidebar-group:has(>li[id=\"/docs/phoenix/integrations/developer-tools/coding-agents\"]),ul.sidebar-group:has(>li[id=\"/docs/phoenix/pxi\"]){margin-top:1px}.toc-item[data-active],.toc-item[data-active] a{color:var(--px-accent);font-weight:400}.card.card{background:var(--px-surface);border-color:var(--px-line);border-radius:var(--px-radius-lg);box-shadow:none}.frame.frame{background:var(--px-surface);border:1px solid var(--px-line);border-radius:var(--px-radius-lg)}.accordion.accordion,.accordion-group.accordion-group{border-radius:var(--px-radius-md);border-color:var(--px-line)}.accordion.accordion{background:var(--px-surface)}.code-block.code-block,.code-group.code-group{background:var(--px-code-bg);border-color:var(--px-line);border-radius:var(--px-radius-md)}.code-block-background{background:var(--px-code-bg)!important}html.dark .code-block-background{background:var(--px-code-bg)!important}#content :not(pre)>code{background:var(--px-chip);border-radius:var(--px-radius-sm)}.code-block:has([data-floating-buttons]) [data-fade-overlay]{background-image:none}[data-floating-buttons] button{background:var(--px-chip)}.callout .code-block.code-block,.callout .code-group.code-group,.callout .code-block-background,html.dark .callout .code-block-background{background:var(--px-bg)!important}.callout{border-radius:var(--px-radius-lg)}.callout[data-callout-type=\"callout\"],.callout[data-callout-type=\"info\"]{background:var(--px-surface);border-color:var(--px-line)}.callout[data-callout-type=\"callout\"] [data-component-part=\"callout-content\"],.callout[data-callout-type=\"info\"] [data-component-part=\"callout-content\"]{color:var(--px-t2)!important}.callout[data-callout-type=\"tip\"],.callout[data-callout-type=\"check\"]{background:var(--px-note);border-color:var(--px-note-line)}.callout[data-callout-type=\"tip\"] [data-component-part=\"callout-content\"],.callout[data-callout-type=\"check\"] [data-component-part=\"callout-content\"]{color:var(--px-note-t)!important}.callout[data-callout-type=\"warning\"]{background:var(--px-warn);border-color:var(--px-warn-line)}.callout[data-callout-type=\"warning\"] [data-component-part=\"callout-content\"]{color:var(--px-warn-t)!important}.callout[data-callout-type=\"note\"]{background:var(--px-blue);border-color:var(--px-blue-line)}.callout[data-callout-type=\"note\"] [data-component-part=\"callout-content\"]{color:var(--px-blue-t)!important}.callout[data-callout-type=\"danger\"]{background:var(--px-danger);border-color:var(--px-danger-line)}.callout[data-callout-type=\"danger\"] [data-component-part=\"callout-content\"]{color:var(--px-danger-t)!important}[data-component-part=\"step-number\"]>div{background:var(--px-accent-soft);border:1px solid var(--px-accent-line);color:var(--px-accent);font-weight:500}.update.update-container{flex-direction:column;gap:0.5rem;border-top:1px solid var(--px-line)}.update.update-container:first-of-type{border-top:none}.update.update-container>div:first-child{width:100%;position:static}.update.update-container>div:last-child{width:100%;max-width:none}#content th{color:var(--px-t1);font-weight:600;border-bottom:1px solid var(--px-line)}#content td{border-bottom:1px solid var(--px-line)}footer{border-top:1px solid var(--px-line)}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;border:0}table{display:table!important}.step-title{font-size:1.5rem!important}.dark .invert-on-dark{filter:invert(1)}.release-update-read-more{display:inline-block;margin-top:0.75rem;font-weight:500;color:var(--primary);text-decoration:none}"}],"page":{"pagePath":"docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions","slug":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions","pageMetadata":{"openapi":"post /v1/chat/completions","title":"OpenAI-compatible chat completions","description":"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set `stream: true` for server-sent events of `chat.completion.chunk` payloads terminated by `data: [DONE]`. Tool calling is not supported.\n\n**Phoenix is not an AI gateway.** The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be ’\", \":\", \"’ for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or ‘custom:\", \":\", \"’ for a stored custom provider, e.g. ‘openai:gpt-4o’ or ‘anthropic:claude-sonnet-4-5’. Set \", _jsx(_components.code, {\n children: \"stream: true\"\n }), \" for server-sent events of \", _jsx(_components.code, {\n children: \"chat.completion.chunk\"\n }), \" payloads terminated by \", _jsx(_components.code, {\n children: \"data: [DONE]\"\n }), \". Tool calling is not supported.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Phoenix is not an AI gateway.\"\n }), \" The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light-default","dark":"github-dark-default"}},"config":{},"pageMetadata":{"openapi":"post /v1/chat/completions","title":"OpenAI-compatible chat completions","description":"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set `stream: true` for server-sent events of `chat.completion.chunk` payloads terminated by `data: [DONE]`. Tool calling is not supported.\n\n**Phoenix is not an AI gateway.** The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/arizeai-433a7140/ad8f81ded4a76bea/docs/analytics.js","/_mintlify/custom/arizeai-433a7140/f5010f618af65dc2/docs/product-selector.js"],"openApiReferenceData":{"operation":{"tags":["chat_completions"],"summary":"OpenAI-compatible chat completions","description":"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set `stream: true` for server-sent events of `chat.completion.chunk` payloads terminated by `data: [DONE]`. Tool calling is not supported.\n\n**Phoenix is not an AI gateway.** The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.","operationId":"createChatCompletion","requestBody":"d9c408e9-38f5-4157-a847-d431b865d674","responses":{"200":"00184797-7754-41db-b5f5-6698a6eeb6d7","400":"ab0d4abd-2ec2-4b38-ae53-5c7a35f195a8","403":"42493696-d4da-4ac4-af80-2f11e155d28d","404":"00fdff6a-837c-4c6e-93d6-81ce6e0325b0","422":"34774b42-58d1-4f03-9538-4afb4b927a1b"},"method":"post","type":"path","servers":[],"security":[],"path":"/v1/chat/completions","baseUrlOptions":[],"title":"OpenAI-compatible chat completions","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"model":{"type":"string","title":"Model","description":"Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"messages":{"items":{"properties":{"role":{"type":"string","enum":["system","developer","user","assistant"],"title":"Role","isRequired":true,"uniqueKey":"messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"properties":{"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].type","typeLabel":"string"},"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].text","typeLabel":"string"}},"type":"object","required":["type","text"],"title":"ChatCompletionTextPart","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX]","typeLabel":"ChatCompletionTextPart · object"},"title":"Content","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1","typeLabel":"ChatCompletionTextPart · object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].content","typeLabel":"string | ChatCompletionTextPart · object[]"}},"type":"object","required":["role","content"],"title":"ChatCompletionRequestMessage","uniqueKey":"messages.items.[INDEX]","typeLabel":"ChatCompletionRequestMessage · object"},"type":"array","minItems":1,"title":"Messages","isRequired":true,"uniqueKey":"messages","typeLabel":"ChatCompletionRequestMessage · object[]"},"stream":{"type":"boolean","title":"Stream","default":false,"uniqueKey":"stream","typeLabel":"boolean"},"temperature":{"oneOf":[{"type":"number","title":"Temperature","uniqueKey":"temperature.oneOf.0","typeLabel":"number"},{"type":"null","title":"Temperature","uniqueKey":"temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"temperature","typeLabel":"number | null"},"top_p":{"oneOf":[{"type":"number","title":"Top P","uniqueKey":"top_p.oneOf.0","typeLabel":"number"},{"type":"null","title":"Top P","uniqueKey":"top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_p","typeLabel":"number | null"},"max_tokens":{"oneOf":[{"type":"integer","title":"Max Tokens","uniqueKey":"max_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Tokens","uniqueKey":"max_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_tokens","typeLabel":"integer | null"},"max_completion_tokens":{"oneOf":[{"type":"integer","title":"Max Completion Tokens","uniqueKey":"max_completion_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Completion Tokens","uniqueKey":"max_completion_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_completion_tokens","typeLabel":"integer | null"},"stop":{"oneOf":[{"type":"string","title":"Stop","uniqueKey":"stop.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"stop.oneOf.1.items.[INDEX]","typeLabel":"string"},"title":"Stop","uniqueKey":"stop.oneOf.1","typeLabel":"string[]"},{"type":"null","title":"Stop","uniqueKey":"stop.oneOf.2","typeLabel":"null"}],"uniqueKey":"stop","typeLabel":"string | string[] | null"},"frequency_penalty":{"oneOf":[{"type":"number","title":"Frequency Penalty","uniqueKey":"frequency_penalty.oneOf.0","typeLabel":"number"},{"type":"null","title":"Frequency Penalty","uniqueKey":"frequency_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"frequency_penalty","typeLabel":"number | null"},"presence_penalty":{"oneOf":[{"type":"number","title":"Presence Penalty","uniqueKey":"presence_penalty.oneOf.0","typeLabel":"number"},{"type":"null","title":"Presence Penalty","uniqueKey":"presence_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"presence_penalty","typeLabel":"number | null"},"seed":{"oneOf":[{"type":"integer","title":"Seed","uniqueKey":"seed.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Seed","uniqueKey":"seed.oneOf.1","typeLabel":"null"}],"uniqueKey":"seed","typeLabel":"integer | null"},"n":{"oneOf":[{"type":"integer","title":"N","uniqueKey":"n.oneOf.0","typeLabel":"integer"},{"type":"null","title":"N","uniqueKey":"n.oneOf.1","typeLabel":"null"}],"uniqueKey":"n","typeLabel":"integer | null"},"stream_options":{"oneOf":[{"type":"object","title":"ChatCompletionStreamOptions","properties":{"include_usage":{"type":"boolean","title":"Include Usage","default":false,"uniqueKey":"stream_options.oneOf.0.include_usage","typeLabel":"boolean"}},"uniqueKey":"stream_options.oneOf.0","typeLabel":"ChatCompletionStreamOptions · object"},{"type":"null","uniqueKey":"stream_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"stream_options","typeLabel":"ChatCompletionStreamOptions · object | null"},"tools":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"tools.oneOf.0.items.[INDEX]","typeLabel":"any"},"title":"Tools","uniqueKey":"tools.oneOf.0","typeLabel":"any[]"},{"type":"null","title":"Tools","uniqueKey":"tools.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools","typeLabel":"any[] | null"},"tool_choice":{"oneOf":[{"title":"Tool Choice"},{"type":"null","title":"Tool Choice","uniqueKey":"tool_choice.oneOf.1","typeLabel":"null"}],"uniqueKey":"tool_choice","typeLabel":"null"},"response_format":{"oneOf":[{"type":"object","title":"Response Format","additionalProperties":true,"uniqueKey":"response_format.oneOf.0","typeLabel":"Response Format · object"},{"type":"null","title":"Response Format","uniqueKey":"response_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_format","typeLabel":"Response Format · object | null"}},"type":"object","required":["model","messages"],"title":"CreateChatCompletionRequestBody","examples":[{"messages":[{"content":"You are a helpful assistant.","role":"system"},{"content":"Say hello.","role":"user"}],"model":"openai:gpt-4o"}],"uniqueKey":"","typeLabel":"CreateChatCompletionRequestBody · object"},"examples":{"Example":{"title":"Example","value":{"messages":[{"content":"You are a helpful assistant.","role":"system"},{"content":"Say hello.","role":"user"}],"model":"openai:gpt-4o"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"00184797-7754-41db-b5f5-6698a6eeb6d7":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"created":{"type":"integer","title":"Created","isRequired":true,"uniqueKey":"created","typeLabel":"integer"},"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"choices":{"items":{"properties":{"message":{"properties":{"content":{"type":"string","title":"Content","isRequired":true,"uniqueKey":"choices.items.[INDEX].message.content","typeLabel":"string"},"role":{"type":"string","const":"assistant","title":"Role","default":"assistant","uniqueKey":"choices.items.[INDEX].message.role","typeLabel":"string"}},"type":"object","required":["content"],"title":"ChatCompletionMessage","isRequired":true,"uniqueKey":"choices.items.[INDEX].message","typeLabel":"ChatCompletionMessage · object"},"finish_reason":{"type":"string","title":"Finish Reason","isRequired":true,"uniqueKey":"choices.items.[INDEX].finish_reason","typeLabel":"string"},"index":{"type":"integer","title":"Index","default":0,"uniqueKey":"choices.items.[INDEX].index","typeLabel":"integer"}},"type":"object","required":["message","finish_reason"],"title":"ChatCompletionChoice","uniqueKey":"choices.items.[INDEX]","typeLabel":"ChatCompletionChoice · object"},"type":"array","title":"Choices","isRequired":true,"uniqueKey":"choices","typeLabel":"ChatCompletionChoice · object[]"},"usage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","isRequired":true,"uniqueKey":"usage.prompt_tokens","typeLabel":"integer"},"completion_tokens":{"type":"integer","title":"Completion Tokens","isRequired":true,"uniqueKey":"usage.completion_tokens","typeLabel":"integer"},"total_tokens":{"type":"integer","title":"Total Tokens","isRequired":true,"uniqueKey":"usage.total_tokens","typeLabel":"integer"},"prompt_tokens_details":{"oneOf":[{"type":"object","title":"ChatCompletionUsagePromptTokensDetails","required":["cached_tokens"],"properties":{"cached_tokens":{"type":"integer","title":"Cached Tokens","isRequired":true,"uniqueKey":"usage.prompt_tokens_details.oneOf.0.cached_tokens","typeLabel":"integer"}},"uniqueKey":"usage.prompt_tokens_details.oneOf.0","typeLabel":"ChatCompletionUsagePromptTokensDetails · object"},{"type":"null","uniqueKey":"usage.prompt_tokens_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.prompt_tokens_details","typeLabel":"ChatCompletionUsagePromptTokensDetails · object | null"}},"type":"object","required":["prompt_tokens","completion_tokens","total_tokens"],"title":"ChatCompletionUsage","isRequired":true,"uniqueKey":"usage","typeLabel":"ChatCompletionUsage · object"},"object":{"type":"string","const":"chat.completion","title":"Object","default":"chat.completion","uniqueKey":"object","typeLabel":"string"}},"type":"object","required":["id","created","model","choices","usage"],"title":"ChatCompletion","uniqueKey":"","typeLabel":"ChatCompletion · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","created":123,"model":"\u003cstring>","choices":[{"message":{"content":"\u003cstring>","role":"assistant"},"finish_reason":"\u003cstring>","index":0}],"usage":{"prompt_tokens":123,"completion_tokens":123,"total_tokens":123,"prompt_tokens_details":{"cached_tokens":123}},"object":"chat.completion"}}},"exampleType":"generated"}},"exampleType":"generated"},"ab0d4abd-2ec2-4b38-ae53-5c7a35f195a8":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","title":"Type","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","title":"Param","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"type":"object","required":["message","type"],"title":"ChatCompletionErrorDetail","isRequired":true,"uniqueKey":"error","typeLabel":"ChatCompletionErrorDetail · object"}},"type":"object","required":["error"],"title":"ChatCompletionErrorResponse","uniqueKey":"","typeLabel":"ChatCompletionErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","param":"\u003cstring>","code":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"42493696-d4da-4ac4-af80-2f11e155d28d":{"content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"00fdff6a-837c-4c6e-93d6-81ce6e0325b0":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","title":"Type","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","title":"Param","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"type":"object","required":["message","type"],"title":"ChatCompletionErrorDetail","isRequired":true,"uniqueKey":"error","typeLabel":"ChatCompletionErrorDetail · object"}},"type":"object","required":["error"],"title":"ChatCompletionErrorResponse","uniqueKey":"","typeLabel":"ChatCompletionErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","param":"\u003cstring>","code":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"34774b42-58d1-4f03-9538-4afb4b927a1b":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","title":"Type","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","title":"Param","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"type":"object","required":["message","type"],"title":"ChatCompletionErrorDetail","isRequired":true,"uniqueKey":"error","typeLabel":"ChatCompletionErrorDetail · object"}},"type":"object","required":["error"],"title":"ChatCompletionErrorResponse","uniqueKey":"","typeLabel":"ChatCompletionErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","param":"\u003cstring>","code":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"schemas/openapi.json"},"subdomain":"arizeai-433a7140","siteName":"Phoenix","title":"OpenAI-compatible chat completions - Phoenix","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-08T17:44:02.899Z","originalFileLocation":"docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions.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=\"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be \u0026#x27;{provider}:{model_name}\u0026#x27; for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or \u0026#x27;custom:{provider_id}:{model_name}\u0026#x27; for a stored custom provider, e.g. \u0026#x27;openai:gpt-4o\u0026#x27; or \u0026#x27;anthropic:claude-sonnet-4-5\u0026#x27;. Set stream: true for server-sent events of chat.completion.chunk payloads terminated by data: [DONE]. Tool calling is not supported. Phoenix is not an AI gateway. The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Phoenix\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/arizeai-433a7140/QaORPmVscwA-cjPG/_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/arizeai-433a7140/QaORPmVscwA-cjPG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/arizeai-433a7140/QaORPmVscwA-cjPG/_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/arizeai-433a7140/QaORPmVscwA-cjPG/_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/arizeai-433a7140/QaORPmVscwA-cjPG/_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/arizeai-433a7140/QaORPmVscwA-cjPG/_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/arizeai-433a7140/QaORPmVscwA-cjPG/_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/arizeai-433a7140/QaORPmVscwA-cjPG/_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/arizeai-433a7140/QaORPmVscwA-cjPG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"OpenAI-compatible chat completions - Phoenix\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be \u0026#x27;{provider}:{model_name}\u0026#x27; for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or \u0026#x27;custom:{provider_id}:{model_name}\u0026#x27; for a stored custom provider, e.g. \u0026#x27;openai:gpt-4o\u0026#x27; or \u0026#x27;anthropic:claude-sonnet-4-5\u0026#x27;. Set stream: true for server-sent events of chat.completion.chunk payloads terminated by data: [DONE]. Tool calling is not supported. Phoenix is not an AI gateway. The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Phoenix\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://arizeai-433a7140.mintlify.site/_mintlify/api/og/v2?division=Chat+Completions\u0026amp;title=OpenAI-compatible+chat+completions\u0026amp;description=Creates+a+chat+completion+using+the+OpenAI+wire+format%2C+proxying+to+the+selected+provider+with+credentials+resolved+on+the+server+%28secret+store+first%2C+environme\u0026amp;theme=157e5839ca66cf301513f501\u0026amp;signature=5956277891f2d0f288deda9928dc1539cb17db40d90f10edca3ec1846da03ecb\">\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=\"OpenAI-compatible chat completions - Phoenix\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be \u0026#x27;{provider}:{model_name}\u0026#x27; for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or \u0026#x27;custom:{provider_id}:{model_name}\u0026#x27; for a stored custom provider, e.g. \u0026#x27;openai:gpt-4o\u0026#x27; or \u0026#x27;anthropic:claude-sonnet-4-5\u0026#x27;. Set stream: true for server-sent events of chat.completion.chunk payloads terminated by data: [DONE]. Tool calling is not supported. Phoenix is not an AI gateway. The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://arizeai-433a7140.mintlify.site/_mintlify/api/og/v2?division=Chat+Completions\u0026amp;title=OpenAI-compatible+chat+completions\u0026amp;description=Creates+a+chat+completion+using+the+OpenAI+wire+format%2C+proxying+to+the+selected+provider+with+credentials+resolved+on+the+server+%28secret+store+first%2C+environme\u0026amp;theme=157e5839ca66cf301513f501\u0026amp;signature=5956277891f2d0f288deda9928dc1539cb17db40d90f10edca3ec1846da03ecb\">\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/arizeai-433a7140/QaORPmVscwA-cjPG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Phoenix\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00769E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://arize.com/#organization\",\"name\":\"Phoenix\",\"url\":\"https://arize.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/arizeai-433a7140/fitXeWll7ezQrIcg/docs/logo/light.png?fit=max\u0026auto=format\u0026n=fitXeWll7ezQrIcg\u0026q=85\u0026s=78e92baf10dd9eced114496ccb88dbf1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://arize.com#website\",\"name\":\"Phoenix\",\"url\":\"https://arize.com\",\"publisher\":{\"@id\":\"https://arize.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions#webpage\",\"url\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions\",\"name\":\"OpenAI-compatible chat completions\",\"description\":\"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set stream: true for server-sent events of chat.completion.chunk payloads terminated by data: [DONE]. Tool calling is not supported. Phoenix is not an AI gateway. The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.\",\"dateModified\":\"2026-09-08T17:44:02.899Z\",\"isPartOf\":{\"@id\":\"https://arize.com#website\"},\"breadcrumb\":{\"@id\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Rest API\",\"item\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/create-a-session\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"OpenAI-compatible chat completions\",\"item\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions#apireference\",\"headline\":\"OpenAI-compatible chat completions\",\"name\":\"OpenAI-compatible chat completions\",\"description\":\"Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set stream: true for server-sent events of chat.completion.chunk payloads terminated by data: [DONE]. Tool calling is not supported. Phoenix is not an AI gateway. The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.\",\"url\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions\",\"mainEntityOfPage\":{\"@id\":\"https://arize.com/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions#webpage\"},\"dateModified\":\"2026-09-08T17:44:02.899Z\",\"publisher\":{\"@id\":\"https://arize.com/#organization\"},\"isPartOf\":{\"@id\":\"https://arize.com#website\"}}]}\u003c/script>","siteName":"Phoenix","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/phoenix"}]},{"tab":"Learn","pages":[{"title":"Learn","href":"/docs/phoenix/learn"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/docs/phoenix/integrations"}]},{"tab":"SDK \u0026 API Reference","groups":[{"group":"Python","pages":[{"title":"Python SDK","href":"/docs/phoenix/sdk-api-reference"},{"title":"arize-phoenix-client","href":"/docs/phoenix/sdk-api-reference/python/arize-phoenix-client"},{"title":"arize-phoenix-evals","href":"/docs/phoenix/sdk-api-reference/python/arize-phoenix-evals"},{"title":"arize-phoenix-otel","href":"/docs/phoenix/sdk-api-reference/python/arize-phoenix-otel"}]},{"group":"TypeScript","pages":[{"title":"TypeScript SDK","href":"/docs/phoenix/sdk-api-reference/typescript/overview"},{"group":"@arizeai/phoenix-client","root":{"title":"@arizeai/phoenix-client","href":"/docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-client"},"pages":[{"title":"Overview","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/overview"},{"title":"Projects","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/projects"},{"title":"Traces","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/traces"},{"title":"Spans","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/spans"},{"title":"Annotations","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/annotations"},{"title":"Span Annotations","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/span-annotations"},{"title":"Document Annotations","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/document-annotations"},{"title":"Session Annotations","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/session-annotations"},{"title":"Sessions","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/sessions"},{"title":"Secrets","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/secrets"},{"title":"Users","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/users"},{"title":"Prompts","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/prompts"},{"title":"Datasets","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/datasets"},{"title":"Experiments","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/experiments"},{"group":"CI eval tests","pages":[{"title":"CI Eval Tests","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/ci-evals"},{"title":"CI Eval Tests: Vitest","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/ci-evals-vitest"},{"title":"CI Eval Tests: Jest","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/ci-evals-jest"},{"title":"CI Eval Test Annotations","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/ci-evals-annotations"}]}]},{"group":"@arizeai/phoenix-evals","root":{"title":"@arizeai/phoenix-evals","href":"/docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-evals"},"pages":[{"title":"Overview","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/overview"},{"title":"Create Evaluator","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/create-evaluator"},{"title":"LLM Evaluators","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/llm-evaluators"},{"title":"Classification Metrics","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/classification-metrics"},{"title":"Templates","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/templates"},{"title":"Classification","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/classification"},{"title":"Phoenix Integration","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/phoenix-integration"}]},{"group":"@arizeai/phoenix-otel","root":{"title":"@arizeai/phoenix-otel","href":"/docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-otel"},"pages":[{"title":"Overview","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-otel/overview"},{"title":"Tracing Helpers","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-otel/tracing-helpers"},{"title":"Context Attributes","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-otel/context-attributes"},{"title":"Manual Spans","href":"/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-otel/manual-spans"}]},{"title":"@arizeai/openinference-core","href":"/docs/phoenix/sdk-api-reference/typescript/arizeai-openinference-core"},{"title":"@arizeai/phoenix-cli","href":"/docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-cli"}]},{"group":"Rest API","pages":[{"title":"REST API Overview","href":"/docs/phoenix/sdk-api-reference/rest-api/overview"},{"group":"API Reference","pages":[{"group":"Agent Sessions","pages":[{"openapi":"post /v1/agent_sessions","title":"Create Session","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/create-a-session"},{"openapi":"get /v1/agent_sessions","title":"List Sessions","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/list-sessions"},{"openapi":"get /v1/agent_sessions/{session_id}","title":"Get Session","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/get-a-session-by-id"},{"openapi":"patch /v1/agent_sessions/{session_id}","title":"Patch Session","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/update-a-session"},{"openapi":"get /v1/agent_sessions/{session_id}/messages","title":"List Session Messages","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/list-session-messages"},{"openapi":"post /v1/agent_sessions/{session_id}/tool_outputs","title":"Submit Agent Session Tool Outputs","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/submit-tool-outputs"},{"openapi":"post /v1/agent_sessions/{session_id}/compact","title":"Compact Agent Session","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/compact-a-session"},{"openapi":"post /v1/agent_sessions/{session_id}/chat","title":"Chat","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/agent-sessions/chat-with-a-session"}]},{"group":"Annotation Configs","pages":[{"openapi":"get /v1/annotation_configs","title":"List annotation configurations","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/list-annotation-configurations"},{"openapi":"post /v1/annotation_configs","title":"Create an annotation configuration","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/create-an-annotation-configuration"},{"openapi":"get /v1/annotation_configs/{config_identifier}","title":"Get an annotation configuration by ID or name","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/get-an-annotation-configuration-by-id-or-name"},{"openapi":"put /v1/annotation_configs/{config_id}","title":"Update an annotation configuration","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/update-an-annotation-configuration"},{"openapi":"delete /v1/annotation_configs/{config_id}","title":"Delete an annotation configuration","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/delete-an-annotation-configuration"},{"openapi":"get /v1/projects/{project_identifier}/annotation_configs","title":"List annotation configurations assigned to a project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/list-annotation-configurations-assigned-to-a-project"},{"openapi":"put /v1/projects/{project_identifier}/annotation_configs/{config_identifier}","title":"Assign an annotation configuration to a project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/assign-an-annotation-configuration-to-a-project"},{"openapi":"delete /v1/projects/{project_identifier}/annotation_configs/{config_identifier}","title":"Unassign an annotation configuration from a project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/unassign-an-annotation-configuration-from-a-project"},{"openapi":"put /v1/projects/{project_identifier}/annotation_configs","title":"Replace the set of annotation configurations assigned to a project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotation-configs/replace-the-set-of-annotation-configurations-assigned-to-a-project"}]},{"group":"Annotations","pages":[{"openapi":"get /v1/projects/{project_identifier}/span_annotations","title":"Get span annotations filtered by span_ids and/or identifier.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotations/get-span-annotations-for-a-list-of-span_ids"},{"openapi":"get /v1/projects/{project_identifier}/trace_annotations","title":"Get trace annotations filtered by trace_ids and/or identifier.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotations/get-trace-annotations-for-a-list-of-trace_ids"},{"openapi":"get /v1/projects/{project_identifier}/session_annotations","title":"Get session annotations filtered by session_ids and/or identifier.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotations/get-session-annotations-for-a-list-of-session_ids"},{"openapi":"delete /v1/projects/{project_identifier}/span_annotations","title":"Delete span annotations in a project that match the supplied filter.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotations/delete-span-annotations-by-filter"},{"openapi":"delete /v1/projects/{project_identifier}/trace_annotations","title":"Delete trace annotations in a project that match the supplied filter.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotations/delete-trace-annotations-by-filter"},{"openapi":"delete /v1/projects/{project_identifier}/session_annotations","title":"Delete session annotations in a project that match the supplied filter.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/annotations/delete-session-annotations-by-filter"}]},{"group":"API Keys","pages":[{"openapi":"get /v1/user/api_keys","title":"List the authenticated user's API keys","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/api-keys/list-the-authenticated-users-api-keys"},{"openapi":"post /v1/user/api_keys","title":"Create an API key for the authenticated user","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/api-keys/create-an-api-key-for-the-authenticated-user"},{"openapi":"delete /v1/user/api_keys/{api_key_id}","title":"Delete a user API key","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/api-keys/delete-a-user-api-key"},{"openapi":"get /v1/users/api_keys","title":"List all user API keys","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/api-keys/list-all-user-api-keys"},{"openapi":"get /v1/system/api_keys","title":"List system API keys","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/api-keys/list-system-api-keys"},{"openapi":"post /v1/system/api_keys","title":"Create a system API key","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/api-keys/create-a-system-api-key"},{"openapi":"delete /v1/system/api_keys/{api_key_id}","title":"Delete a system API key","description":"Permanently revoke a system API key. The key stops working immediately. Restricted to admins.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/api-keys/delete-a-system-api-key"}]},{"group":"Chat Completions","pages":[{"openapi":"post /v1/chat/completions","title":"OpenAI-compatible chat completions","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/chat-completions/openai-compatible-chat-completions"}]},{"group":"Datasets","pages":[{"openapi":"get /v1/datasets","title":"List datasets","description":null,"href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/list-datasets"},{"openapi":"get /v1/datasets/{id}","title":"Get dataset by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/get-dataset-by-id"},{"openapi":"delete /v1/datasets/{id}","title":"Delete dataset by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/delete-dataset-by-id"},{"openapi":"get /v1/datasets/{id}/versions","title":"List dataset versions","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/list-dataset-versions"},{"openapi":"post /v1/datasets/upload","title":"Upload dataset from JSON, JSONL, CSV, or PyArrow","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/upload-dataset-from-json-csv-or-pyarrow"},{"openapi":"get /v1/datasets/{id}/examples","title":"Get examples from a dataset","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/get-examples-from-a-dataset"},{"openapi":"get /v1/datasets/{id}/csv","title":"Download dataset examples as CSV file","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/download-dataset-examples-as-csv-file"},{"openapi":"get /v1/datasets/{id}/jsonl","title":"Download dataset examples as JSONL file","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/download-dataset-examples-as-jsonl-file"},{"openapi":"get /v1/datasets/{id}/jsonl/openai_ft","title":"Download dataset examples as OpenAI fine-tuning JSONL file","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/download-dataset-examples-as-openai-fine-tuning-jsonl-file"},{"openapi":"get /v1/datasets/{id}/jsonl/openai_evals","title":"Download dataset examples as OpenAI evals JSONL file","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/datasets/download-dataset-examples-as-openai-evals-jsonl-file"}]},{"group":"Dataset Labels","pages":[{"openapi":"get /v1/dataset_labels","title":"List dataset labels","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/list-dataset-labels"},{"openapi":"post /v1/dataset_labels","title":"Create a dataset label","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/create-a-dataset-label"},{"openapi":"get /v1/dataset_labels/{label_id}","title":"Get a dataset label by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/get-a-dataset-label-by-id"},{"openapi":"patch /v1/dataset_labels/{label_id}","title":"Update a dataset label by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/update-a-dataset-label-by-id"},{"openapi":"delete /v1/dataset_labels/{label_id}","title":"Delete a dataset label by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/delete-a-dataset-label-by-id"},{"openapi":"get /v1/datasets/{dataset_identifier}/labels","title":"List the labels applied to a dataset","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/list-the-labels-applied-to-a-dataset"},{"openapi":"put /v1/datasets/{dataset_identifier}/labels","title":"Replace the set of labels applied to a dataset","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/replace-the-set-of-labels-applied-to-a-dataset"},{"openapi":"put /v1/datasets/{dataset_identifier}/labels/{label_id}","title":"Apply a label to a dataset","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/apply-a-label-to-a-dataset"},{"openapi":"delete /v1/datasets/{dataset_identifier}/labels/{label_id}","title":"Remove a label from a dataset","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/dataset-labels/remove-a-label-from-a-dataset"}]},{"group":"Experiments","pages":[{"openapi":"get /v1/datasets/{dataset_id}/experiments","title":"List experiments by dataset","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/list-experiments-by-dataset"},{"openapi":"post /v1/datasets/{dataset_id}/experiments","title":"Create experiment on a dataset","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/create-experiment-on-a-dataset"},{"openapi":"get /v1/experiments/{experiment_id}","title":"Get experiment by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/get-experiment-by-id"},{"openapi":"patch /v1/experiments/{experiment_id}","title":"Update an experiment by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/update-an-experiment-by-id"},{"openapi":"delete /v1/experiments/{experiment_id}","title":"Delete experiment by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/delete-experiment-by-id"},{"openapi":"get /v1/experiments/{experiment_id}/tags","title":"List the tags applied to an experiment","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/list-the-tags-applied-to-an-experiment"},{"openapi":"post /v1/experiments/{experiment_id}/tags","title":"Assign a tag to an experiment","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/assign-a-tag-to-an-experiment"},{"openapi":"delete /v1/experiments/{experiment_id}/tags/{tag_identifier}","title":"Remove a tag from an experiment","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/remove-a-tag-from-an-experiment"},{"openapi":"get /v1/experiments/{experiment_id}/json","title":"Download experiment runs as a JSON file","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/download-experiment-runs-as-a-json-file"},{"openapi":"get /v1/experiments/{experiment_id}/csv","title":"Download experiment runs as a CSV file","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/download-experiment-runs-as-a-csv-file"},{"openapi":"get /v1/experiments/{experiment_id}/runs","title":"List runs for an experiment","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/list-runs-for-an-experiment"},{"openapi":"post /v1/experiments/{experiment_id}/runs","title":"Create run for an experiment","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/create-run-for-an-experiment"},{"openapi":"get /v1/experiments/{experiment_id}/incomplete-runs","title":"Get incomplete runs for an experiment","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/get-incomplete-runs-for-an-experiment"},{"openapi":"post /v1/experiment_evaluations","title":"Create or update evaluation for an experiment run","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/create-or-update-evaluation-for-an-experiment-run"},{"openapi":"get /v1/experiments/{experiment_id}/incomplete-evaluations","title":"Get incomplete evaluations for an experiment","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/experiments/get-incomplete-evaluations-for-an-experiment"}]},{"group":"Traces","pages":[{"openapi":"get /v1/projects/{project_identifier}/traces","title":"List traces for a project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/traces/list-traces-for-a-project"},{"openapi":"delete /v1/projects/{project_identifier}/traces","title":"Delete traces from a project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/traces/delete-traces-from-a-project"},{"openapi":"delete /v1/traces/{trace_identifier}","title":"Delete a trace by identifier","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/traces/delete-a-trace-by-identifier"},{"openapi":"post /v1/trace_annotations","title":"Create trace annotations","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/traces/create-trace-annotations"},{"openapi":"post /v1/trace_notes","title":"Create a trace note","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/traces/create-a-trace-note"}]},{"group":"Spans","pages":[{"openapi":"get /v1/projects/{project_identifier}/spans/otlpv1","title":"Search spans with simple filters (no DSL)","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/spans/search-spans-with-simple-filters-no-dsl"},{"openapi":"get /v1/projects/{project_identifier}/spans","title":"List spans with simple filters (no DSL)","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/spans/list-spans-with-simple-filters-no-dsl"},{"openapi":"post /v1/projects/{project_identifier}/spans","title":"Create spans","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/spans/create-spans"},{"openapi":"post /v1/span_annotations","title":"Create span annotations","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/spans/create-span-annotations"},{"openapi":"post /v1/span_notes","title":"Create a span note","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/spans/create-a-span-note"},{"openapi":"post /v1/document_annotations","title":"Create span document annotations","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/spans/annotate-span-documents"},{"openapi":"delete /v1/spans/{span_identifier}","title":"Delete a span by span_identifier","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/spans/delete-a-span-by-span_identifier"}]},{"group":"Prompts","pages":[{"openapi":"get /v1/prompts","title":"List all prompts","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/list-all-prompts"},{"openapi":"post /v1/prompts","title":"Create a new prompt","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/create-a-new-prompt"},{"openapi":"delete /v1/prompts/{prompt_identifier}","title":"Delete a prompt","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/delete-a-prompt"},{"openapi":"get /v1/prompts/{prompt_identifier}/versions","title":"List prompt versions","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/list-prompt-versions"},{"openapi":"post /v1/prompts/{prompt_identifier}/versions","title":"Create prompt version","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/create-prompt-version"},{"openapi":"get /v1/prompt_versions/{prompt_version_id}","title":"Get prompt version by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/get-prompt-version-by-id"},{"openapi":"get /v1/prompts/{prompt_identifier}/tags/{tag_name}","title":"Get prompt version by tag","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/get-prompt-version-by-tag"},{"openapi":"get /v1/prompts/{prompt_identifier}/latest","title":"Get latest prompt version","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/get-latest-prompt-version"},{"openapi":"get /v1/prompt_versions/{prompt_version_id}/tags","title":"List prompt version tags","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/list-prompt-version-tags"},{"openapi":"post /v1/prompt_versions/{prompt_version_id}/tags","title":"Add tag to prompt version","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/add-tag-to-prompt-version"},{"openapi":"delete /v1/prompt_versions/{prompt_version_id}/tags/{tag_name}","title":"Delete a tag from a prompt version","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/prompts/delete-a-tag-from-a-prompt-version"}]},{"group":"Projects","pages":[{"openapi":"get /v1/projects","title":"List all projects","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/projects/list-all-projects"},{"openapi":"post /v1/projects","title":"Create a new project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/projects/create-a-new-project"},{"openapi":"get /v1/projects/{project_identifier}","title":"Get project by ID or name","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/projects/get-project-by-id-or-name"},{"openapi":"put /v1/projects/{project_identifier}","title":"Update a project by ID or name","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/projects/update-a-project-by-id-or-name"},{"openapi":"delete /v1/projects/{project_identifier}","title":"Delete a project by ID or name","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/projects/delete-a-project-by-id-or-name"}]},{"group":"Sessions","pages":[{"openapi":"get /v1/projects/{project_identifier}/sessions","title":"List sessions for a project","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/sessions/list-project-sessions"},{"openapi":"get /v1/sessions/{session_identifier}","title":"Get session by ID or session_id","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/sessions/get-session-by-id"},{"openapi":"delete /v1/sessions/{session_identifier}","title":"Delete a session by identifier","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/sessions/delete-a-session-by-identifier"},{"openapi":"post /v1/sessions/delete","title":"Bulk delete sessions","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/sessions/bulk-delete-sessions"},{"openapi":"post /v1/session_annotations","title":"Create session annotations","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/sessions/create-session-annotations"},{"openapi":"get /v1/projects/{project_identifier}/session_annotations","title":"Get session annotations filtered by session_ids and/or identifier.","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/sessions/list-session-annotations"},{"openapi":"post /v1/session_notes","title":"Create a session note","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/sessions/create-a-session-note"}]},{"group":"Secrets","pages":[{"openapi":"put /v1/secrets","title":"Upsert or delete secrets","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/secrets/upsert-or-delete-secrets"}]},{"group":"Users","pages":[{"openapi":"get /v1/users","title":"List all users","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/users/list-all-users"},{"openapi":"post /v1/users","title":"Create a new user","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/users/create-a-new-user"},{"openapi":"delete /v1/users/{user_id}","title":"Delete a user by ID","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/users/delete-a-user-by-id"},{"openapi":"get /v1/user","title":"Get the authenticated user","href":"/docs/phoenix/sdk-api-reference/rest-api/api-reference/users/get-the-authenticated-user"}]}]}]},{"group":"OpenInference SDK","pages":[{"title":"OpenInference Python","url":"https://github.com/Arize-ai/openinference/tree/main/python","href":"/docs/phoenix/sdk-api-reference/openinference-sdk/openinference-python"},{"title":"OpenInference Java","href":"/docs/phoenix/sdk-api-reference/openinference-sdk/openinference-java"},{"title":"OpenInference JS","url":"https://github.com/Arize-ai/openinference/tree/main/js","href":"/docs/phoenix/sdk-api-reference/openinference-sdk/openinference-javascript"}]}]},{"tab":"Self-Hosting","pages":[{"title":"Self-Hosting","href":"/docs/phoenix/self-hosting"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/docs/phoenix/cookbook"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/docs/phoenix/release-notes"}]}]},"basePath":"","title":"OpenAI-compatible chat completions - Phoenix","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}