Create, manage, and terminate avatar sessions from your backend.
The Avaturn.Live API manages session lifecycle. Create a session with a conversation engine config; receive a session_id (backend handle) and a token (frontend credential).
Endpoint-specific error codes are listed in each operation’s reference page. Common patterns:
400 Bad Request — invalid payload (e.g. unknown voice_id, invalid render_model for the chosen avatar).
401 Unauthorized — missing or revoked API key.
410 Gone — avatar_id no longer exists.
422 Unprocessable Content — missing required engine field (e.g. client_secret for openai-realtime).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Avaturn.Live","colors":{"primary":"#000000","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/avaturn-1492efa9/dllyramte2Auj8Ns/logo/light.svg?fit=max\u0026auto=format\u0026n=dllyramte2Auj8Ns\u0026q=85\u0026s=a9bbc776013d1747117044b4e175b621","dark":"https://mintcdn.com/avaturn-1492efa9/dllyramte2Auj8Ns/logo/dark.svg?fit=max\u0026auto=format\u0026n=dllyramte2Auj8Ns\u0026q=85\u0026s=291e7ba277d0172a89799a4ac7687723"},"favicon":"https://mintcdn.com/avaturn-1492efa9/dllyramte2Auj8Ns/favicon.svg?fit=max\u0026auto=format\u0026n=dllyramte2Auj8Ns\u0026q=85\u0026s=a573ab7fd5196fd351da26230737f585","navbar":{"links":[{"href":"mailto:support@avaturn.me","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://avaturn.live/dashboard"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"avaturn-1492efa9","hasAudioNarration":false,"actualSubdomain":"avaturn-1492efa9","customDomains":["docs.avaturn.live"],"gitSource":{"type":"github","owner":"avaturn","repo":"live-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae921ad4f9c5e0fb2cf46e8:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"Web SDK","count":4},{"language":"default","tag":"Conversation Engines","count":3},{"language":"default","tag":"Legacy","count":3},{"language":"default","tag":"SDK Reference","count":3},{"language":"default","tag":"Get Started","count":2},{"language":"default","tag":"REST API","count":2},{"language":"default","tag":"API Documentation","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"API Reference","description":"Create, manage, and terminate avatar sessions from your backend.","href":"/api-reference/introduction"},"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: \"Create, manage, and terminate avatar sessions from your backend.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The Avaturn.Live API manages session lifecycle. Create a session with a `,_jsx(_components.a,{href:`/howtos/openai_realtime_api`,children:`conversation engine`}),` config; receive a `,_jsx(_components.code,{children:`session_id`}),` (backend handle) and a `,_jsx(_components.code,{children:`token`}),` (frontend credential).`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`All endpoints require an `,_jsx(_components.code,{children:`Authorization: Bearer \u003cAPI_KEY>`}),` header. API keys are issued in the `,_jsx(_components.a,{href:`https://avaturn.live/dashboard`,children:`dashboard`}),`.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`API keys must stay on the backend. Anyone with the key can act on your behalf — rotate immediately in the dashboard if compromised.`})}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.avaturn.live`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsx(_components.p,{children:`Endpoint-specific error codes are listed in each operation’s reference page. Common patterns:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`400 Bad Request`}),` — invalid payload (e.g. unknown `,_jsx(_components.code,{children:`voice_id`}),`, invalid `,_jsx(_components.code,{children:`render_model`}),` for the chosen avatar).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`401 Unauthorized`}),` — missing or revoked API key.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`410 Gone`}),` — `,_jsx(_components.code,{children:`avatar_id`}),` no longer exists.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`422 Unprocessable Content`}),` — missing required engine field (e.g. `,_jsx(_components.code,{children:`client_secret`}),` for `,_jsx(_components.code,{children:`openai-realtime`}),`).`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Reference","description":"Create, manage, and terminate avatar sessions from your backend.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"avaturn-1492efa9","siteName":"Avaturn.Live","title":"API Reference - Avaturn.Live","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-20T05:31:30.421Z","originalFileLocation":"api-reference/introduction.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, manage, and terminate avatar sessions from your backend.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Avaturn.Live\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - Avaturn.Live\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create, manage, and terminate avatar sessions from your backend.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Avaturn.Live\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.avaturn.live/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://avaturn-1492efa9.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=API+Reference\u0026amp;description=Create%2C+manage%2C+and+terminate+avatar+sessions+from+your+backend.\u0026amp;theme=ea7c6e14d76874fce2215a5e\u0026amp;signature=a09ab44acee02df6e1df12a96732dce58f5c77781ee02f2b4644fc723c78fe8a\">\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=\"API Reference - Avaturn.Live\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create, manage, and terminate avatar sessions from your backend.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://avaturn-1492efa9.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=API+Reference\u0026amp;description=Create%2C+manage%2C+and+terminate+avatar+sessions+from+your+backend.\u0026amp;theme=ea7c6e14d76874fce2215a5e\u0026amp;signature=a09ab44acee02df6e1df12a96732dce58f5c77781ee02f2b4644fc723c78fe8a\">\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/avaturn-1492efa9/FcHXCbxsBdoQ8sQ6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Avaturn.Live\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.avaturn.live/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.avaturn.live/#organization\",\"name\":\"Avaturn.Live\",\"url\":\"https://docs.avaturn.live\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/avaturn-1492efa9/dllyramte2Auj8Ns/logo/light.svg?fit=max\u0026auto=format\u0026n=dllyramte2Auj8Ns\u0026q=85\u0026s=a9bbc776013d1747117044b4e175b621\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.avaturn.live#website\",\"name\":\"Avaturn.Live\",\"url\":\"https://docs.avaturn.live\",\"publisher\":{\"@id\":\"https://docs.avaturn.live/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.avaturn.live/api-reference/introduction#webpage\",\"url\":\"https://docs.avaturn.live/api-reference/introduction\",\"name\":\"API Reference\",\"description\":\"Create, manage, and terminate avatar sessions from your backend.\",\"dateModified\":\"2026-05-20T05:31:30.421Z\",\"isPartOf\":{\"@id\":\"https://docs.avaturn.live#website\"},\"breadcrumb\":{\"@id\":\"https://docs.avaturn.live/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.avaturn.live/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Avaturn.Live\",\"item\":\"https://docs.avaturn.live\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.avaturn.live/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.avaturn.live/api-reference/introduction#article\",\"headline\":\"API Reference\",\"name\":\"API Reference\",\"description\":\"Create, manage, and terminate avatar sessions from your backend.\",\"url\":\"https://docs.avaturn.live/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.avaturn.live/api-reference/introduction#webpage\"},\"dateModified\":\"2026-05-20T05:31:30.421Z\",\"publisher\":{\"@id\":\"https://docs.avaturn.live/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.avaturn.live#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Avaturn.Live\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Avaturn.Live\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/introduction.md","siteName":"Avaturn.Live","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"API Reference","pages":[{"title":"Create Session","description":"Initiates a session.\n\n\u003cWarning>\n Call this endpoint from your backend.\n You must not expose your API Key in your frontend code.\n\u003c/Warning>\n\nUpon successful creation, the API returns a session token that can be safely used in Web SDK.\n\nThere are a few ways to process what a user says and what avatar says.\n\nIt's configured via the conversation engine. Supported types:\n\n- `openai-realtime` — Avaturn Live talks directly to OpenAI\n Realtime on your behalf.\n- `cartesia` — [Cartesia Line](https://docs.cartesia.ai/line/integrations/calls-api)\n- `external` — Avaturn Live opens a WebSocket to a URL you\n provide and exchanges raw audio plus segment events with it.\n The reference integration uses [Pipecat](https://docs.pipecat.ai);\n see the open-source `pipecat-avaturn-live-demo` repo for a\n working end-to-end example.\n- `text-echo` — legacy text-driven TTS playback.\n\nReach out to us if you want to integrate with something else.","deprecated":null,"version":null,"openapi":"https://api.avaturn.live/api/v1/openapi.json post /api/v1/sessions","href":"/api-reference/create-session"},{"title":"Create Speech Task","deprecated":null,"version":null,"openapi":"https://api.avaturn.live/api/v1/openapi.json post /api/v1/sessions/{id}/tasks","href":"/api-reference/create-speech-task"},{"title":"Terminate Session","deprecated":null,"version":null,"openapi":"https://api.avaturn.live/api/v1/openapi.json delete /api/v1/sessions/{id}","href":"/api-reference/terminate-session"}]}]}]},"basePath":"","title":"API Reference - Avaturn.Live","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":[],"chunks":[]}