{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Beyond Presence","colors":{"primary":"#7a5af8","light":"#7a5af8","dark":"#7a5af8"},"logo":{"light":"https://mintcdn.com/beyondpresence/S5fGLcshE9Aw3K0I/logo/dark.svg?fit=max\u0026auto=format\u0026n=S5fGLcshE9Aw3K0I\u0026q=85\u0026s=ab7cf5425f3216f7d2bc1a8e17151b49","dark":"https://mintcdn.com/beyondpresence/S5fGLcshE9Aw3K0I/logo/light.svg?fit=max\u0026auto=format\u0026n=S5fGLcshE9Aw3K0I\u0026q=85\u0026s=4b3c1e93da9154824c2d6190240055b9"},"favicon":"https://mintcdn.com/beyondpresence/Z_iP43IRCo3W0M4a/favicon.svg?fit=max\u0026auto=format\u0026n=Z_iP43IRCo3W0M4a\u0026q=85\u0026s=67b11b7fa697d84e089560d622d1f499","api":{"playground":{"display":"simple"},"examples":{"defaults":"all","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"https://status.bey.dev/","label":"Status"},{"href":"mailto:support@beyondpresence.ai","label":"Support"}],"primary":{"type":"button","label":"Studio","href":"https://bey.studio"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Homepage \u0026 Demo","icon":"infinity","href":"https://beyondpresence.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://bey.dev/community"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"beyondpresence","hasAudioNarration":false,"actualSubdomain":"beyondpresence","customDomains":["docs.bey.dev"],"gitSource":{"type":"github","owner":"beyond-presence","repo":"monorepo","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae44067b9bcaa3761b32125","collectionId":"01f72604-889f-499f-beca-7decd79d65b1","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae44067b9bcaa3761b32125"},"feedback":{"issues":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae44067b9bcaa3761b32125","clientVersion":"0.0.4039","searchFilterCounts":[{"language":"default","tag":"Docs","count":42},{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Core Concepts","count":14},{"language":"default","tag":"Integrations","count":12},{"language":"default","tag":"Agents","count":11},{"language":"default","tag":"Learn More","count":7},{"language":"default","tag":"Agent Knowledge Files","count":6},{"language":"default","tag":"Avatars","count":5},{"language":"default","tag":"Meetings (Zoom, ...)","count":5},{"language":"default","tag":"Production Guides","count":5}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@beyondpresence.ai"}},"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/speech-to-video-sessions/retrieve-speech-to-video-session","slug":"/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session","pageMetadata":{"title":"Retrieve Speech-to-Video Session","description":"Retrieve a single speech-to-video session by ID.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{id}","href":"/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a single speech-to-video session by ID.\"\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":{"config":{},"pageMetadata":{"title":"Retrieve Speech-to-Video Session","description":"Retrieve a single speech-to-video session by ID.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{id}","href":"/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Speech-to-Video Sessions"],"summary":"Retrieve Speech-to-Video Session","description":"Retrieve a single speech-to-video session by ID.","operationId":"get_session_v1_sessions__id__get","security":["ad9e970e-3654-44e6-9c8f-b3f71868bb41"],"parameters":["821b77eb-648a-492c-9fce-91a92b94af98"],"responses":{"200":"61dd12a3-cf64-400d-88d0-0ca21954338d","401":"186db02c-b341-4a1b-885f-259a06b566d1","402":"c7fd2ca6-5e6f-423a-80e1-00bf5eceec66","403":"108a016b-fdbc-448e-aa82-b079bc7e6374","404":"ce1344e3-dd18-4bc0-98e2-4f2d51e81b3f","422":"d3248ff8-3c8b-4f89-9302-924fdcadf8c6","429":"91fadfe2-1f49-4a77-ab32-c9c39ea62529"},"method":"get","type":"path","servers":["4879d687-d990-409e-ae93-73e9f2b2c2c7"],"path":"/v1/sessions/{id}","baseUrlOptions":["https://api.bey.dev"],"title":"Retrieve Speech-to-Video Session","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"821b77eb-648a-492c-9fce-91a92b94af98":{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Speech-to-video session ID.","title":"Id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"Speech-to-video session ID."}},"responses":{"61dd12a3-cf64-400d-88d0-0ca21954338d":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"LivekitSessionResponse","description":"Response body for a LiveKit speech-to-video session.","required":["id","avatar_id","status","url"],"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the object in the database.","examples":["01234567-89ab-cdef-0123-456789abcdef"],"isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"avatar_id":{"type":"string","title":"Avatar Id","description":"ID of avatar to use.","examples":["01234567-89ab-cdef-0123-456789abcdef"],"isRequired":true,"uniqueKey":"oneOf.0.avatar_id","typeLabel":"string"},"status":{"oneOf":[{"type":"object","title":"SessionStatusToStart","description":"Session that has not yet started.","properties":{"type":{"type":"string","const":"to_start","title":"Type","default":"to_start","uniqueKey":"oneOf.0.status.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.status.oneOf.0","typeLabel":"SessionStatusToStart · object"},{"type":"object","title":"SessionStatusOngoing","description":"Session that is currently ongoing.","required":["started_at"],"properties":{"started_at":{"type":"string","title":"Started At","description":"Start time in ISO 8601 format.","examples":["2022-01-01T00:00:00Z"],"isRequired":true,"uniqueKey":"oneOf.0.status.oneOf.1.started_at","typeLabel":"string"},"type":{"type":"string","const":"ongoing","title":"Type","default":"ongoing","uniqueKey":"oneOf.0.status.oneOf.1.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.status.oneOf.1","typeLabel":"SessionStatusOngoing · object"},{"type":"object","title":"SessionStatusCompleted","description":"Session that has completed.","required":["started_at","ended_at"],"properties":{"started_at":{"type":"string","title":"Started At","description":"Start time in ISO 8601 format.","examples":["2022-01-01T00:00:00Z"],"isRequired":true,"uniqueKey":"oneOf.0.status.oneOf.2.started_at","typeLabel":"string"},"ended_at":{"type":"string","title":"Ended At","description":"End time in ISO 8601 format.","examples":["2022-01-01T00:00:00Z"],"isRequired":true,"uniqueKey":"oneOf.0.status.oneOf.2.ended_at","typeLabel":"string"},"type":{"type":"string","const":"completed","title":"Type","default":"completed","uniqueKey":"oneOf.0.status.oneOf.2.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.status.oneOf.2","typeLabel":"SessionStatusCompleted · object"}],"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"SessionStatusToStart · object | SessionStatusOngoing · object | SessionStatusCompleted · object"},"url":{"type":"string","title":"Url","description":"URL of LiveKit server the avatar worker should connect to.","examples":["wss://\u003cyour-domain>.livekit.cloud"],"isRequired":true,"uniqueKey":"oneOf.0.url","typeLabel":"string"},"transport":{"type":"string","const":"livekit","title":"Transport","default":"livekit","uniqueKey":"oneOf.0.transport","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"LivekitSessionResponse · object"},{"type":"object","title":"PipecatSessionResponse","description":"Response body for a Pipecat speech-to-video session.","required":["id","avatar_id","status","url"],"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the object in the database.","examples":["01234567-89ab-cdef-0123-456789abcdef"],"isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"avatar_id":{"type":"string","title":"Avatar Id","description":"ID of avatar to use.","examples":["01234567-89ab-cdef-0123-456789abcdef"],"isRequired":true,"uniqueKey":"oneOf.1.avatar_id","typeLabel":"string"},"status":{"oneOf":[{"type":"object","title":"SessionStatusToStart","description":"Session that has not yet started.","properties":{"type":{"type":"string","const":"to_start","title":"Type","default":"to_start","uniqueKey":"oneOf.1.status.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.status.oneOf.0","typeLabel":"SessionStatusToStart · object"},{"type":"object","title":"SessionStatusOngoing","description":"Session that is currently ongoing.","required":["started_at"],"properties":{"started_at":{"type":"string","title":"Started At","description":"Start time in ISO 8601 format.","examples":["2022-01-01T00:00:00Z"],"isRequired":true,"uniqueKey":"oneOf.1.status.oneOf.1.started_at","typeLabel":"string"},"type":{"type":"string","const":"ongoing","title":"Type","default":"ongoing","uniqueKey":"oneOf.1.status.oneOf.1.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.status.oneOf.1","typeLabel":"SessionStatusOngoing · object"},{"type":"object","title":"SessionStatusCompleted","description":"Session that has completed.","required":["started_at","ended_at"],"properties":{"started_at":{"type":"string","title":"Started At","description":"Start time in ISO 8601 format.","examples":["2022-01-01T00:00:00Z"],"isRequired":true,"uniqueKey":"oneOf.1.status.oneOf.2.started_at","typeLabel":"string"},"ended_at":{"type":"string","title":"Ended At","description":"End time in ISO 8601 format.","examples":["2022-01-01T00:00:00Z"],"isRequired":true,"uniqueKey":"oneOf.1.status.oneOf.2.ended_at","typeLabel":"string"},"type":{"type":"string","const":"completed","title":"Type","default":"completed","uniqueKey":"oneOf.1.status.oneOf.2.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.status.oneOf.2","typeLabel":"SessionStatusCompleted · object"}],"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"SessionStatusToStart · object | SessionStatusOngoing · object | SessionStatusCompleted · object"},"url":{"type":"string","title":"Url","description":"URL of Daily room the video bot should connect to.","examples":["wss://\u003cyour-domain>.pipecat.cloud"],"isRequired":true,"uniqueKey":"oneOf.1.url","typeLabel":"string"},"transport":{"type":"string","const":"pipecat","title":"Transport","default":"pipecat","uniqueKey":"oneOf.1.transport","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"PipecatSessionResponse · object"}],"uniqueKey":"","typeLabel":"LivekitSessionResponse · object | PipecatSessionResponse · object"},"examples":{"Example":{"title":"Example","value":{"id":"01234567-89ab-cdef-0123-456789abcdef","avatar_id":"01234567-89ab-cdef-0123-456789abcdef","status":{"type":"to_start"},"url":"wss://\u003cyour-domain>.livekit.cloud","transport":"livekit"}}},"exampleType":"generated"}},"exampleType":"generated"},"186db02c-b341-4a1b-885f-259a06b566d1":{"description":"Authentication failed. The `x-api-key` header is missing or the provided API key is invalid.","content":{"application/json":{"examples":{"missing":{"title":"missing","value":{"detail":"API key is required."}},"invalid":{"title":"invalid","value":{"detail":"Invalid API key."}}},"schema":{"properties":{"detail":{"type":"string","title":"Detail","description":"Human-readable description of the error.","examples":["Invalid API key."],"isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"type":"object","required":["detail"],"title":"ErrorResponse","description":"Standard error response body.\n\nCarries a single human-readable `detail` message describing what went\nwrong. This is the shape of every error response except validation errors\n(`422`), which instead return a list of per-field error objects.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"exampleType":"examples"},"c7fd2ca6-5e6f-423a-80e1-00bf5eceec66":{"description":"The plan's usage limit has been reached, or the requested feature requires a plan upgrade.","content":{"application/json":{"examples":{"usage":{"title":"usage","value":{"detail":"You have reached your usage limit. Please upgrade your plan or enable usage-based billing."}},"plan":{"title":"plan","value":{"detail":"This feature is not available on your current plan. Please upgrade your plan."}}},"schema":{"properties":{"detail":{"type":"string","title":"Detail","description":"Human-readable description of the error.","examples":["Invalid API key."],"isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"type":"object","required":["detail"],"title":"ErrorResponse","description":"Standard error response body.\n\nCarries a single human-readable `detail` message describing what went\nwrong. This is the shape of every error response except validation errors\n(`422`), which instead return a list of per-field error objects.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"exampleType":"examples"},"108a016b-fdbc-448e-aa82-b079bc7e6374":{"description":"The API key is valid but not permitted to perform this action, because the resource belongs to someone else.","content":{"application/json":{"example":{"detail":"You do not have permission to access this resource."},"schema":{"properties":{"detail":{"type":"string","title":"Detail","description":"Human-readable description of the error.","examples":["Invalid API key."],"isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"type":"object","required":["detail"],"title":"ErrorResponse","description":"Standard error response body.\n\nCarries a single human-readable `detail` message describing what went\nwrong. This is the shape of every error response except validation errors\n(`422`), which instead return a list of per-field error objects.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"You do not have permission to access this resource."}}},"exampleType":"examples"}},"exampleType":"examples"},"ce1344e3-dd18-4bc0-98e2-4f2d51e81b3f":{"description":"The requested resource does not exist or is not accessible with this API key.","content":{"application/json":{"example":{"detail":"The requested resource was not found."},"schema":{"properties":{"detail":{"type":"string","title":"Detail","description":"Human-readable description of the error.","examples":["Invalid API key."],"isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"type":"object","required":["detail"],"title":"ErrorResponse","description":"Standard error response body.\n\nCarries a single human-readable `detail` message describing what went\nwrong. This is the shape of every error response except validation errors\n(`422`), which instead return a list of per-field error objects.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"The requested resource was not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"d3248ff8-3c8b-4f89-9302-924fdcadf8c6":{"description":"The request is malformed. `detail` lists each field that failed validation, where it was located, and why.","content":{"application/json":{"example":{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"91fadfe2-1f49-4a77-ab32-c9c39ea62529":{"description":"The plan's limit on the number of concurrent sessions has been reached.","content":{"application/json":{"example":{"detail":"You have reached your concurrency limit. Please upgrade your plan or stop other ongoing sessions."},"schema":{"properties":{"detail":{"type":"string","title":"Detail","description":"Human-readable description of the error.","examples":["Invalid API key."],"isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"type":"object","required":["detail"],"title":"ErrorResponse","description":"Standard error response body.\n\nCarries a single human-readable `detail` message describing what went\nwrong. This is the shape of every error response except validation errors\n(`422`), which instead return a list of per-field error objects.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"You have reached your concurrency limit. Please upgrade your plan or stop other ongoing sessions."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ad9e970e-3654-44e6-9c8f-b3f71868bb41":{"APIKeyHeader":{"type":"apiKey","description":"Your Beyond Presence API Key.","in":"header","name":"x-api-key","scopes":[],"schemeName":"APIKeyHeader"}}},"servers":{"4879d687-d990-409e-ae93-73e9f2b2c2c7":{"url":"https://api.bey.dev"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Your Beyond Presence API Key.","in":"header","name":"x-api-key","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"x-api-key","type":"string","description":"Your Beyond Presence API Key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"x-api-key"}],"title":"APIKeyHeader"}]},"originalFileLocation":"openapi.json"},"subdomain":"beyondpresence","siteName":"Beyond Presence","title":"Retrieve Speech-to-Video Session - Beyond Presence","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T14:52:55.770Z","originalFileLocation":"api-reference/speech-to-video-sessions/retrieve-speech-to-video-session.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=\"Retrieve a single speech-to-video session by ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Beyond Presence\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/beyondpresence/XomqLvVMn3CayKZ5/_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/beyondpresence/XomqLvVMn3CayKZ5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/beyondpresence/XomqLvVMn3CayKZ5/_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/beyondpresence/XomqLvVMn3CayKZ5/_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/beyondpresence/XomqLvVMn3CayKZ5/_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/beyondpresence/XomqLvVMn3CayKZ5/_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/beyondpresence/XomqLvVMn3CayKZ5/_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/beyondpresence/XomqLvVMn3CayKZ5/_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/beyondpresence/XomqLvVMn3CayKZ5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve Speech-to-Video Session - Beyond Presence\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single speech-to-video session by ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Beyond Presence\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://beyondpresence.mintlify.app/_mintlify/api/og/v2?division=Speech-to-Video+Sessions\u0026amp;title=Retrieve+Speech-to-Video+Session\u0026amp;description=Retrieve+a+single+speech-to-video+session+by+ID.\u0026amp;theme=93ae23e6800ac019762ccb05\u0026amp;signature=d309514b780ac893f82484920dd6b961ca05aeea476b8beecd9af17fc783ddca\">\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=\"Retrieve Speech-to-Video Session - Beyond Presence\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single speech-to-video session by ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://beyondpresence.mintlify.app/_mintlify/api/og/v2?division=Speech-to-Video+Sessions\u0026amp;title=Retrieve+Speech-to-Video+Session\u0026amp;description=Retrieve+a+single+speech-to-video+session+by+ID.\u0026amp;theme=93ae23e6800ac019762ccb05\u0026amp;signature=d309514b780ac893f82484920dd6b961ca05aeea476b8beecd9af17fc783ddca\">\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/beyondpresence/XomqLvVMn3CayKZ5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Beyond Presence\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7a5af8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bey.dev/#organization\",\"name\":\"Beyond Presence\",\"url\":\"https://docs.bey.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/beyondpresence/S5fGLcshE9Aw3K0I/logo/dark.svg?fit=max\u0026auto=format\u0026n=S5fGLcshE9Aw3K0I\u0026q=85\u0026s=ab7cf5425f3216f7d2bc1a8e17151b49\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bey.dev#website\",\"name\":\"Beyond Presence\",\"url\":\"https://docs.bey.dev\",\"publisher\":{\"@id\":\"https://docs.bey.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session#webpage\",\"url\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session\",\"name\":\"Retrieve Speech-to-Video Session\",\"description\":\"Retrieve a single speech-to-video session by ID.\",\"dateModified\":\"2026-10-28T14:52:55.770Z\",\"isPartOf\":{\"@id\":\"https://docs.bey.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Speech-to-Video Sessions\",\"item\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/list-speech-to-video-sessions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve Speech-to-Video Session\",\"item\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session#apireference\",\"headline\":\"Retrieve Speech-to-Video Session\",\"name\":\"Retrieve Speech-to-Video Session\",\"description\":\"Retrieve a single speech-to-video session by ID.\",\"url\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bey.dev/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session#webpage\"},\"dateModified\":\"2026-10-28T14:52:55.770Z\",\"publisher\":{\"@id\":\"https://docs.bey.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bey.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Beyond Presence\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Beyond Presence","nav":{"global":{"anchors":[{"anchor":"Homepage \u0026 Demo","icon":"infinity","href":"https://beyondpresence.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://bey.dev/community"}]},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/get-started"}]},{"tab":"API Reference","groups":[{"group":"Avatars","pages":[{"title":"List Avatars","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/avatars","href":"/api-reference/avatars/list-avatars"},{"title":"Retrieve Avatar","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/avatars/{id}","href":"/api-reference/avatars/retrieve-avatar"}]},{"group":"Agents","pages":[{"title":"List Agents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create Agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents","href":"/api-reference/agents/create-agent"},{"title":"Retrieve Agent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents/{id}","href":"/api-reference/agents/retrieve-agent"},{"title":"Delete Agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agents/{id}","href":"/api-reference/agents/delete-agent"},{"title":"Update Agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agents/{id}","href":"/api-reference/agents/update-agent"}]},{"group":"Agent Conversations","pages":[{"title":"List Conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/conversations","href":"/api-reference/agent-conversations/list-conversations"},{"title":"Retrieve Conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/conversations/{id}","href":"/api-reference/agent-conversations/retrieve-conversation"},{"title":"List Conversation Messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/conversations/{id}/messages","href":"/api-reference/agent-conversations/list-conversation-messages"}]},{"group":"Agent Integration","pages":[{"title":"Create LiveKit Room","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/livekit-rooms","href":"/api-reference/agent-integration/create-livekit-room"}]},{"group":"Agent Knowledge Files","pages":[{"title":"List Knowledge Files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-files","href":"/api-reference/agent-knowledge-files/list-knowledge-files"},{"title":"Create Knowledge File","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-files","href":"/api-reference/agent-knowledge-files/create-knowledge-file"},{"title":"Retrieve Knowledge File","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/knowledge-files/{id}","href":"/api-reference/agent-knowledge-files/retrieve-knowledge-file"},{"title":"Delete Knowledge File","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/knowledge-files/{id}","href":"/api-reference/agent-knowledge-files/delete-knowledge-file"},{"title":"Upload Knowledge File Chunk","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/knowledge-files/{id}/upload","href":"/api-reference/agent-knowledge-files/upload-knowledge-file-chunk"},{"title":"Submit Knowledge File","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/knowledge-files/{id}/submit","href":"/api-reference/agent-knowledge-files/submit-knowledge-file"}]},{"group":"Agents External APIs","pages":[{"title":"List External API Configurations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/external-apis","href":"/api-reference/agents-external-apis/list-external-api-configurations"},{"title":"Create External API Configuration","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/external-apis","href":"/api-reference/agents-external-apis/create-external-api-configuration"},{"title":"Retrieve External API Configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/external-apis/{id}","href":"/api-reference/agents-external-apis/retrieve-external-api-configuration"},{"title":"Delete External API Configuration","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/external-apis/{id}","href":"/api-reference/agents-external-apis/delete-external-api-configuration"}]},{"group":"Authentication","pages":[{"title":"Verify API Key","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/verify","href":"/api-reference/authentication/verify-api-key"}]},{"group":"Speech-to-Video Sessions","pages":[{"title":"List Speech-to-Video Sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions","href":"/api-reference/speech-to-video-sessions/list-speech-to-video-sessions"},{"title":"Create Speech-to-Video Session","description":"Create a speech-to-video session.\n\nTip: do not use this directly, use the LiveKit plugin instead.\nSee \u003chttps://docs.livekit.io/agents/integrations/avatar/bey>.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions","href":"/api-reference/speech-to-video-sessions/create-speech-to-video-session"},{"title":"Retrieve Speech-to-Video Session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{id}","href":"/api-reference/speech-to-video-sessions/retrieve-speech-to-video-session"}]},{"group":"Usage","pages":[{"title":"Retrieve Usage","description":"Retrieve your organization's usage in the current billing period.\n\nAll figures are seconds as your plan counts them, and cover every workspace\nof your organization, so only an API key of the default workspace can read\nthem. Usage can take a few minutes to appear.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/usage/retrieve-usage"},{"title":"Retrieve Speech-to-Video Session Usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/sessions","href":"/api-reference/usage/retrieve-speech-to-video-session-usage"}]}]}]},"basePath":"","title":"Retrieve Speech-to-Video Session - Beyond Presence","buildId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","deploymentId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CVpqyvFO.js","utils-vpweLD0v.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BIOodqb0.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1LM3qmu.js","snippetPresets-C5xK0GtN.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CCsxLnQl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C2-WKG22.js","shallow-SdoLUC-q.js","getApiPlaygroundDisplay-BnI8L2hB.js","CodeSnippet-D5M8NCHI.js","CodeSnippets-CXRO8Uom.js","Page-CN9QbZiA.js","getPastedJson-CrfHEdRt.js","icon-Cr8AyUnW.js","MethodPill-J_Cs0kNw.js","DuplicateIcon-DrMboxGw.js","createIcon-B4CIWVbU.js","DynamicMarkdown-D9cdbgj9.js","SectionHeading-BO4CouT0.js","axios-vUo_bRtp.js","Markdown-L1m1-PSi.js","clsx-rIpTdK8h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-ptfS1uB_.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D31Sm3f9.js"]}