Present for a workflow session; identifies its workflow run.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LiveFaces","description":"Use the LiveFaces console, build workflows, and launch voice and digital-human sessions.","colors":{"primary":"#6D28D9","light":"#A78BFA","dark":"#7C3AED"},"api":{"playground":{"display":"simple","proxy":false},"examples":{"defaults":"required","languages":["javascript","curl"]}},"navbar":{"links":[{"href":"https://livefaces.ai","label":"LiveFaces"}]},"seo":{"metatags":{"canonical":"https://docs.livefaces.ai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lagena","hasAudioNarration":false,"actualSubdomain":"lagena","customDomains":["docs.livefaces.ai"],"gitSource":{"type":"github","owner":"lagena-ai","repo":"external-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad5010919b78167d4779664","collectionId":"5c46daa7-f861-4a5b-8011-61661604db78","liveDeploymentHistoryId":"6ad5010919b78167d4779664","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aecf138ebc8078c1e155848","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"Workflows","count":6},{"language":"default","tag":"API reference","count":6},{"language":"default","tag":"Session API","count":5},{"language":"default","tag":"Sessions","count":4},{"language":"default","tag":"Console","count":3},{"language":"default","tag":"Get started","count":2},{"language":"default","tag":"Help","count":1},{"language":"default","tag":"Authentication","count":1},{"language":"default","tag":"Workflow runs","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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":"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":".lf-explorer{--lf-accent: #6d28d9;--lf-soft: #f5f3ff;--lf-panel: #fff;--lf-border: #e4e4e7;--lf-muted: #52525b;--lf-ink: #18181b;margin:1.5rem 0 2rem;border:1px solid var(--lf-border);border-radius:16px;overflow:hidden;background:var(--lf-panel);color:var(--lf-ink)}.dark .lf-explorer{--lf-accent: #c4b5fd;--lf-soft: #26203b;--lf-panel: #161618;--lf-border: #3f3f46;--lf-muted: #a1a1aa;--lf-ink: #f4f4f5}.lf-explorer-top{display:flex;flex-wrap:wrap;gap:.5rem;justify-content:space-between;padding:18px 22px;border-bottom:1px solid var(--lf-border);font-size:12px;color:var(--lf-muted)}.lf-eyebrow{letter-spacing:.12em;font-weight:700;color:var(--lf-accent)}.lf-map-scroll{overflow-x:auto;padding:24px 20px 12px}.lf-map{display:grid;position:relative;grid-template-columns:repeat(4, minmax(0, 1fr));grid-template-rows:repeat(3, 80px);gap:40px 32px;min-width:720px}.lf-connections{position:absolute;width:100%;height:100%;inset:0;color:var(--lf-border);pointer-events:none}.lf-node{z-index:1;display:flex;flex-direction:column;justify-content:center;gap:9px;text-align:left;border:1px solid var(--lf-border);border-radius:10px;padding:10px 12px;background:var(--lf-panel);color:var(--lf-ink);cursor:pointer;font:inherit;transition:border-color .15s, background-color .15s}.lf-node:hover{border-color:var(--lf-accent)}.lf-node[aria-pressed=\"true\"]{background:var(--lf-soft);border-color:var(--lf-accent);box-shadow:0 0 0 1px var(--lf-accent)}.lf-explorer :is(button,a,[tabindex]):focus-visible{outline:3px solid var(--lf-accent);outline-offset:4px}.lf-node-meta{display:flex;justify-content:space-between;font-size:10px;letter-spacing:.03em;color:var(--lf-muted)}.lf-node strong{font-size:12px;line-height:1.35;font-weight:650}.lf-caption{padding:0 22px 20px;margin:0;font-size:12px;line-height:1.6;color:var(--lf-muted)}.lf-detail{border-top:1px solid var(--lf-border);padding:22px}.lf-detail-heading{display:flex;flex-wrap:wrap;align-items:center;gap:12px}.lf-detail-heading h2{margin:0;font-size:20px;line-height:1.4;font-weight:650}.lf-detail-heading>span{padding:3px 9px;border-radius:99px;font-size:11px;background:var(--lf-soft);color:var(--lf-accent)}.lf-detail p{margin:12px 0;font-size:14px;line-height:1.65}.lf-detail dl{display:grid;gap:14px;margin:20px 0}.lf-detail dl>div{display:grid;grid-template-columns:82px 1fr;gap:12px;font-size:13px;line-height:1.65}.lf-detail dt{font-weight:650;color:var(--lf-muted)}.lf-detail dd{margin:0}.lf-outcomes{display:flex;flex-wrap:wrap;gap:5px}.lf-outcomes code{padding:1px 7px;border:1px solid var(--lf-border);border-radius:5px;font-size:11px}.lf-detail .lf-tip{padding-left:12px;border-left:2px solid var(--lf-accent);color:var(--lf-muted);font-size:13px}.lf-reference-link{font-size:12px;font-weight:600;color:var(--lf-accent);text-decoration:underline;text-underline-offset:3px}@media (max-width: 480px){.lf-detail dl>div{grid-template-columns:1fr;gap:2px}.lf-detail{padding:18px}}@media (prefers-reduced-motion: reduce){.lf-node{transition:none}}"}],"page":{"pagePath":"reference/sessions/create-a-voice-session","slug":"/reference/sessions/create-a-voice-session","pageMetadata":{"title":"Create a voice session","description":"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /v1/sessions","href":"/reference/sessions/create-a-voice-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: \"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.\"\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 a voice session","description":"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /v1/sessions","href":"/reference/sessions/create-a-voice-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createSession","summary":"Create a voice session","tags":["Sessions"],"description":"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.","responses":{"201":"b0fa737d-27c3-40e8-96d3-a6b3702d9e42","401":"d3abbd6f-ea41-4abd-82eb-41c08af4b31f","403":"7e2c79b6-f5f4-416e-adac-c14327699151","404":"9a68ee83-f161-4e0d-8e7f-6360b904f4ca","409":"3e8130a3-157f-4445-9649-29e8d9efdcaa","422":"39f1838c-f7ab-4b44-9bd3-a46ad2eb405c","500":"fc738eec-19dd-4711-938c-00cc440dafa0","503":"865f8bda-f242-4933-8a73-4f7623ab6d90"},"parameters":["5f2fe1c7-f45a-474b-bb72-ee1b40af65c8"],"requestBody":"de686ac7-5efe-499f-828c-01232c3657c4","method":"post","type":"path","servers":["ae807ae8-c1cd-4a7c-bb31-2c3bf00c9f30"],"security":["6f274bd9-83bf-4ff8-836f-ab446069138d"],"path":"/v1/sessions","baseUrlOptions":["https://api.livefaces.ai"],"title":"Create a voice session","codeSamples":[],"requestExampleLanguages":["javascript","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"5f2fe1c7-f45a-474b-bb72-ee1b40af65c8":{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID for one intended launch. Reuse this key and the identical body when retrying that launch.","schema":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"description":"Unique ID for one intended launch. Reuse this key and the identical body when retrying that launch.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"voice_id":{"type":"string","description":"Voice UUID available to the organization.","format":"uuid","isRequired":true,"uniqueKey":"voice_id","typeLabel":"string\u003cuuid>"},"face_id":{"oneOf":[{"type":"string","description":"Compatible face UUID; omit or use null for audio only.","format":"uuid","uniqueKey":"face_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"face_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"face_id","typeLabel":"string\u003cuuid> | null"},"prompt":{"oneOf":[{"type":"string","description":"Instructions for this conversation. Omit or use null for voice defaults; text must not be blank.","maxLength":32000,"minLength":1,"uniqueKey":"prompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Instructions for this conversation. Omit or use null for voice defaults; text must not be blank.","uniqueKey":"prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt","typeLabel":"string | null"},"greeting":{"oneOf":[{"type":"string","description":"Omit for the standard greeting; null disables it. Nonblank custom text is delivered according to the selected voice.","maxLength":500,"minLength":1,"uniqueKey":"greeting.oneOf.0","typeLabel":"string"},{"type":"null","description":"Omit for the standard greeting; null disables it. Nonblank custom text is delivered according to the selected voice.","uniqueKey":"greeting.oneOf.1","typeLabel":"null"}],"uniqueKey":"greeting","typeLabel":"string | null"},"mcps":{"type":"array","items":{"type":"object","properties":{"mcp_id":{"type":"string","description":"Registered MCP connection UUID.","format":"uuid","isRequired":true,"uniqueKey":"mcps.items.[INDEX].mcp_id","typeLabel":"string\u003cuuid>"},"tools":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"mcps.items.[INDEX].tools.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Selected discovered tool names. An empty list selects no tools; omit or use null for all available tools.","maxItems":128,"uniqueItems":true,"uniqueKey":"mcps.items.[INDEX].tools.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Selected discovered tool names. An empty list selects no tools; omit or use null for all available tools.","uniqueKey":"mcps.items.[INDEX].tools.oneOf.1","typeLabel":"null"}],"uniqueKey":"mcps.items.[INDEX].tools","typeLabel":"string[] | null"}},"required":["mcp_id"],"additionalProperties":false,"uniqueKey":"mcps.items.[INDEX]","typeLabel":"object"},"maxItems":8,"description":"Connections and tools available for this session. Each connection may appear once.","uniqueKey":"mcps","typeLabel":"object[]"},"participant_identity":{"type":"string","description":"Identity for the participant joining the room.","default":"browser","minLength":1,"maxLength":100,"uniqueKey":"participant_identity","typeLabel":"string"},"tags":{"type":"array","maxItems":20,"items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"Application labels.","uniqueKey":"tags","typeLabel":"string[]"},"metadata":{"type":"object","additionalProperties":true,"description":"Application context; exclude secrets.","uniqueKey":"metadata","typeLabel":"object"}},"required":["voice_id"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"voice_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","face_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","prompt":"\u003cstring>","greeting":"\u003cstring>","mcps":[{"mcp_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","tools":["\u003cstring>"]}],"participant_identity":"browser","tags":["\u003cstring>"],"metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b0fa737d-27c3-40e8-96d3-a6b3702d9e42":{"description":"Successful response","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Use this session ID for status, token refresh, end, and transcript requests.","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["created","active","completed","failed","cancelled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"room_name":{"type":"string","description":"Room name for the connection.","isRequired":true,"uniqueKey":"room_name","typeLabel":"string"},"livekit_url":{"type":"string","description":"LiveKit connection URL returned by the service.","format":"uri","isRequired":true,"uniqueKey":"livekit_url","typeLabel":"string\u003curi>"},"participant_token":{"oneOf":[{"type":"string","description":"Short-lived participant credential, or null after the session becomes terminal.","isRequired":true,"uniqueKey":"participant_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Short-lived participant credential, or null after the session becomes terminal.","isRequired":true,"uniqueKey":"participant_token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"participant_token","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"started_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"started_at","typeLabel":"string\u003cdate-time> | null"},"ended_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"ended_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"ended_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ended_at","typeLabel":"string\u003cdate-time> | null"},"workflow_run_id":{"oneOf":[{"type":"string","description":"Present for a workflow session; identifies its workflow run.","format":"uuid","uniqueKey":"workflow_run_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"workflow_run_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow_run_id","typeLabel":"string\u003cuuid> | null"}},"required":["id","status","room_name","livekit_url","participant_token","created_at","started_at","ended_at"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"created","room_name":"\u003cstring>","livekit_url":"\u003cstring>","participant_token":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","started_at":"2023-11-07T05:31:56Z","ended_at":"2023-11-07T05:31:56Z","workflow_run_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}},"exampleType":"generated"}},"exampleType":"generated"},"d3abbd6f-ea41-4abd-82eb-41c08af4b31f":{"description":"Invalid, expired, or revoked API key.","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Application error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Error description or structured validation details.","isRequired":true,"uniqueKey":"detail","typeLabel":"any"},"request_id":{"type":"string","description":"Request identifier for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","detail","request_id"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cunknown>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7e2c79b6-f5f4-416e-adac-c14327699151":{"description":"Missing required scope or access.","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Application error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Error description or structured validation details.","isRequired":true,"uniqueKey":"detail","typeLabel":"any"},"request_id":{"type":"string","description":"Request identifier for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","detail","request_id"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cunknown>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9a68ee83-f161-4e0d-8e7f-6360b904f4ca":{"description":"Resource does not exist or is not accessible with this key.","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Application error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Error description or structured validation details.","isRequired":true,"uniqueKey":"detail","typeLabel":"any"},"request_id":{"type":"string","description":"Request identifier for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","detail","request_id"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cunknown>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3e8130a3-157f-4445-9649-29e8d9efdcaa":{"description":"Request conflicts with current state or idempotency use.","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Application error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Error description or structured validation details.","isRequired":true,"uniqueKey":"detail","typeLabel":"any"},"request_id":{"type":"string","description":"Request identifier for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","detail","request_id"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cunknown>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"39f1838c-f7ab-4b44-9bd3-a46ad2eb405c":{"description":"Invalid request fields, identifiers, or required headers.","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Application error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Error description or structured validation details.","isRequired":true,"uniqueKey":"detail","typeLabel":"any"},"request_id":{"type":"string","description":"Request identifier for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","detail","request_id"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cunknown>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fc738eec-19dd-4711-938c-00cc440dafa0":{"description":"Unexpected service error.","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Application error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Error description or structured validation details.","isRequired":true,"uniqueKey":"detail","typeLabel":"any"},"request_id":{"type":"string","description":"Request identifier for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","detail","request_id"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cunknown>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"865f8bda-f242-4933-8a73-4f7623ab6d90":{"description":"Session service is currently unavailable.","headers":{"X-Request-ID":{"description":"Identifier for diagnosing this request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Application error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Error description or structured validation details.","isRequired":true,"uniqueKey":"detail","typeLabel":"any"},"request_id":{"type":"string","description":"Request identifier for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","detail","request_id"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cunknown>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6f274bd9-83bf-4ff8-836f-ab446069138d":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Organization API key. Keep it on your server.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"ae807ae8-c1cd-4a7c-bb31-2c3bf00c9f30":{"url":"https://api.livefaces.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Organization API key. Keep it on your server.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization API key. Keep it on your server.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/public-api.json"},"subdomain":"lagena","siteName":"LiveFaces","title":"Create a voice session - LiveFaces","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T19:25:36.814Z","originalFileLocation":"reference/sessions/create-a-voice-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=\"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LiveFaces\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lagena/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lagena/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lagena/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/lagena/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a voice session - LiveFaces\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LiveFaces\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lagena.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+a+voice+session\u0026amp;description=Requires+sessions%3Acreate.+Choose+a+voice%2C+optional+face%2C+prompt%2C+and+tools.+Use+your+server%3B+keep+the+API+key+out+of+the+browser.\u0026amp;theme=3d476296bfc9578a20dc1459\u0026amp;signature=5223ad05784585ca6cbf6db8b0f851fe31e0543ef61e497e95c2994b24e79c20\">\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 a voice session - LiveFaces\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lagena.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+a+voice+session\u0026amp;description=Requires+sessions%3Acreate.+Choose+a+voice%2C+optional+face%2C+prompt%2C+and+tools.+Use+your+server%3B+keep+the+API+key+out+of+the+browser.\u0026amp;theme=3d476296bfc9578a20dc1459\u0026amp;signature=5223ad05784585ca6cbf6db8b0f851fe31e0543ef61e497e95c2994b24e79c20\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/lagena/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LiveFaces\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6D28D9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/sessions/create-a-voice-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.livefaces.ai/#organization\",\"name\":\"LiveFaces\",\"url\":\"https://docs.livefaces.ai\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.livefaces.ai#website\",\"name\":\"LiveFaces\",\"url\":\"https://docs.livefaces.ai\",\"publisher\":{\"@id\":\"https://docs.livefaces.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session#webpage\",\"url\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session\",\"name\":\"Create a voice session\",\"description\":\"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.\",\"dateModified\":\"2026-11-05T19:25:36.814Z\",\"isPartOf\":{\"@id\":\"https://docs.livefaces.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.livefaces.ai/reference/authentication/inspect-api-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a voice session\",\"item\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session#apireference\",\"headline\":\"Create a voice session\",\"name\":\"Create a voice session\",\"description\":\"Requires sessions:create. Choose a voice, optional face, prompt, and tools. Use your server; keep the API key out of the browser.\",\"url\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.livefaces.ai/reference/sessions/create-a-voice-session#webpage\"},\"dateModified\":\"2026-11-05T19:25:36.814Z\",\"publisher\":{\"@id\":\"https://docs.livefaces.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.livefaces.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LiveFaces\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"LiveFaces","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"LiveFaces documentation","href":"/index"},{"title":"Your first conversation","href":"/get-started/quickstart"}]},{"group":"Console","pages":[{"title":"Console guide","href":"/console/overview"},{"title":"Tools and integrations","href":"/console/tools"},{"title":"API keys","href":"/security/api-keys"}]},{"group":"Workflows","pages":[{"title":"Workflow essentials","href":"/workflows/overview"},{"title":"Node types","mode":"wide","href":"/workflows/nodes"},{"title":"Build a workflow","href":"/workflows/build-a-workflow"},{"title":"Data and routing","href":"/workflows/data-and-routing"},{"title":"Workflow patterns","href":"/workflows/examples"},{"title":"Test and publish","href":"/workflows/test-and-publish"}]},{"group":"Session API","pages":[{"title":"Session API","href":"/api/overview"},{"title":"Create a voice session","href":"/api/start-session"},{"title":"Start a workflow run","href":"/api/start-workflow"},{"title":"Session lifecycle","href":"/api/session-lifecycle"},{"title":"Errors and retries","href":"/api/errors"}]},{"group":"API reference","pages":[{"group":"Authentication","pages":[{"title":"Inspect API key","description":"Read the key organization, scopes, and expiry. Does not return its secret.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /v1/auth/api-key","href":"/reference/authentication/inspect-api-key"}]},{"group":"Sessions","pages":[{"title":"Create a voice session","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /v1/sessions","href":"/reference/sessions/create-a-voice-session"},{"title":"Read session and refresh token","description":"Requires sessions:read and the key that created this session. Returns a fresh token while connectable.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /v1/sessions/{session_id}","href":"/reference/sessions/read-session-and-refresh-token"},{"title":"End a session","deprecated":null,"version":null,"openapi":"/openapi/public-api.json delete /v1/sessions/{session_id}","href":"/reference/sessions/end-a-session"},{"title":"Read saved transcript","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /v1/sessions/{session_id}/transcript","href":"/reference/sessions/read-saved-transcript"}]},{"group":"Workflow runs","pages":[{"title":"Start a published workflow","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /v1/workflow-runs","href":"/reference/workflow-runs/start-a-published-workflow"}]}]},{"group":"Help","pages":[{"title":"Troubleshooting","href":"/help/troubleshooting"}]}]},"basePath":"","title":"Create a voice session - LiveFaces","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}