Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it.
Use this only when you are embedding a conversation in your own
application via the LiveKit client SDK. Most integrations do not need it:
Interacting with Managed Agents through the UI starts a conversation with no API call required.
The room is created together with its conversation, whose status and
transcript you can then read from /v1/conversations/{id}.
{"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.4021","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":"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/agent-integration/create-livekit-room","slug":"/api-reference/agent-integration/create-livekit-room","pageMetadata":{"title":"Create LiveKit Room","description":"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it.\n\nUse this only when you are embedding a conversation in your own\napplication via the LiveKit client SDK. Most integrations do not need it:\nInteracting with Managed Agents through the UI starts a conversation with no API call required.\n\nThe room is created together with its conversation, whose status and\ntranscript you can then read from `/v1/conversations/{id}`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/livekit-rooms","href":"/api-reference/agent-integration/create-livekit-room","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Use this only when you are embedding a conversation in your own\\napplication via the LiveKit client SDK. Most integrations do not need it:\\nInteracting with Managed Agents through the UI starts a conversation with no API call required.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The room is created together with its conversation, whose status and\\ntranscript you can then read from \", _jsx(_components.code, {\n children: \"/v1/conversations/{id}\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create LiveKit Room","description":"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it.\n\nUse this only when you are embedding a conversation in your own\napplication via the LiveKit client SDK. Most integrations do not need it:\nInteracting with Managed Agents through the UI starts a conversation with no API call required.\n\nThe room is created together with its conversation, whose status and\ntranscript you can then read from `/v1/conversations/{id}`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/livekit-rooms","href":"/api-reference/agent-integration/create-livekit-room","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Agent Integration"],"summary":"Create LiveKit Room","description":"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it.\n\nUse this only when you are embedding a conversation in your own\napplication via the LiveKit client SDK. Most integrations do not need it:\nInteracting with Managed Agents through the UI starts a conversation with no API call required.\n\nThe room is created together with its conversation, whose status and\ntranscript you can then read from `/v1/conversations/{id}`.","operationId":"create_livekit_room_v1_livekit_rooms_post","requestBody":"5c9b3ec7-781d-4446-9387-492cf74851b1","responses":{"201":"18801854-6769-459f-9948-6b9120be72f9","401":"86ce89a8-e8cb-48bf-8bef-0b5bc40747f9","402":"194d9c06-c7e1-4508-971b-ac834bc52aa2","403":"d760adaf-a07f-4d3b-a579-601af169e70f","404":"5a4dfc66-f9e5-476f-a17a-1eff5ddb685f","422":"55d39bb4-6bd4-428a-870b-25aa6a9efc12","429":"e42ac5ea-273b-4ed4-8edd-d31d3ad3eee6"},"security":["ccb68910-5704-4c5d-99df-f2971e9c9933"],"method":"post","type":"path","servers":["4879d687-d990-409e-ae93-73e9f2b2c2c7"],"path":"/v1/livekit-rooms","baseUrlOptions":["https://api.bey.dev"],"title":"Create LiveKit Room","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"agent_id":{"type":"string","title":"Agent Id","description":"ID of agent managing the conversation.","isRequired":true,"uniqueKey":"agent_id","typeLabel":"string"},"user_name":{"oneOf":[{"type":"string","title":"User Name","description":"Name of the user.","uniqueKey":"user_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Name","description":"Name of the user.","uniqueKey":"user_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_name","typeLabel":"string | null"},"user_email":{"oneOf":[{"type":"string","title":"User Email","description":"Email of the user.","uniqueKey":"user_email.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Email","description":"Email of the user.","uniqueKey":"user_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_email","typeLabel":"string | null"},"tags":{"additionalProperties":{"type":"string","maxLength":100,"minLength":1,"uniqueKey":"tags.additionalProperties","typeLabel":"string"},"propertyNames":{"maxLength":30,"minLength":1},"type":"object","maxProperties":10,"title":"Tags","description":"Tags for the conversation.","uniqueKey":"tags","typeLabel":"Tags · object"}},"type":"object","required":["agent_id"],"title":"CreateLiveKitRoomRequest","description":"Request body to create a LiveKit room and its conversation.","uniqueKey":"","typeLabel":"CreateLiveKitRoomRequest · object"},"examples":{"Example":{"title":"Example","value":{"agent_id":"\u003cstring>","user_name":"\u003cstring>","user_email":"\u003cstring>","tags":{}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"18801854-6769-459f-9948-6b9120be72f9":{"description":"Created LiveKit room with its conversation ID and connection details.","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of the object in the database.","examples":["01234567-89ab-cdef-0123-456789abcdef"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"agent_id":{"type":"string","title":"Agent Id","description":"ID of agent managing the conversation.","isRequired":true,"uniqueKey":"agent_id","typeLabel":"string"},"status":{"oneOf":[{"type":"object","title":"ToStartConversationStatus","description":"Status for conversation that has not yet started.","properties":{"type":{"type":"string","const":"to_start","title":"Type","default":"to_start","uniqueKey":"status.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"status.oneOf.0","typeLabel":"ToStartConversationStatus · object"},{"type":"object","title":"OngoingConversationStatus","description":"Status for conversation 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":"status.oneOf.1.started_at","typeLabel":"string"},"type":{"type":"string","const":"ongoing","title":"Type","default":"ongoing","uniqueKey":"status.oneOf.1.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"status.oneOf.1","typeLabel":"OngoingConversationStatus · object"},{"type":"object","title":"CompletedConversationStatus","description":"Status for conversation 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":"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":"status.oneOf.2.ended_at","typeLabel":"string"},"type":{"type":"string","const":"completed","title":"Type","default":"completed","uniqueKey":"status.oneOf.2.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"status.oneOf.2","typeLabel":"CompletedConversationStatus · object"}],"isRequired":true,"uniqueKey":"status","typeLabel":"ToStartConversationStatus · object | OngoingConversationStatus · object | CompletedConversationStatus · object"},"livekit_url":{"type":"string","title":"Livekit Url","description":"LiveKit server URL to connect to.","isRequired":true,"uniqueKey":"livekit_url","typeLabel":"string"},"livekit_token":{"type":"string","title":"Livekit Token","description":"JWT for joining the LiveKit room.","isRequired":true,"uniqueKey":"livekit_token","typeLabel":"string"},"user_name":{"oneOf":[{"type":"string","title":"User Name","description":"Name of the user.","uniqueKey":"user_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Name","description":"Name of the user.","uniqueKey":"user_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_name","typeLabel":"string | null"},"user_email":{"oneOf":[{"type":"string","title":"User Email","description":"Email of the user.","uniqueKey":"user_email.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Email","description":"Email of the user.","uniqueKey":"user_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_email","typeLabel":"string | null"},"tags":{"additionalProperties":{"type":"string","maxLength":100,"minLength":1,"uniqueKey":"tags.additionalProperties","typeLabel":"string"},"propertyNames":{"maxLength":30,"minLength":1},"type":"object","maxProperties":10,"title":"Tags","description":"Tags for the conversation.","uniqueKey":"tags","typeLabel":"Tags · object"}},"type":"object","required":["id","agent_id","status","livekit_url","livekit_token"],"title":"LiveKitRoomResponse","description":"Response model for a conversation including LiveKit connection details.","uniqueKey":"","typeLabel":"LiveKitRoomResponse · object"},"examples":{"Example":{"title":"Example","value":{"id":"01234567-89ab-cdef-0123-456789abcdef","agent_id":"\u003cstring>","status":{"type":"to_start"},"livekit_url":"\u003cstring>","livekit_token":"\u003cstring>","user_name":"\u003cstring>","user_email":"\u003cstring>","tags":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"86ce89a8-e8cb-48bf-8bef-0b5bc40747f9":{"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"},"194d9c06-c7e1-4508-971b-ac834bc52aa2":{"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"},"d760adaf-a07f-4d3b-a579-601af169e70f":{"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"},"5a4dfc66-f9e5-476f-a17a-1eff5ddb685f":{"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"},"55d39bb4-6bd4-428a-870b-25aa6a9efc12":{"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"},"e42ac5ea-273b-4ed4-8edd-d31d3ad3eee6":{"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":{"ccb68910-5704-4c5d-99df-f2971e9c9933":{"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":"Create LiveKit Room - Beyond Presence","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T14:52:55.634Z","originalFileLocation":"api-reference/agent-integration/create-livekit-room.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=\"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it. Use this only when you are embedding a conversation in your own application via the LiveKit client SDK. Most integrations do not need it: Interacting with Managed Agents through the UI starts a conversation with no API call required. The room is created together with its conversation, whose status and transcript you can then read from /v1/conversations/{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=\"Create LiveKit Room - Beyond Presence\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it. Use this only when you are embedding a conversation in your own application via the LiveKit client SDK. Most integrations do not need it: Interacting with Managed Agents through the UI starts a conversation with no API call required. The room is created together with its conversation, whose status and transcript you can then read from /v1/conversations/{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/agent-integration/create-livekit-room\">\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=Agent+Integration\u0026amp;title=Create+LiveKit+Room\u0026amp;description=Create+a+LiveKit+room+for+one+of+your+agents+and+return+the+credentials+a+LiveKit+client+needs+to+join+it.%0A%0AUse+this+only+when+you+are+embedding+a+conversation+\u0026amp;theme=93ae23e6800ac019762ccb05\u0026amp;signature=4e81a70d49c7bd655197c8cd09a446e77aefd24026ba9b0869c3d249658c2ce5\">\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=\"Create LiveKit Room - Beyond Presence\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it. Use this only when you are embedding a conversation in your own application via the LiveKit client SDK. Most integrations do not need it: Interacting with Managed Agents through the UI starts a conversation with no API call required. The room is created together with its conversation, whose status and transcript you can then read from /v1/conversations/{id}.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://beyondpresence.mintlify.app/_mintlify/api/og/v2?division=Agent+Integration\u0026amp;title=Create+LiveKit+Room\u0026amp;description=Create+a+LiveKit+room+for+one+of+your+agents+and+return+the+credentials+a+LiveKit+client+needs+to+join+it.%0A%0AUse+this+only+when+you+are+embedding+a+conversation+\u0026amp;theme=93ae23e6800ac019762ccb05\u0026amp;signature=4e81a70d49c7bd655197c8cd09a446e77aefd24026ba9b0869c3d249658c2ce5\">\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/agent-integration/create-livekit-room\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agent-integration/create-livekit-room.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/agent-integration/create-livekit-room#webpage\",\"url\":\"https://docs.bey.dev/api-reference/agent-integration/create-livekit-room\",\"name\":\"Create LiveKit Room\",\"description\":\"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it. Use this only when you are embedding a conversation in your own application via the LiveKit client SDK. Most integrations do not need it: Interacting with Managed Agents through the UI starts a conversation with no API call required. The room is created together with its conversation, whose status and transcript you can then read from /v1/conversations/{id}.\",\"dateModified\":\"2026-10-28T14:52:55.634Z\",\"isPartOf\":{\"@id\":\"https://docs.bey.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bey.dev/api-reference/agent-integration/create-livekit-room#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bey.dev/api-reference/agent-integration/create-livekit-room#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Beyond Presence\",\"item\":\"https://docs.bey.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create LiveKit Room\",\"item\":\"https://docs.bey.dev/api-reference/agent-integration/create-livekit-room\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bey.dev/api-reference/agent-integration/create-livekit-room#apireference\",\"headline\":\"Create LiveKit Room\",\"name\":\"Create LiveKit Room\",\"description\":\"Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it. Use this only when you are embedding a conversation in your own application via the LiveKit client SDK. Most integrations do not need it: Interacting with Managed Agents through the UI starts a conversation with no API call required. The room is created together with its conversation, whose status and transcript you can then read from /v1/conversations/{id}.\",\"url\":\"https://docs.bey.dev/api-reference/agent-integration/create-livekit-room\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bey.dev/api-reference/agent-integration/create-livekit-room#webpage\"},\"dateModified\":\"2026-10-28T14:52:55.634Z\",\"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","description":"List the transcribed messages of a conversation.\n\nReturns the conversation transcript in chronological order, with each\nmessage attributed to either the agent or the user.","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","description":"List your knowledge files.\n\nReturns a cursor-paginated list of the knowledge files you own, along with\ntheir processing status.","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","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","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"}]}]}]},"title":"Create LiveKit Room - Beyond Presence","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}