Headers are forwarded to your bot with these exceptions:
host - Excluded
content-length - Excluded
authorization - Excluded (authentication is handled by the API gateway)
accept-encoding - Replaced with identity. Return your response uncompressed: a gzip or deflate response is decompressed for the caller, and other codings aren’t supported
A redirect from your bot is followed only if it stays on your bot’s own server, such as the redirect FastAPI sends to add a trailing slash. Up to 5 redirects are followed per request.Use a relative path in Location. An absolute URL has to match the address Pipecat Cloud used to reach your bot, so one naming localhost or using https:// is treated as leaving the server.A redirect anywhere else, or a longer chain, returns 502 to the caller. To send a caller elsewhere, return the URL in your response body.
Requires base image version 0.1.2 or later. See the Session API
guide for setup instructions and examples.
Authentication using a Pipecat Cloud public API key.
Generate a public API key from your Dashboard (Settings > API Keys > Public > Create key) and include it as a Bearer token in the Authorization header.
The endpoint path defined in your bot using the @app decorator
Response
Successful response from the bot
Response from your bot endpoint. The schema depends on what your bot returns.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pipecat","description":"Documentation for Pipecat, the open source ecosystem for building real-time voice and multimodal AI agents: the Python framework, client SDKs, Pipecat Flows, and Pipecat Cloud hosting.","colors":{"primary":"#4f46e5","light":"#a5b4fc","dark":"#312e81"},"logo":{"light":"https://mintcdn.com/daily/r4jEtY4thtHXjZ16/logo/light.svg?fit=max\u0026auto=format\u0026n=r4jEtY4thtHXjZ16\u0026q=85\u0026s=46cda5b2f0afabd5f0298c64082c4125","dark":"https://mintcdn.com/daily/r4jEtY4thtHXjZ16/logo/dark.svg?fit=max\u0026auto=format\u0026n=r4jEtY4thtHXjZ16\u0026q=85\u0026s=f018b960ba26051755803a128139431b"},"favicon":"https://mintcdn.com/daily/r4jEtY4thtHXjZ16/favicon.svg?fit=max\u0026auto=format\u0026n=r4jEtY4thtHXjZ16\u0026q=85\u0026s=b1e0fb1fa81bb48e6f1e7af1f51fc916","navbar":{"links":[{"href":"https://discord.gg/pipecat","label":"Join the Discord"},{"icon":"github","href":"https://github.com/pipecat-ai/pipecat","label":"Github"}]},"footer":{"socials":{"x":"https://x.com/pipecat_ai","github":"https://github.com/pipecat-ai/pipecat","discord":"https://discord.gg/pipecat"}},"seo":{"metatags":{"og:site_name":"Pipecat","og:locale":"en_US","og:logo":"/logo/pipecat-logo.svg","article:publisher":"Pipecat AI","twitter:site":"@pipecat_ai","og:image:width":"1200","og:image:height":"630"},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"cookies":{"key":"daily_analytics_consent","value":"granted"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"thumbnails":{"fonts":{"family":"Geist"}},"navigation":{"global":{"anchors":[{"anchor":"Pipecat Events","icon":"calendar","href":"https://pipecat.ai/events"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/pipecat"},{"anchor":"GitHub","icon":"github","href":"https://github.com/pipecat-ai/pipecat"},{"anchor":"Changelog","icon":"file","href":"https://github.com/pipecat-ai/pipecat/blob/main/CHANGELOG.md"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"daily","hasAudioNarration":false,"actualSubdomain":"daily","customDomains":["docs.pipecat.ai"],"gitSource":{"type":"github","owner":"pipecat-ai","repo":"docs","deployBranch":"production","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5c2ad3a147584b5c9aafd","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":414},{"language":"default","tag":"Pipecat Server","count":324},{"language":"default","tag":"Services","count":229},{"language":"default","tag":"Pipecat","count":92},{"language":"default","tag":"Text-to-Speech","count":63},{"language":"default","tag":"Pipecat Cloud \u0026 Enterprise","count":55},{"language":"default","tag":"Utilities","count":46},{"language":"default","tag":"Speech-to-Text","count":43},{"language":"default","tag":"Client SDKs","count":34},{"language":"default","tag":"LLM","count":33}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":false},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".compatibility-table table,.compatibility-table th,.compatibility-table td{border:1px solid #ddd;padding:10px}.compatibility-table{width:90%;table-layout:fixed}.compatibility-table tr{width:100%}.compatibility-table th:first-child,.compatibility-table td:first-child{text-align:left;width:100%}.compatibility-table th{writing-mode:sideways-lr;text-align:left}.compatibility-table td{text-align:center;font-weight:bold}.compatibility-table .supported{color:#107714}.compatibility-table .unsupported{color:#de1126}"}],"page":{"pagePath":"api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy","slug":"/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy","pageMetadata":{"title":"Session API","og:title":"Session API - Pipecat Cloud","description":"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.","openapi":"GET /{serviceName}/sessions/{sessionId}/{path}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Send HTTP requests to endpoints defined in your running bot. Supports `,_jsx(_components.code,{children:`GET`}),`, `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PUT`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, `,_jsx(_components.code,{children:`DELETE`}),`, `,_jsx(_components.code,{children:`OPTIONS`}),`, and `,_jsx(_components.code,{children:`HEAD`}),` methods.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-headers`,children:`Request Headers`}),`\n`,_jsx(_components.p,{children:`Headers are forwarded to your bot with these exceptions:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`host`}),` - Excluded`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`content-length`}),` - Excluded`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`authorization`}),` - Excluded (authentication is handled by the API gateway)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`accept-encoding`}),` - Replaced with `,_jsx(_components.code,{children:`identity`}),`. Return your response uncompressed: a `,_jsx(_components.code,{children:`gzip`}),` or `,_jsx(_components.code,{children:`deflate`}),` response is decompressed for the caller, and other codings aren’t supported`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`redirects`,children:`Redirects`}),`\n`,_jsx(_components.p,{children:`A redirect from your bot is followed only if it stays on your bot’s own server, such as the redirect FastAPI sends to add a trailing slash. Up to 5 redirects are followed per request.`}),`\n`,_jsxs(_components.p,{children:[`Use a relative path in `,_jsx(_components.code,{children:`Location`}),`. An absolute URL has to match the address Pipecat Cloud used to reach your bot, so one naming `,_jsx(_components.code,{children:`localhost`}),` or using `,_jsx(_components.code,{children:`https://`}),` is treated as leaving the server.`]}),`\n`,_jsxs(_components.p,{children:[`A redirect anywhere else, or a longer chain, returns `,_jsx(_components.code,{children:`502`}),` to the caller. To send a caller elsewhere, return the URL in your response body.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Requires base image version `,_jsx(_components.code,{children:`0.1.2`}),` or later. See the `,_jsx(_components.a,{href:`/pipecat-cloud/guides/session-api`,children:`Session API\nguide`}),` for setup instructions and examples.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Session API","og:title":"Session API - Pipecat Cloud","description":"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.","openapi":"GET /{serviceName}/sessions/{sessionId}/{path}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request Headers","slug":"request-headers","depth":2,"children":[]},{"title":"Redirects","slug":"redirects","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/daily/8dde88c766733454/kapa-widget.js","/_mintlify/custom/daily/1c9d393ac913fca7/gtm.js"],"openApiReferenceData":{"operation":{"summary":"Send GET request to session","operationId":"sessionProxyGet","description":"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.","security":["84c0a554-4021-465a-9920-36acc3ddd306"],"parameters":["49e69749-fd96-4689-bd12-82c0d2c0f873","ae689485-7a3e-4cf9-a389-b9c149122723","94983587-0a8c-48ad-a617-f3a87baddc5f"],"responses":{"200":"f59dd69a-f3db-48b5-b33a-ebb4ef7d03e1","400":"c8f21b54-3256-444f-a389-c04e43d8e21a","401":"f7680d3b-1a09-4c63-8d50-2089f5f2124d","404":"d9dc67fb-be09-4820-a551-9ed9d729a9f8","410":"076f3491-371e-47a3-aa81-3838a95cac96","500":"961ce1f1-3ee3-4954-9277-77e9f9a60029","502":"e4be02d7-b538-4645-9d94-471cfa944622","503":"37a85d21-3c30-4af7-af58-5707f713a28c","504":"5b7853d3-8d4e-43e2-9267-3704bceea9d1"},"method":"get","type":"path","servers":["054abe59-d5f9-43cf-8c2c-cb10144218d0"],"path":"/{serviceName}/sessions/{sessionId}/{path}","baseUrlOptions":["https://api.pipecat.daily.co/v1/public"],"title":"Send GET request to session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"49e69749-fd96-4689-bd12-82c0d2c0f873":{"name":"serviceName","in":"path","required":true,"description":"Name of the deployed agent","schema":{"type":"string","isRequired":true,"description":"Name of the deployed agent","uniqueKey":"","typeLabel":"string"},"example":"my-agent"},"ae689485-7a3e-4cf9-a389-b9c149122723":{"name":"sessionId","in":"path","required":true,"description":"Session ID returned from the start endpoint","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Session ID returned from the start endpoint","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"57af5437-97a2-4646-9873-a5c5935bd705"},"94983587-0a8c-48ad-a617-f3a87baddc5f":{"name":"path","in":"path","required":true,"description":"The endpoint path defined in your bot using the `@app` decorator","schema":{"type":"string","isRequired":true,"description":"The endpoint path defined in your bot using the `@app` decorator","uniqueKey":"","typeLabel":"string"},"example":"status"}},"responses":{"f59dd69a-f3db-48b5-b33a-ebb4ef7d03e1":{"description":"Successful response from the bot","content":{"application/json":{"schema":{"type":"object","description":"Response from your bot endpoint. The schema depends on what your bot returns.","additionalProperties":true,"example":{"status":"active","message_count":5,"user_name":"Alice"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"active","message_count":5,"user_name":"Alice"}}},"exampleType":"generated"}},"exampleType":"generated"},"c8f21b54-3256-444f-a389-c04e43d8e21a":{"description":"Service deployment is not available","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling. For general errors it is the HTTP status as a string, such as `\"404\"`. Deployment-related codes (PCC-*) are documented at https://docs.pipecat.ai/pipecat-cloud/fundamentals/error-codes","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Attempt to start agent when deployment is not in ready state. Is your image pull secret valid?","code":"PCC-1001"},"examples":{"Example":{"title":"Example","value":{"error":"Attempt to start agent when deployment is not in ready state. Is your image pull secret valid?","code":"PCC-1001"}}},"exampleType":"examples"}},"exampleType":"examples"},"f7680d3b-1a09-4c63-8d50-2089f5f2124d":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling. For general errors it is the HTTP status as a string, such as `\"404\"`. Deployment-related codes (PCC-*) are documented at https://docs.pipecat.ai/pipecat-cloud/fundamentals/error-codes","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized / token expired","code":"401"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized / token expired","code":"401"}}},"exampleType":"examples"}},"exampleType":"examples"},"d9dc67fb-be09-4820-a551-9ed9d729a9f8":{"description":"Service or session not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling. For general errors it is the HTTP status as a string, such as `\"404\"`. Deployment-related codes (PCC-*) are documented at https://docs.pipecat.ai/pipecat-cloud/fundamentals/error-codes","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Service not found","code":"404"},"examples":{"Example":{"title":"Example","value":{"error":"Service not found","code":"404"}}},"exampleType":"examples"}},"exampleType":"examples"},"076f3491-371e-47a3-aa81-3838a95cac96":{"description":"The session has already ended","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling. For general errors it is the HTTP status as a string, such as `\"404\"`. Deployment-related codes (PCC-*) are documented at https://docs.pipecat.ai/pipecat-cloud/fundamentals/error-codes","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"endedAt":{"type":"string","format":"date-time","description":"When the session ended","uniqueKey":"endedAt","typeLabel":"string\u003cdate-time>"},"endState":{"type":"string","enum":["completed","ended_before_agent_start","agent_start_timeout","terminated","agent_error","start_refused","unknown"],"description":"How the session ended","uniqueKey":"endState","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Session has ended.","code":"SESSION-ENDED","endedAt":"2026-01-15T10:30:00.000Z","endState":"completed"},"examples":{"Example":{"title":"Example","value":{"error":"Session has ended.","code":"SESSION-ENDED","endedAt":"2026-01-15T10:30:00.000Z","endState":"completed"}}},"exampleType":"examples"}},"exampleType":"examples"},"961ce1f1-3ee3-4954-9277-77e9f9a60029":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling. For general errors it is the HTTP status as a string, such as `\"404\"`. Deployment-related codes (PCC-*) are documented at https://docs.pipecat.ai/pipecat-cloud/fundamentals/error-codes","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Internal server error. Please check logs for more information or contact support.","code":"500"},"examples":{"Example":{"title":"Example","value":{"error":"Internal server error. Please check logs for more information or contact support.","code":"500"}}},"exampleType":"examples"}},"exampleType":"examples"},"e4be02d7-b538-4645-9d94-471cfa944622":{"description":"Pipecat Cloud couldn't get a usable response from your bot: the bot couldn't be reached, its response couldn't be read, or it sent a redirect that isn't followed. Can also be your bot's own `502`, passed through unchanged with its own body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Bot redirected outside its pod"},"examples":{"Example":{"title":"Example","value":{"error":"Bot redirected outside its pod"}}},"exampleType":"examples"}},"exampleType":"examples"},"37a85d21-3c30-4af7-af58-5707f713a28c":{"description":"The region hosting the agent can't be reached right now. Retry after the delay in the `Retry-After` header. Can also be your bot's own `503`, passed through unchanged with its own body and headers","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Added by Pipecat Cloud only when the region can't be reached","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling, when present","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"Region 'us-west' is not reachable right now. Please retry shortly.","code":"503"},"examples":{"Example":{"title":"Example","value":{"error":"Region 'us-west' is not reachable right now. Please retry shortly.","code":"503"}}},"exampleType":"examples"}},"exampleType":"examples"},"5b7853d3-8d4e-43e2-9267-3704bceea9d1":{"description":"Your bot didn't respond before the request timed out. Can also be your bot's own `504`, passed through unchanged with its own body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Error code for programmatic handling, when present","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"The agent did not respond before the request timed out.","code":"504"},"examples":{"Example":{"title":"Example","value":{"error":"The agent did not respond before the request timed out.","code":"504"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"84c0a554-4021-465a-9920-36acc3ddd306":{"PublicKeyAuth":{"type":"http","scheme":"bearer","description":"Authentication using a Pipecat Cloud public API key.\n\nGenerate a public API key from your Dashboard (Settings > API Keys > Public > Create key) and include it as a Bearer token in the Authorization header.","scopes":[],"schemeName":"PublicKeyAuth"}}},"servers":{"054abe59-d5f9-43cf-8c2c-cb10144218d0":{"url":"https://api.pipecat.daily.co/v1/public","description":"Public API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authentication using a Pipecat Cloud public API key.\n\nGenerate a public API key from your Dashboard (Settings > API Keys > Public > Create key) and include it as a Bearer token in the Authorization header.","scopes":[],"schemeName":"PublicKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authentication using a Pipecat Cloud public API key.\n\nGenerate a public API key from your Dashboard (Settings > API Keys > Public > Create key) and include it as a Bearer token in the Authorization header.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PublicKeyAuth","name":"Authorization"}],"title":"PublicKeyAuth"}]},"originalFileLocation":"api-reference/pipecat-cloud/rest-reference/openapi.json"},"subdomain":"daily","siteName":"Pipecat","title":"Session API - Pipecat Cloud","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T01:18:15.971Z","originalFileLocation":"api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy.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=\"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pipecat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/daily/p50_8aq8F9lsbdgG/_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/daily/p50_8aq8F9lsbdgG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/daily/p50_8aq8F9lsbdgG/_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/daily/p50_8aq8F9lsbdgG/_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/daily/p50_8aq8F9lsbdgG/_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/daily/p50_8aq8F9lsbdgG/_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/daily/p50_8aq8F9lsbdgG/_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/daily/p50_8aq8F9lsbdgG/_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/daily/p50_8aq8F9lsbdgG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Session API - Pipecat Cloud\">\u003cmeta data-mint-head property=\"og:description\" content=\"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pipecat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://daily.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Session+API\u0026amp;description=Proxy+HTTP+requests+to+endpoints+defined+in+your+running+Pipecat+Cloud+bot%3A+GET%2C+POST%2C+PUT%2C+PATCH%2C+DELETE%2C+OPTIONS%2C+and+HEAD.\u0026amp;theme=10fd3eefd64c214de510caa7\u0026amp;signature=20e20504b0351103852e2771c8e96e09ceaf7b0455d502c6196d0496f02324c3\">\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=\"Session API - Pipecat Cloud\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://daily.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Session+API\u0026amp;description=Proxy+HTTP+requests+to+endpoints+defined+in+your+running+Pipecat+Cloud+bot%3A+GET%2C+POST%2C+PUT%2C+PATCH%2C+DELETE%2C+OPTIONS%2C+and+HEAD.\u0026amp;theme=10fd3eefd64c214de510caa7\u0026amp;signature=20e20504b0351103852e2771c8e96e09ceaf7b0455d502c6196d0496f02324c3\">\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/daily/p50_8aq8F9lsbdgG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pipecat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4f46e5\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:logo\" content=\"/logo/pipecat-logo.svg\">\u003cmeta data-mint-head name=\"article:publisher\" content=\"Pipecat AI\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pipecat.ai/#organization\",\"name\":\"Pipecat\",\"url\":\"https://docs.pipecat.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/daily/r4jEtY4thtHXjZ16/logo/light.svg?fit=max\u0026auto=format\u0026n=r4jEtY4thtHXjZ16\u0026q=85\u0026s=46cda5b2f0afabd5f0298c64082c4125\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pipecat.ai#website\",\"name\":\"Pipecat\",\"url\":\"https://docs.pipecat.ai\",\"publisher\":{\"@id\":\"https://docs.pipecat.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy#webpage\",\"url\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy\",\"name\":\"Session API\",\"description\":\"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.\",\"dateModified\":\"2026-11-12T01:18:15.971Z\",\"isPartOf\":{\"@id\":\"https://docs.pipecat.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pipecat Cloud\",\"item\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST Reference\",\"item\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Agents\",\"item\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/agent-create\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Session API\",\"item\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy#apireference\",\"headline\":\"Session API\",\"name\":\"Session API\",\"description\":\"Proxy HTTP requests to endpoints defined in your running Pipecat Cloud bot: GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD.\",\"url\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pipecat.ai/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy#webpage\"},\"dateModified\":\"2026-11-12T01:18:15.971Z\",\"publisher\":{\"@id\":\"https://docs.pipecat.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pipecat.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pipecat\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Pipecat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy.md","siteName":"Pipecat","nav":{"global":{"anchors":[{"anchor":"Pipecat Events","icon":"calendar","href":"https://pipecat.ai/events"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/pipecat"},{"anchor":"GitHub","icon":"github","href":"https://github.com/pipecat-ai/pipecat"},{"anchor":"Changelog","icon":"file","href":"https://github.com/pipecat-ai/pipecat/blob/main/CHANGELOG.md"}]},"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/overview/introduction"}]},{"tab":"Pipecat","pages":[{"title":"Pipecat","href":"/pipecat/get-started/introduction"}]},{"tab":"Pipecat Clients","pages":[{"title":"Pipecat Clients","href":"/client/introduction"}]},{"tab":"Pipecat Cloud \u0026 Enterprise","pages":[{"title":"Pipecat Cloud \u0026 Enterprise","href":"/pipecat-cloud/introduction"}]},{"tab":"API Reference","groups":[{"group":"Get Started","pages":[{"title":"API Reference","sidebarTitle":"Overview","href":"/api-reference"}]},{"group":"Standards","pages":[{"title":"Real-time Context Standard","href":"/api-reference/standards/real-time-context-standard"},{"title":"RTVI","href":"/api-reference/standards/rtvi-standard"}]},{"group":"Pipecat Server","pages":[{"title":"Pipecat Server API Overview","sidebarTitle":"Overview","href":"/api-reference/server/introduction"},{"group":"Services","pages":[{"title":"Supported Services","href":"/api-reference/server/services/supported-services"},{"title":"Community Integrations","href":"/api-reference/server/services/community-integrations"},{"group":"Transport","pages":[{"title":"Beyond Presence Transport","sidebarTitle":"Beyond Presence","href":"/api-reference/server/services/transport/beyond-presence"},{"title":"Daily WebRTC Transport","sidebarTitle":"Daily","href":"/api-reference/server/services/transport/daily"},{"title":"FastAPI WebSocket Transport","sidebarTitle":"FastAPI WebSocket","href":"/api-reference/server/services/transport/fastapi-websocket"},{"title":"HeyGen Transport","sidebarTitle":"HeyGen","href":"/api-reference/server/services/transport/heygen"},{"title":"LemonSlice Transport","sidebarTitle":"LemonSlice","href":"/api-reference/server/services/transport/lemonslice"},{"title":"LiveKit Transport","sidebarTitle":"LiveKit","href":"/api-reference/server/services/transport/livekit"},{"title":"MCP Transport","sidebarTitle":"MCP","href":"/api-reference/server/services/transport/mcp"},{"title":"Media over QUIC Transport","sidebarTitle":"MoQ","href":"/api-reference/server/services/transport/moq"},{"title":"Small WebRTC Transport","sidebarTitle":"Small WebRTC","href":"/api-reference/server/services/transport/small-webrtc"},{"title":"Tavus Transport","sidebarTitle":"Tavus","href":"/api-reference/server/services/transport/tavus"},{"title":"Vonage Video Connector Transport","sidebarTitle":"Vonage","href":"/api-reference/server/services/transport/vonage"},{"title":"WebSocket Transports","sidebarTitle":"WebSocket","href":"/api-reference/server/services/transport/websocket-server"},{"title":"WhatsApp Transport","sidebarTitle":"WhatsApp","href":"/api-reference/server/services/transport/whatsapp"},{"title":"TransportParams","href":"/api-reference/server/services/transport/transport-params"}]},{"group":"Serializers","pages":[{"title":"Frame Serializer Overview","sidebarTitle":"Overview","href":"/api-reference/server/services/serializers/introduction"},{"title":"Acefone Frame Serializer","sidebarTitle":"Acefone","href":"/api-reference/server/services/serializers/acefone"},{"title":"Asterisk Frame Serializer","sidebarTitle":"Asterisk","href":"/api-reference/server/services/serializers/asterisk"},{"title":"AwaazAI Frame Serializer","sidebarTitle":"AwaazAI","href":"/api-reference/server/services/serializers/awaazai"},{"title":"Bandwidth Frame Serializer","sidebarTitle":"Bandwidth","href":"/api-reference/server/services/serializers/bandwidth"},{"title":"didlogic Frame Serializer","sidebarTitle":"didlogic","href":"/api-reference/server/services/serializers/didlogic"},{"title":"Exotel Frame Serializer","sidebarTitle":"Exotel","href":"/api-reference/server/services/serializers/exotel"},{"title":"FreeSWITCH Frame Serializer","sidebarTitle":"FreeSWITCH","href":"/api-reference/server/services/serializers/freeswitch"},{"title":"Genesys AudioHook Serializer","sidebarTitle":"Genesys","href":"/api-reference/server/services/serializers/genesys"},{"title":"jambonz Frame Serializer","sidebarTitle":"jambonz","href":"/api-reference/server/services/serializers/jambonz"},{"title":"Plivo Frame Serializer","sidebarTitle":"Plivo","href":"/api-reference/server/services/serializers/plivo"},{"title":"Twilio Frame Serializer","sidebarTitle":"Twilio","href":"/api-reference/server/services/serializers/twilio"},{"title":"Telnyx Frame Serializer","sidebarTitle":"Telnyx","href":"/api-reference/server/services/serializers/telnyx"},{"title":"Vobiz Frame Serializer","sidebarTitle":"Vobiz","href":"/api-reference/server/services/serializers/vobiz"},{"title":"Vonage Frame Serializer","sidebarTitle":"Vonage","href":"/api-reference/server/services/serializers/vonage"},{"title":"Wavix Frame Serializer","sidebarTitle":"Wavix","href":"/api-reference/server/services/serializers/wavix"}]},{"group":"Speech-to-Text","pages":[{"title":"AssemblyAI Speech-to-Text","sidebarTitle":"AssemblyAI","href":"/api-reference/server/services/stt/assemblyai"},{"title":"AWS Transcribe Speech-to-Text","sidebarTitle":"AWS Transcribe","href":"/api-reference/server/services/stt/aws"},{"title":"Azure Speech-to-Text","sidebarTitle":"Azure","href":"/api-reference/server/services/stt/azure"},{"title":"Cartesia Speech-to-Text","sidebarTitle":"Cartesia","href":"/api-reference/server/services/stt/cartesia"},{"title":"Chariot Speech-to-Text","sidebarTitle":"Chariot","href":"/api-reference/server/services/stt/chariot"},{"title":"Deepgram Speech-to-Text","sidebarTitle":"Deepgram","href":"/api-reference/server/services/stt/deepgram"},{"title":".wave Speech-to-Text","sidebarTitle":".wave","href":"/api-reference/server/services/stt/dotwave"},{"title":"ElevenLabs Speech-to-Text","sidebarTitle":"ElevenLabs","href":"/api-reference/server/services/stt/elevenlabs"},{"title":"Fal Wizper Speech-to-Text","sidebarTitle":"Fal (Wizper)","href":"/api-reference/server/services/stt/fal"},{"title":"Floe Speech-to-Text","sidebarTitle":"Floe","href":"/api-reference/server/services/stt/floe"},{"title":"FunASR Speech-to-Text","sidebarTitle":"FunASR","href":"/api-reference/server/services/stt/funasr"},{"title":"Giggy Speech-to-Text","sidebarTitle":"Giggy","href":"/api-reference/server/services/stt/giggy"},{"title":"Gladia Speech-to-Text","sidebarTitle":"Gladia","href":"/api-reference/server/services/stt/gladia"},{"title":"Gnani Speech-to-Text","sidebarTitle":"Gnani","href":"/api-reference/server/services/stt/gnani"},{"title":"Google Speech-to-Text","sidebarTitle":"Google","href":"/api-reference/server/services/stt/google"},{"title":"Gradium Speech-to-Text","sidebarTitle":"Gradium","href":"/api-reference/server/services/stt/gradium"},{"title":"Groq Whisper Speech-to-Text","sidebarTitle":"Groq (Whisper)","href":"/api-reference/server/services/stt/groq"},{"title":"Hakim Speech-to-Text","sidebarTitle":"Hakim","href":"/api-reference/server/services/stt/hakim"},{"title":"Lokutor Speech-to-Text","sidebarTitle":"Lokutor","href":"/api-reference/server/services/stt/lokutor"},{"title":"Meta Speech-to-Text","sidebarTitle":"Meta","href":"/api-reference/server/services/stt/meta"},{"title":"Mistral Speech-to-Text","sidebarTitle":"Mistral","href":"/api-reference/server/services/stt/mistral"},{"title":"Moonshine Speech-to-Text","sidebarTitle":"Moonshine","href":"/api-reference/server/services/stt/moonshine"},{"title":"NVIDIA Nemotron Speech-to-Text","sidebarTitle":"NVIDIA Nemotron Speech","href":"/api-reference/server/services/stt/nvidia"},{"title":"OpenAI Speech-to-Text","sidebarTitle":"OpenAI","href":"/api-reference/server/services/stt/openai"},{"title":"Oruk Speech-to-Text","sidebarTitle":"Oruk","href":"/api-reference/server/services/stt/oruk"},{"title":"Audrey STT (p99lab)","sidebarTitle":"Audrey (p99lab)","href":"/api-reference/server/services/stt/p99lab"},{"title":"Quickdial Speech-to-Text","sidebarTitle":"Quickdial","href":"/api-reference/server/services/stt/quickdial"},{"title":"Rime Speech-to-Text","sidebarTitle":"Rime","href":"/api-reference/server/services/stt/rime"},{"title":"Ringg AI Speech-to-Text","sidebarTitle":"Ringg AI","href":"/api-reference/server/services/stt/ringg"},{"title":"RTZR Speech-to-Text","sidebarTitle":"RTZR","href":"/api-reference/server/services/stt/rtzr"},{"title":"Saidwire Speech-to-Text","sidebarTitle":"Saidwire","href":"/api-reference/server/services/stt/saidwire"},{"title":"Sarvam AI Speech-to-Text","sidebarTitle":"Sarvam","href":"/api-reference/server/services/stt/sarvam"},{"title":"Simplismart Speech-to-Text","sidebarTitle":"Simplismart","href":"/api-reference/server/services/stt/simplismart"},{"title":"SLNG Speech-to-Text","sidebarTitle":"SLNG","href":"/api-reference/server/services/stt/slng"},{"title":"Smallest AI Speech-to-Text","sidebarTitle":"Smallest AI","href":"/api-reference/server/services/stt/smallest"},{"title":"Soniox Speech-to-Text","sidebarTitle":"Soniox","href":"/api-reference/server/services/stt/soniox"},{"title":"Speechmatics Speech-to-Text","sidebarTitle":"Speechmatics","href":"/api-reference/server/services/stt/speechmatics"},{"title":"Sprag Speech-to-Text","sidebarTitle":"Sprag","href":"/api-reference/server/services/stt/sprag"},{"title":"Together AI Speech-to-Text","sidebarTitle":"Together AI","href":"/api-reference/server/services/stt/together"},{"title":"Uplift AI Speech-to-Text","sidebarTitle":"Uplift AI","href":"/api-reference/server/services/stt/upliftai"},{"title":"Whisper Speech-to-Text","sidebarTitle":"Whisper","href":"/api-reference/server/services/stt/whisper"},{"title":"xAI Speech-to-Text","sidebarTitle":"xAI","href":"/api-reference/server/services/stt/xai"},{"title":"Zoom AI Speech-to-Text","sidebarTitle":"Zoom AI","href":"/api-reference/server/services/stt/zoom-ai"}]},{"group":"LLM","pages":[{"title":"Anannas AI LLM","sidebarTitle":"Anannas AI","href":"/api-reference/server/services/llm/anannas"},{"title":"Anthropic LLM","sidebarTitle":"Anthropic","href":"/api-reference/server/services/llm/anthropic"},{"title":"AWS Bedrock LLM","sidebarTitle":"AWS Bedrock","href":"/api-reference/server/services/llm/aws"},{"title":"Azure OpenAI LLM","sidebarTitle":"Azure","href":"/api-reference/server/services/llm/azure"},{"title":"Baseten LLM","sidebarTitle":"Baseten","href":"/api-reference/server/services/llm/baseten"},{"title":"Cerebras LLM","sidebarTitle":"Cerebras","href":"/api-reference/server/services/llm/cerebras"},{"title":"Crusoe LLM","sidebarTitle":"Crusoe","href":"/api-reference/server/services/llm/crusoe"},{"title":"DeepSeek LLM","sidebarTitle":"DeepSeek","href":"/api-reference/server/services/llm/deepseek"},{"title":"Fireworks AI LLM","sidebarTitle":"Fireworks AI","href":"/api-reference/server/services/llm/fireworks"},{"title":"Floe LLM","sidebarTitle":"Floe","href":"/api-reference/server/services/llm/floe"},{"title":"Google Gemini LLM","sidebarTitle":"Google Gemini","href":"/api-reference/server/services/llm/google"},{"title":"Google Gemini Interactions LLM","sidebarTitle":"Google Gemini Interactions","href":"/api-reference/server/services/llm/google-interactions"},{"title":"Google Vertex AI LLM","sidebarTitle":"Google Vertex AI","href":"/api-reference/server/services/llm/google-vertex"},{"title":"Grok LLM","sidebarTitle":"Grok","href":"/api-reference/server/services/llm/grok"},{"title":"Groq LLM","sidebarTitle":"Groq","href":"/api-reference/server/services/llm/groq"},{"title":"Inception LLM","sidebarTitle":"Inception","href":"/api-reference/server/services/llm/inception"},{"title":"Mistral LLM","sidebarTitle":"Mistral","href":"/api-reference/server/services/llm/mistral"},{"title":"Nebius LLM","sidebarTitle":"Nebius","href":"/api-reference/server/services/llm/nebius"},{"title":"Novita AI LLM","sidebarTitle":"Novita AI","href":"/api-reference/server/services/llm/novita"},{"title":"NVIDIA NIM LLM","sidebarTitle":"NVIDIA NIM","href":"/api-reference/server/services/llm/nvidia"},{"title":"NVIDIA Nemotron Omni LLM","sidebarTitle":"NVIDIA Omni","href":"/api-reference/server/services/llm/nvidia-omni"},{"title":"Ollama LLM","sidebarTitle":"Ollama","href":"/api-reference/server/services/llm/ollama"},{"title":"OpenAI LLM","sidebarTitle":"OpenAI","href":"/api-reference/server/services/llm/openai"},{"title":"OpenAI Responses LLM","sidebarTitle":"OpenAI Responses","href":"/api-reference/server/services/llm/openai-responses"},{"title":"OpenRouter LLM","sidebarTitle":"OpenRouter","href":"/api-reference/server/services/llm/openrouter"},{"title":"Perplexity LLM","sidebarTitle":"Perplexity","href":"/api-reference/server/services/llm/perplexity"},{"title":"Qwen LLM","sidebarTitle":"Qwen","href":"/api-reference/server/services/llm/qwen"},{"title":"SambaNova LLM","sidebarTitle":"SambaNova","href":"/api-reference/server/services/llm/sambanova"},{"title":"Sarvam AI LLM","sidebarTitle":"Sarvam","href":"/api-reference/server/services/llm/sarvam"},{"title":"Simplismart LLM","sidebarTitle":"Simplismart","href":"/api-reference/server/services/llm/simplismart"},{"title":"Smallest AI LLM","sidebarTitle":"Smallest AI","href":"/api-reference/server/services/llm/smallest"},{"title":"Sprag LLM","sidebarTitle":"Sprag","href":"/api-reference/server/services/llm/sprag"},{"title":"Together AI LLM","sidebarTitle":"Together AI","href":"/api-reference/server/services/llm/together"}]},{"group":"Text-to-Speech","pages":[{"title":"AssemblyAI Text-to-Speech","sidebarTitle":"AssemblyAI","href":"/api-reference/server/services/tts/assemblyai"},{"title":"AsyncAI Text-to-Speech","sidebarTitle":"Async","href":"/api-reference/server/services/tts/asyncai"},{"title":"AWS Polly Text-to-Speech","sidebarTitle":"AWS Polly","href":"/api-reference/server/services/tts/aws"},{"title":"Azure Text-to-Speech","sidebarTitle":"Azure","href":"/api-reference/server/services/tts/azure"},{"title":"Bland Text-to-Speech","sidebarTitle":"Bland","href":"/api-reference/server/services/tts/bland"},{"title":"Camb AI Text-to-Speech","sidebarTitle":"Camb AI","href":"/api-reference/server/services/tts/camb"},{"title":"Cartesia Text-to-Speech","sidebarTitle":"Cartesia","href":"/api-reference/server/services/tts/cartesia"},{"title":"Chariot Text-to-Speech","sidebarTitle":"Chariot","href":"/api-reference/server/services/tts/chariot"},{"title":"Deepdub Text-to-Speech","sidebarTitle":"Deepdub","href":"/api-reference/server/services/tts/deepdub"},{"title":"Deepgram Text-to-Speech","sidebarTitle":"Deepgram","href":"/api-reference/server/services/tts/deepgram"},{"title":"ElevenLabs Text-to-Speech","sidebarTitle":"ElevenLabs","href":"/api-reference/server/services/tts/elevenlabs"},{"title":"Fish Audio Text-to-Speech","sidebarTitle":"Fish Audio","href":"/api-reference/server/services/tts/fish"},{"title":"Floe Text-to-Speech","sidebarTitle":"Floe","href":"/api-reference/server/services/tts/floe"},{"title":"Gandr Text-to-Speech","sidebarTitle":"Gandr","href":"/api-reference/server/services/tts/gandr"},{"title":"Gnani Text-to-Speech","sidebarTitle":"Gnani","href":"/api-reference/server/services/tts/gnani"},{"title":"Giggy TTS","sidebarTitle":"Giggy","href":"/api-reference/server/services/tts/giggy"},{"title":"Google Text-to-Speech","sidebarTitle":"Google","href":"/api-reference/server/services/tts/google"},{"title":"Gradium Text-to-Speech","sidebarTitle":"Gradium","href":"/api-reference/server/services/tts/gradium"},{"title":"Groq Text-to-Speech","sidebarTitle":"Groq","href":"/api-reference/server/services/tts/groq"},{"title":"Hakim Text-to-Speech","sidebarTitle":"Hakim","href":"/api-reference/server/services/tts/hakim"},{"title":"HeyGen Text-to-Speech","sidebarTitle":"HeyGen","href":"/api-reference/server/services/tts/heygen"},{"title":"Hume Text-to-Speech","sidebarTitle":"Hume","href":"/api-reference/server/services/tts/hume"},{"title":"Inworld Text-to-Speech","sidebarTitle":"Inworld","href":"/api-reference/server/services/tts/inworld"},{"title":"Kalpa Text-to-Speech","sidebarTitle":"Kalpa","href":"/api-reference/server/services/tts/kalpa"},{"title":"Kokoro Text-to-Speech","sidebarTitle":"Kokoro","href":"/api-reference/server/services/tts/kokoro"},{"title":"Lokutor Text-to-Speech","sidebarTitle":"Lokutor","href":"/api-reference/server/services/tts/lokutor"},{"title":"Maya Text-to-Speech","sidebarTitle":"Maya","href":"/api-reference/server/services/tts/maya"},{"title":"MiniMax Text-to-Speech","sidebarTitle":"MiniMax","href":"/api-reference/server/services/tts/minimax"},{"title":"Mirai Text-to-Speech","sidebarTitle":"Mirai","href":"/api-reference/server/services/tts/mirai"},{"title":"Mistral Text-to-Speech","sidebarTitle":"Mistral","href":"/api-reference/server/services/tts/mistral"},{"title":"Murf AI Text-to-Speech","sidebarTitle":"Murf AI","href":"/api-reference/server/services/tts/murf"},{"title":"Neuphonic Text-to-Speech","sidebarTitle":"Neuphonic","href":"/api-reference/server/services/tts/neuphonic"},{"title":"NVIDIA Nemotron Text-to-Speech","sidebarTitle":"NVIDIA Nemotron Speech","href":"/api-reference/server/services/tts/nvidia"},{"title":"OpenAI Text-to-Speech","sidebarTitle":"OpenAI","href":"/api-reference/server/services/tts/openai"},{"title":"Piper Text-to-Speech","sidebarTitle":"Piper","href":"/api-reference/server/services/tts/piper"},{"title":"Pocket TTS","href":"/api-reference/server/services/tts/pocket-tts"},{"title":"ReadAloud TTS","sidebarTitle":"ReadAloud","href":"/api-reference/server/services/tts/readaloud"},{"title":"Resemble AI Text-to-Speech","sidebarTitle":"Resemble AI","href":"/api-reference/server/services/tts/resembleai"},{"title":"Respeecher Text-to-Speech","sidebarTitle":"Respeecher","href":"/api-reference/server/services/tts/respeecher"},{"title":"Quickdial Text-to-Speech","sidebarTitle":"Quickdial","href":"/api-reference/server/services/tts/quickdial"},{"title":"Rime Text-to-Speech","sidebarTitle":"Rime","href":"/api-reference/server/services/tts/rime"},{"title":"Rumik AI Text-to-Speech","sidebarTitle":"Rumik AI","href":"/api-reference/server/services/tts/rumik"},{"title":"Sarvam AI Text-to-Speech","sidebarTitle":"Sarvam AI","href":"/api-reference/server/services/tts/sarvam"},{"title":"SILMA Text-to-Speech","sidebarTitle":"SILMA AI","href":"/api-reference/server/services/tts/silma"},{"title":"Simplismart Text-to-Speech","sidebarTitle":"Simplismart","href":"/api-reference/server/services/tts/simplismart"},{"title":"SLNG Text-to-Speech","sidebarTitle":"SLNG","href":"/api-reference/server/services/tts/slng"},{"title":"Smallest AI Text-to-Speech","sidebarTitle":"Smallest AI","href":"/api-reference/server/services/tts/smallest"},{"title":"SonexLabs Text-to-Speech","sidebarTitle":"SonexLabs","href":"/api-reference/server/services/tts/sonex"},{"title":"Soniox Text-to-Speech","sidebarTitle":"Soniox","href":"/api-reference/server/services/tts/soniox"},{"title":"Speechify Text-to-Speech","sidebarTitle":"Speechify","href":"/api-reference/server/services/tts/speechify"},{"title":"Speechmatics Text-to-Speech","sidebarTitle":"Speechmatics","href":"/api-reference/server/services/tts/speechmatics"},{"title":"Sprag Text-to-Speech","sidebarTitle":"Sprag","href":"/api-reference/server/services/tts/sprag"},{"title":"Supertonic Text-to-Speech","sidebarTitle":"Supertonic","href":"/api-reference/server/services/tts/supertonic"},{"title":"Together AI Text-to-Speech","sidebarTitle":"Together AI","href":"/api-reference/server/services/tts/together"},{"title":"Pipecat TTS Cache","href":"/api-reference/server/services/tts/tts-cache"},{"title":"Typecast Text-to-Speech","sidebarTitle":"Typecast","href":"/api-reference/server/services/tts/typecast"},{"title":"Uplift AI Text-to-Speech","sidebarTitle":"Uplift AI","href":"/api-reference/server/services/tts/upliftai"},{"title":"Vakyam AI Text-to-Speech","sidebarTitle":"Vakyam AI","href":"/api-reference/server/services/tts/vakyam"},{"title":"Vartaloop Text-to-Speech","sidebarTitle":"Vartaloop","href":"/api-reference/server/services/tts/vartaloop"},{"title":"Voice.ai Text-to-Speech","sidebarTitle":"Voice.ai","href":"/api-reference/server/services/tts/voiceai"},{"title":"xAI Text-to-Speech","sidebarTitle":"xAI","href":"/api-reference/server/services/tts/xai"},{"title":"Coqui XTTS Text-to-Speech","sidebarTitle":"XTTS","href":"/api-reference/server/services/tts/xtts"},{"title":"XTTS-vLLM Text-to-Speech","sidebarTitle":"XTTS-vLLM","href":"/api-reference/server/services/tts/xtts-vllm"}]},{"group":"Realtime LLM","pages":[{"title":"AWS Nova Sonic","href":"/api-reference/server/services/s2s/aws"},{"title":"Azure Voice Live","href":"/api-reference/server/services/s2s/azure-voice-live"},{"title":"Boson Higgs Realtime","sidebarTitle":"Boson Higgs Realtime","href":"/api-reference/server/services/s2s/boson"},{"title":"Gemini Live","href":"/api-reference/server/services/s2s/gemini-live"},{"title":"Gemini Live Vertex AI","href":"/api-reference/server/services/s2s/gemini-live-vertex"},{"title":"Grok Realtime","href":"/api-reference/server/services/s2s/grok"},{"title":"Inworld Realtime","href":"/api-reference/server/services/s2s/inworld"},{"title":"OpenAI GPT-Live","href":"/api-reference/server/services/s2s/openai-live"},{"title":"OpenAI Realtime","href":"/api-reference/server/services/s2s/openai"},{"title":"Sophon-Realtime","sidebarTitle":"Sophon-Realtime","href":"/api-reference/server/services/s2s/sophon-realtime"},{"title":"ThunderPhone","sidebarTitle":"ThunderPhone","href":"/api-reference/server/services/s2s/thunderphone"},{"title":"Ultravox Realtime","href":"/api-reference/server/services/s2s/ultravox"},{"title":"Zoom AI Voice Agent","sidebarTitle":"Zoom AI","href":"/api-reference/server/services/s2s/zoom-ai"}]},{"group":"Image Generation","pages":[{"title":"Azure OpenAI Image Generation","sidebarTitle":"Azure","href":"/api-reference/server/services/image-generation/azure"},{"title":"fal Image Generation","sidebarTitle":"fal","href":"/api-reference/server/services/image-generation/fal"},{"title":"Google Image Generation","sidebarTitle":"Google","href":"/api-reference/server/services/image-generation/google"},{"title":"OpenAI Image Generation","sidebarTitle":"OpenAI","href":"/api-reference/server/services/image-generation/openai"},{"title":"Replicate Image Generation","sidebarTitle":"Replicate","href":"/api-reference/server/services/image-generation/replicate"}]},{"group":"Video","pages":[{"title":"Anam Video Avatar","sidebarTitle":"Anam","href":"/api-reference/server/services/video/anam"},{"title":"bitHuman Video Avatar","sidebarTitle":"bitHuman","href":"/api-reference/server/services/video/bithuman"},{"title":"HeyGen Video Avatar","sidebarTitle":"HeyGen","href":"/api-reference/server/services/video/heygen"},{"title":"Protoface Video Avatar","sidebarTitle":"Protoface","href":"/api-reference/server/services/video/protoface"},{"title":"Simli Video Avatar","sidebarTitle":"Simli","href":"/api-reference/server/services/video/simli"},{"title":"SpatialReal Avatar","sidebarTitle":"SpatialReal","href":"/api-reference/server/services/video/spatialreal"},{"title":"Tavus Video Avatar","sidebarTitle":"Tavus","href":"/api-reference/server/services/video/tavus"}]},{"group":"Memory","pages":[{"title":"Mem0 Long-Term Memory","sidebarTitle":"Mem0","href":"/api-reference/server/services/memory/mem0"},{"title":"Memcode Memory","sidebarTitle":"Memcode","href":"/api-reference/server/services/memory/memcode"},{"title":"MemorySync Memory","sidebarTitle":"MemorySync","href":"/api-reference/server/services/memory/memorysync"},{"title":"Synap Memory","sidebarTitle":"Synap","href":"/api-reference/server/services/memory/synap"}]},{"group":"Vision","pages":[{"title":"Moondream Vision","sidebarTitle":"Moondream","href":"/api-reference/server/services/vision/moondream"},{"title":"SmolVLM Vision","sidebarTitle":"SmolVLM","href":"/api-reference/server/services/vision/smolvlm"}]},{"group":"Agents","pages":[{"title":"OpenClaw Gateway","href":"/api-reference/server/services/agents/openclaw"}]},{"group":"Analytics \u0026 Monitoring","pages":[{"title":"Finchvox Session Replay","sidebarTitle":"Finchvox","href":"/api-reference/server/services/analytics/finchvox"},{"title":"floe-guard","sidebarTitle":"Floe","href":"/api-reference/server/services/analytics/floe"},{"title":"Future AGI Observability","sidebarTitle":"Future AGI","href":"/api-reference/server/services/analytics/future-agi"},{"title":"MLflow","href":"/api-reference/server/services/analytics/mlflow"},{"title":"Noveum Trace","href":"/api-reference/server/services/analytics/noveum-trace"},{"title":"OpenInference Tracing","sidebarTitle":"OpenInference","href":"/api-reference/server/services/analytics/openinference"},{"title":"Roark Call Analytics","sidebarTitle":"Roark","href":"/api-reference/server/services/analytics/roark"},{"title":"Sentry Metrics","href":"/api-reference/server/services/analytics/sentry"}]},{"group":"Knowledge Retrieval","pages":[{"title":"Keenable Web Search","sidebarTitle":"Keenable","href":"/api-reference/server/services/knowledge-retrieval/keenable"},{"title":"Moss Knowledge Retrieval","sidebarTitle":"Moss","href":"/api-reference/server/services/knowledge-retrieval/moss"}]},{"group":"Translation","pages":[{"title":"Pinch Translation","sidebarTitle":"Pinch","href":"/api-reference/server/services/translation/pinch"}]},{"group":"Audio Filters","pages":[{"title":"AIC Audio Filter","sidebarTitle":"AIC","href":"/api-reference/server/services/audio-filters/aic-filter"},{"title":"Alkove Audio Filter","sidebarTitle":"Alkove","href":"/api-reference/server/services/audio-filters/alkove"},{"title":"Arctan Audio Filter","sidebarTitle":"Arctan","href":"/api-reference/server/services/audio-filters/arctan"},{"title":"Hecttor","href":"/api-reference/server/services/audio-filters/hecttor"},{"title":"Koala Audio Filter","sidebarTitle":"Koala","href":"/api-reference/server/services/audio-filters/koala-filter"},{"title":"Krisp VIVA Audio Filter","sidebarTitle":"Krisp VIVA","href":"/api-reference/server/services/audio-filters/krisp-viva-filter"},{"title":"pipecat-effects","href":"/api-reference/server/services/audio-filters/pipecat-effects"},{"title":"RNNoise Audio Filter","sidebarTitle":"RNNoise","href":"/api-reference/server/services/audio-filters/rnnoise-filter"},{"title":"VoxLock Audio Filter","sidebarTitle":"VoxLock","href":"/api-reference/server/services/audio-filters/voxlock"}]},{"group":"VAD","pages":[{"title":"AIC Quail VAD","sidebarTitle":"AIC Quail","href":"/api-reference/server/services/vad/aic-quail-vad-analyzer"},{"title":"Alkove VAD","sidebarTitle":"Alkove","href":"/api-reference/server/services/vad/alkove-vad"},{"title":"FireRed VAD","sidebarTitle":"FireRed","href":"/api-reference/server/services/vad/fire-vad"},{"title":"Krisp VIVA VAD","sidebarTitle":"Krisp VIVA","href":"/api-reference/server/services/vad/krisp-viva-vad-analyzer"},{"title":"Silero VAD","sidebarTitle":"Silero","href":"/api-reference/server/services/vad/silero-vad-analyzer"},{"title":"TEN VAD","sidebarTitle":"TEN","href":"/api-reference/server/services/vad/ten-vad"}]}]},{"group":"Composite Services","pages":[{"title":"ServiceSwitcher","href":"/api-reference/server/composite-services/service-switcher"},{"title":"LLMSwitcher","href":"/api-reference/server/composite-services/llm-switcher"},{"title":"LLMWithBackend","href":"/api-reference/server/composite-services/llm-with-backend"}]},{"group":"Classifiers","pages":[{"title":"BaseClassifier","sidebarTitle":"Overview","href":"/api-reference/server/classifiers/overview"},{"title":"ClefClassifier","sidebarTitle":"Clef","href":"/api-reference/server/classifiers/clef"},{"title":"GoogleDecisionsClassifier","sidebarTitle":"Google Decisions","href":"/api-reference/server/classifiers/google"},{"title":"HumeAudioClassifier","sidebarTitle":"Hume Audio","href":"/api-reference/server/classifiers/hume-audio"},{"title":"JevClassifier","sidebarTitle":"Jev","href":"/api-reference/server/classifiers/jev"},{"title":"OpenAIDecisionsClassifier","sidebarTitle":"OpenAI Decisions","href":"/api-reference/server/classifiers/openai-decisions"},{"title":"LLMClassifier","sidebarTitle":"LLM","href":"/api-reference/server/classifiers/llm"}]},{"group":"Expressive Conversation","pages":[{"title":"Expressive Conversation","sidebarTitle":"Overview","href":"/api-reference/server/expressive/overview"},{"title":"Expressive TTS Services","sidebarTitle":"TTS Services","href":"/api-reference/server/expressive/tts-services"},{"title":"Pipecat Tone","href":"/api-reference/server/expressive/pipecat-tone"},{"title":"Pipecat Voice Reader","sidebarTitle":"Pipecat Voice","href":"/api-reference/server/expressive/pipecat-voice"}]},{"group":"Extensions","pages":[{"title":"IVRNavigator","href":"/api-reference/server/extensions/ivr"},{"title":"Pipecat Backchannel","href":"/api-reference/server/extensions/pipecat-backchannel"},{"title":"DuplexJev Turn Analyzer","href":"/api-reference/server/extensions/pipecat-duplexjev"},{"title":"VoicemailDetector","href":"/api-reference/server/extensions/voicemail"}]},{"group":"Utilities","pages":[{"group":"Advanced Frame Processors","pages":[{"title":"LLMTextProcessor","href":"/api-reference/server/utilities/frame/llm-text-processor"},{"title":"Producer \u0026 Consumer Processors","href":"/api-reference/server/utilities/frame/producer-consumer"}]},{"group":"Audio Processing","pages":[{"title":"AudioBufferProcessor","href":"/api-reference/server/utilities/audio/audio-buffer-processor"},{"title":"SoundfileMixer","href":"/api-reference/server/utilities/audio/soundfile-mixer"}]},{"group":"Context","pages":[{"title":"LLMContextSummarizer","sidebarTitle":"Context Summarization","href":"/api-reference/server/utilities/context-summarization"}]},{"group":"File Handling","pages":[{"title":"File Resolution and Storage","sidebarTitle":"File Handling","href":"/api-reference/server/utilities/file-handling"}]},{"group":"Frame Filters","pages":[{"title":"FrameFilter","href":"/api-reference/server/utilities/filters/frame-filter"},{"title":"FunctionFilter","href":"/api-reference/server/utilities/filters/function-filter"},{"title":"IdentityFilter","href":"/api-reference/server/utilities/filters/identify-filter"},{"title":"NullFilter","href":"/api-reference/server/utilities/filters/null-filter"},{"title":"WakeCheckFilter","href":"/api-reference/server/utilities/filters/wake-check-filter"},{"title":"WakeNotifierFilter","href":"/api-reference/server/utilities/filters/wake-notifier-filter"}]},{"group":"Metrics and Telemetry","pages":[{"title":"OpenTelemetry Tracing","sidebarTitle":"OpenTelemetry","href":"/api-reference/server/utilities/opentelemetry"}]},{"group":"MCP","pages":[{"title":"MCPClient","href":"/api-reference/server/utilities/mcp/mcp"}]},{"group":"Observers","pages":[{"title":"Observer Pattern","href":"/api-reference/server/utilities/observers/observer-pattern"},{"title":"AIC Tyto Observer","sidebarTitle":"AIC Tyto","href":"/api-reference/server/utilities/observers/aic-tyto-observer"},{"title":"Bot Speech Observer","href":"/api-reference/server/utilities/observers/bot-speech-observer"},{"title":"Debug Log Observer","sidebarTitle":"Debug Observer","href":"/api-reference/server/utilities/observers/debug-observer"},{"title":"Error Observer","href":"/api-reference/server/utilities/observers/error-observer"},{"title":"Eval Conversation Observer","href":"/api-reference/server/utilities/observers/eval-conversation-observer"},{"title":"Function Call Observer","href":"/api-reference/server/utilities/observers/function-call-observer"},{"title":"LLM Log Observer","sidebarTitle":"LLM Observer","href":"/api-reference/server/utilities/observers/llm-observer"},{"title":"Service Metrics Observer","href":"/api-reference/server/utilities/observers/service-metrics-observer"},{"title":"Speaking Observer","href":"/api-reference/server/utilities/observers/speaking-observer"},{"title":"Transcription Log Observer","sidebarTitle":"Transcription Observer","href":"/api-reference/server/utilities/observers/transcription-observer"},{"title":"Startup Timing Observer","sidebarTitle":"Startup Timing","href":"/api-reference/server/utilities/observers/startup-timing-observer"},{"title":"Turn Tracking Observer","href":"/api-reference/server/utilities/observers/turn-tracking-observer"},{"title":"User-Bot Latency Observer","sidebarTitle":"Latency Observer","href":"/api-reference/server/utilities/observers/user-bot-latency-observer"}]},{"group":"Runner","pages":[{"title":"Development Runner","href":"/api-reference/server/utilities/runner/guide"},{"title":"Transport Utilities","href":"/api-reference/server/utilities/runner/transport-utils"}]},{"group":"Service Utilities","pages":[{"title":"DailyRESTHelper","href":"/api-reference/server/utilities/daily/rest-helper"}]},{"group":"Smart Turn Detection","pages":[{"title":"Smart Turn Overview","href":"/api-reference/server/utilities/turn-detection/smart-turn-overview"},{"title":"Krisp VIVA Turn","href":"/api-reference/server/utilities/turn-detection/krisp-viva-turn"},{"title":"turn-1-mini","href":"/api-reference/server/utilities/turn-detection/turn-1-mini"},{"title":"Alkove Turn","href":"/api-reference/server/utilities/turn-detection/alkove-turn"}]},{"group":"Telephony","pages":[{"title":"DTMFAggregator","href":"/api-reference/server/utilities/dtmf-aggregator"}]},{"group":"Text Aggregators and Filters","pages":[{"title":"Text Aggregators and Filters","sidebarTitle":"Overview","href":"/api-reference/server/utilities/text/overview"},{"title":"MarkdownTextFilter","href":"/api-reference/server/utilities/text/markdown-text-filter"},{"title":"PatternPairAggregator","href":"/api-reference/server/utilities/text/pattern-pair-aggregator"},{"title":"Voice Formatter","href":"/api-reference/server/utilities/text/voice-formatter"}]},{"group":"User and Assistant Turn Management","pages":[{"title":"User Turn Strategies","href":"/api-reference/server/utilities/turn-management/user-turn-strategies"},{"title":"User Mute Strategies","href":"/api-reference/server/utilities/turn-management/user-mute-strategies"},{"title":"Filter Incomplete User Turns","href":"/api-reference/server/utilities/turn-management/filter-incomplete-turns"},{"title":"Turn Events","href":"/api-reference/server/utilities/turn-management/turn-events"},{"title":"Transcriptions","href":"/api-reference/server/utilities/turn-management/transcriptions"},{"title":"External Turn Management","href":"/api-reference/server/utilities/turn-management/external-turn-management"}]}]},{"group":"Events","pages":[{"title":"Events Overview","href":"/api-reference/server/events/overview"},{"title":"FrameProcessor Events","href":"/api-reference/server/events/frame-processor-events"},{"title":"Service Events","href":"/api-reference/server/events/service-events"}]},{"group":"RTVI","pages":[{"title":"RTVI (Real-Time Voice Interaction)","sidebarTitle":"Overview","href":"/api-reference/server/rtvi/introduction"},{"title":"RTVIProcessor","href":"/api-reference/server/rtvi/rtvi-processor"},{"title":"RTVIObserver","href":"/api-reference/server/rtvi/rtvi-observer"},{"title":"Google RTVI Observer","href":"/api-reference/server/rtvi/google-rtvi-observer"}]},{"group":"Frames","pages":[{"title":"Frames","href":"/api-reference/server/frames/overview"},{"title":"Data Frames","href":"/api-reference/server/frames/data-frames"},{"title":"Control Frames","href":"/api-reference/server/frames/control-frames"},{"title":"System Frames","href":"/api-reference/server/frames/system-frames"},{"title":"LLM Frames","href":"/api-reference/server/frames/llm-frames"}]},{"group":"Workers","pages":[{"title":"BaseWorker","href":"/api-reference/server/workers/base-worker"},{"title":"BaseUIWorker","href":"/api-reference/server/workers/base-ui-worker"},{"title":"LLMWorker","href":"/api-reference/server/workers/llm-worker"},{"title":"LLMContextWorker","href":"/api-reference/server/workers/llm-context-worker"},{"title":"BackendLLMWorker","href":"/api-reference/server/workers/backend-llm-worker"},{"title":"UIWorker","href":"/api-reference/server/workers/ui-worker"},{"title":"WorkerRunner","href":"/api-reference/server/workers/runner"},{"title":"Types","href":"/api-reference/server/workers/types"},{"title":"Exceptions","href":"/api-reference/server/workers/exceptions"}]},{"group":"Pipeline","pages":[{"title":"PipelineParams","href":"/api-reference/server/pipeline/pipeline-params"},{"title":"PipelineWorker","href":"/api-reference/server/pipeline/pipeline-worker"},{"title":"Pipeline Idle Detection","href":"/api-reference/server/pipeline/pipeline-idle-detection"},{"title":"Pipeline Heartbeats","href":"/api-reference/server/pipeline/heartbeats"},{"title":"ParallelPipeline","href":"/api-reference/server/pipeline/parallel-pipeline"}]},{"group":"Bus","pages":[{"title":"Worker Bus","sidebarTitle":"Bus","href":"/api-reference/server/bus/bus"},{"title":"Bus Messages","sidebarTitle":"Messages","href":"/api-reference/server/bus/messages"},{"title":"Bus Serializers","sidebarTitle":"Serializers","href":"/api-reference/server/bus/serializers"},{"title":"Bus Proxy Agents","sidebarTitle":"Proxy Agents","href":"/api-reference/server/bus/proxy"}]}]},{"group":"Client SDKs","pages":[{"group":"JavaScript SDK","pages":[{"title":"JavaScript SDK Overview","sidebarTitle":"Overview","href":"/api-reference/client/js/overview"},{"title":"PipecatClient Constructor","href":"/api-reference/client/js/client-constructor"},{"title":"Client Methods","href":"/api-reference/client/js/client-methods"},{"title":"Callbacks and Events","href":"/api-reference/client/js/callbacks"},{"title":"Errors","href":"/api-reference/client/js/errors"},{"group":"Transports","pages":[{"title":"Transport Overview","sidebarTitle":"Overview","href":"/api-reference/client/js/transports/transport"},{"title":"Daily WebRTC Transport","sidebarTitle":"Daily","href":"/api-reference/client/js/transports/daily"},{"title":"LiveKit Transport","sidebarTitle":"LiveKit","href":"/api-reference/client/js/transports/livekit"},{"title":"MoQ Transport","sidebarTitle":"MoQ","href":"/api-reference/client/js/transports/moq"},{"title":"Small WebRTC Transport","sidebarTitle":"Small WebRTC","href":"/api-reference/client/js/transports/small-webrtc"},{"title":"WebSocket Transport","sidebarTitle":"WebSocket","href":"/api-reference/client/js/transports/websocket"}]}]},{"group":"React SDK","pages":[{"title":"React SDK Overview","sidebarTitle":"Overview","href":"/api-reference/client/react/overview"},{"title":"Components","href":"/api-reference/client/react/components"},{"title":"Hooks","href":"/api-reference/client/react/hooks"}]},{"group":"React Native SDK","pages":[{"title":"React Native SDK Overview","sidebarTitle":"Overview","href":"/api-reference/client/react-native/overview"},{"title":"React Native SDK Reference","sidebarTitle":"API Reference","href":"/api-reference/client/react-native/api-reference"},{"group":"Transports","pages":[{"title":"Daily WebRTC Transport","sidebarTitle":"Daily","href":"/api-reference/client/react-native/transports/daily"},{"title":"Small WebRTC Transport","sidebarTitle":"Small WebRTC","href":"/api-reference/client/react-native/transports/small-webrtc"}]}]},{"group":"iOS SDK","pages":[{"title":"iOS SDK Overview","sidebarTitle":"Overview","href":"/api-reference/client/ios/overview"},{"title":"iOS SDK Reference","sidebarTitle":"API Reference","url":"https://docs-ios.pipecat.ai/","href":"/api-reference/client/ios/api-reference"},{"group":"Transports","pages":[{"title":"Daily WebRTC Transport","sidebarTitle":"Daily","href":"/api-reference/client/ios/transports/daily"},{"title":"Gemini Live WebSocket Transport","sidebarTitle":"Gemini Live","href":"/api-reference/client/ios/transports/gemini-websocket"},{"title":"OpenAI Realtime WebRTC Transport","sidebarTitle":"OpenAI Realtime","href":"/api-reference/client/ios/transports/openai-webrtc"},{"title":"Small WebRTC Transport","sidebarTitle":"Small WebRTC","href":"/api-reference/client/ios/transports/small-webrtc"}]}]},{"group":"Android SDK","pages":[{"title":"Android SDK Overview","sidebarTitle":"Overview","href":"/api-reference/client/android/overview"},{"title":"Android SDK Reference","sidebarTitle":"API Reference","url":"https://docs-android.pipecat.ai/","href":"/api-reference/client/android/api-reference"},{"group":"Transports","pages":[{"title":"Daily WebRTC Transport","sidebarTitle":"Daily","href":"/api-reference/client/android/transports/daily"},{"title":"Gemini Live WebSocket Transport","sidebarTitle":"Gemini Live","href":"/api-reference/client/android/transports/gemini-websocket"},{"title":"OpenAI Realtime WebRTC Transport","sidebarTitle":"OpenAI Realtime","href":"/api-reference/client/android/transports/openai-webrtc"},{"title":"Small WebRTC Transport","sidebarTitle":"Small WebRTC","href":"/api-reference/client/android/transports/small-webrtc"}]}]},{"group":"C++ SDK","pages":[{"title":"C++ SDK Overview","sidebarTitle":"Overview","href":"/api-reference/client/cpp/overview"},{"title":"C++ SDK Reference","sidebarTitle":"API Reference","url":"https://docs-cxx.pipecat.ai/","href":"/api-reference/client/cpp/api-reference"},{"group":"Transports","pages":[{"title":"Daily WebRTC Transport","sidebarTitle":"Daily","href":"/api-reference/client/cpp/transports/daily"},{"title":"WebSocket Transport","sidebarTitle":"WebSocket","href":"/api-reference/client/cpp/transports/websocket"}]}]}]},{"group":"Pipecat Flows","pages":[{"title":"Pipecat Flows API Overview","sidebarTitle":"Overview","href":"/api-reference/pipecat-flows/overview"},{"title":"FlowConfig","href":"/api-reference/pipecat-flows/flow-config"},{"title":"Flow","href":"/api-reference/pipecat-flows/flow"},{"title":"FlowManager","href":"/api-reference/pipecat-flows/flow-manager"},{"title":"Types","href":"/api-reference/pipecat-flows/types"},{"title":"Exceptions","href":"/api-reference/pipecat-flows/exceptions"}]},{"group":"Pipecat Cloud","pages":[{"group":"REST Reference","pages":[{"title":"Pipecat Cloud REST API","sidebarTitle":"REST API Overview","href":"/api-reference/pipecat-cloud/rest-reference/overview"},{"group":"Agents","pages":[{"title":"Create an Agent","openapi":"POST /agents","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-create"},{"title":"Update an Agent","openapi":"POST /agents/{agentName}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-update"},{"title":"Start an Agent Session","openapi":"POST /{agentName}/start","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/start"},{"title":"Stop an Agent Session","description":"DELETE /agents/{agentName}/sessions/{sessionId} stops a running Pipecat Cloud agent session and cleans up its resources.","openapi":"DELETE /agents/{agentName}/sessions/{sessionId}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/stop"},{"title":"Session API","openapi":"GET /{serviceName}/sessions/{sessionId}/{path}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/session-proxy"},{"title":"Retrieve Agent Logs","description":"GET /agents/{agentName}/logs returns execution logs for a Pipecat Cloud agent, with filtering and pagination options.","openapi":"GET /agents/{agentName}/logs","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-get-logs"},{"title":"List All Sessions","openapi":"GET /agents/{agentName}/sessions","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-get-sessions"},{"title":"Get Session Details","openapi":"GET /agents/{agentName}/sessions/{sessionId}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-get-session"},{"title":"List All Agents","openapi":"GET /agents","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-list-all"},{"title":"Get Agent Details","openapi":"GET /agents/{agentName}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-list-one"},{"title":"Delete an Agent","openapi":"DELETE /agents/{agentName}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/agent-delete"}]},{"group":"Secrets","pages":[{"title":"Create or Update Secrets","openapi":"PUT /secrets/{setName}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/secret-create-update"},{"title":"List All Secret Sets","openapi":"GET /secrets","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/secret-list-all"},{"title":"Get Secret Set Details","openapi":"GET /secrets/{setName}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/secret-list-one"},{"title":"Delete Entire Secret Set","openapi":"DELETE /secrets/{setName}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/secret-delete-secret-set"},{"title":"Delete Specific Secret From Set","openapi":"DELETE /secrets/{setName}/{secretKey}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/secret-delete-specific-secret"}]},{"group":"Builds","pages":[{"title":"Get Upload URL","openapi":"POST /builds/upload-url","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/build-upload-url"},{"title":"Create Build","openapi":"POST /builds","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/build-create"},{"title":"List Builds","openapi":"GET /builds","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/build-list"},{"title":"Get Build","openapi":"GET /builds/{buildId}","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/build-get"},{"title":"Get Build Logs","openapi":"GET /builds/{buildId}/logs","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/build-get-logs"}]},{"group":"Regions","pages":[{"title":"List Regions","openapi":"GET /regions","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/regions-list"}]},{"group":"Organization","pages":[{"title":"Get Organization Properties","openapi":"GET /properties","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/properties-get"},{"title":"Update Organization Properties","openapi":"PATCH /properties","href":"/api-reference/pipecat-cloud/rest-reference/endpoint/properties-update"}]}]},{"group":"SDK Reference","pages":[{"title":"Pipecat Cloud SDK Overview","sidebarTitle":"Python SDK Overview","href":"/api-reference/pipecat-cloud/sdk-reference/overview"},{"title":"Session Management","href":"/api-reference/pipecat-cloud/sdk-reference/sessions"},{"title":"Session Arguments","href":"/api-reference/pipecat-cloud/sdk-reference/session-arguments"},{"title":"Error Handling","href":"/api-reference/pipecat-cloud/sdk-reference/exceptions"},{"title":"Examples","href":"/api-reference/pipecat-cloud/sdk-reference/examples"}]}]},{"group":"CLI","pages":[{"title":"CLI Overview","href":"/api-reference/cli/overview"},{"group":"Commands","pages":[{"title":"pipecat init","sidebarTitle":"init","href":"/api-reference/cli/init"},{"title":"pipecat eval","sidebarTitle":"eval","href":"/api-reference/cli/eval"},{"title":"pipecat context-hub","sidebarTitle":"context-hub","href":"/api-reference/cli/context-hub"},{"group":"cloud","pages":[{"title":"Output Modes and Exit Codes","sidebarTitle":"Output \u0026 exit codes","href":"/api-reference/cli/cloud/output"},{"title":"pipecat cloud agent","sidebarTitle":"agent","href":"/api-reference/cli/cloud/agent"},{"title":"pipecat cloud auth","sidebarTitle":"auth","href":"/api-reference/cli/cloud/auth"},{"title":"pipecat cloud build","sidebarTitle":"build","href":"/api-reference/cli/cloud/build"},{"title":"pipecat cloud docker","sidebarTitle":"docker","href":"/api-reference/cli/cloud/docker"},{"title":"pipecat cloud github","sidebarTitle":"github","href":"/api-reference/cli/cloud/github"},{"title":"pipecat cloud deploy","sidebarTitle":"deploy","href":"/api-reference/cli/cloud/deploy"},{"title":"pipecat cloud organizations","sidebarTitle":"organizations","href":"/api-reference/cli/cloud/organizations"},{"title":"pipecat cloud secrets","sidebarTitle":"secrets","href":"/api-reference/cli/cloud/secrets"},{"title":"pipecat cloud spend-limit","sidebarTitle":"spend-limit","href":"/api-reference/cli/cloud/spend-limit"},{"title":"pipecat cloud regions","sidebarTitle":"regions","href":"/api-reference/cli/cloud/regions"}]}]}]},{"group":"Pipecat Context Hub","pages":[{"title":"Pipecat Context Hub","sidebarTitle":"Overview","href":"/api-reference/context-hub/overview"},{"title":"Context Hub ChatGPT Plugin","sidebarTitle":"ChatGPT Plugin","href":"/api-reference/context-hub/chatgpt-plugin"}]}]}]},"basePath":"","title":"Session API - Pipecat Cloud","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}