{
"success": false,
"message": "Invalid API key"
}
{
"success": false,
"message": "script_id not found or does not belong to your team"
}
{
"success": false,
"message": "Team is at its concurrent call limit of 4",
"max_concurrent": 4
}
{
"success": false,
"message": "Internal server error"
}
Calls
Create web session
Mint a single-use session for a browser call placed from a page you host. Returns a
short-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media
edge directly; audio never passes through this API.
The session fixes the script, contact and destination at mint time. A page holding the
token cannot point it at a different script, and cannot start a second call with it.
The 429 on this endpoint is your team’s concurrent-call ceiling, which web calls share
with phone calls — distinct from the per-key rate limit, which also returns 429.
Your team's concurrent-call ceiling, shared between web and phone calls.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Voxworks","colors":{"primary":"#526FFB","light":"#7084FC","dark":"#2B5BFA"},"logo":{"light":"https://mintcdn.com/voxworks/KU6-tR1KJSXioHJ9/images/voxworks-docs-light.png?fit=max\u0026auto=format\u0026n=KU6-tR1KJSXioHJ9\u0026q=85\u0026s=9962f31765b8d57bab5a98a8f09fe8a0","dark":"https://mintcdn.com/voxworks/KU6-tR1KJSXioHJ9/images/voxworks-docs-dark.png?fit=max\u0026auto=format\u0026n=KU6-tR1KJSXioHJ9\u0026q=85\u0026s=9a7fd64f96a007a37c8d55c4fe42690a"},"favicon":"https://mintcdn.com/voxworks/xcnzfUN_HbwkLO8s/images/voxworks-favicon.webp?fit=max\u0026auto=format\u0026n=xcnzfUN_HbwkLO8s\u0026q=85\u0026s=21d53d71cd4ed143d2334591d79ecf03","api":{"playground":{"display":"interactive","proxy":true},"examples":{"languages":["curl","javascript","python"]}},"appearance":{"default":"system"},"background":{"color":{"light":"#FFFFFF","dark":"#0A0A0A"}},"navbar":{"links":[{"href":"https://voxworks.ai","label":"Home"},{"href":"https://voxworks.ai/contact","label":"Support"}],"primary":{"type":"button","label":"Login","href":"https://app.voxworks.ai"}},"fonts":{"family":"Geist"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"voxworks","hasAudioNarration":false,"actualSubdomain":"voxworks","customDomains":["docs.voxworks.ai"],"gitSource":{"type":"github","owner":"voxworks-ai","repo":"voxworks-docs","deployBranch":"develop","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af669e09cd661bf040ff5ee","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"Documentation","count":167},{"language":"default","tag":"Tools, Automations \u0026 Integrations","count":58},{"language":"default","tag":"Get Started \u0026 Build","count":48},{"language":"default","tag":"Surveys","count":37},{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Endpoints","count":29},{"language":"default","tag":"Calls, Contacts \u0026 Batches","count":28},{"language":"default","tag":"Account, Billing \u0026 Security","count":20},{"language":"default","tag":"Calls","count":17},{"language":"default","tag":"Numbers \u0026 Routing","count":13}]},"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":"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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--vox-brand-50: #f5f6ff;--vox-brand-100: #e8eafe;--vox-brand-200: #d0d5fe;--vox-brand-300: #bcc3fd;--vox-brand-400: #a4aefd;--vox-brand-500: #8b99fc;--vox-brand-600: #7084fc;--vox-brand-700: #526ffb;--vox-brand-800: #2b5bfa;--vox-brand-900: #072c8e;--vox-brand-950: #021754;--vox-blue-50: #effaff;--vox-blue-100: #daf2ff;--vox-blue-200: #beafff;--vox-blue-300: #91deff;--vox-blue-400: #5dc9fd;--vox-blue-500: #37adfa;--vox-blue-600: #2c96f0;--vox-blue-700: #1978dc;--vox-blue-800: #1b60b2;--vox-blue-900: #1c538c;--vox-blue-950: #163255;--vox-slate-50: #f8fafc;--vox-slate-100: #f1f5f9;--vox-slate-200: #e2e8f0;--vox-slate-300: #cbd5e1;--vox-slate-400: #94a3b8;--vox-slate-500: #64748b;--vox-slate-600: #475569;--vox-slate-700: #334155;--vox-slate-800: #1e293b;--vox-slate-900: #0f172a}::selection{background:rgb(82 111 251 / 18%)}#navbar img[src*=\"voxworks-docs\"]{height:40px!important;max-height:40px!important;width:auto!important}@media (max-width: 768px){#navbar img[src*=\"voxworks-docs\"]{height:34px!important;max-height:34px!important}}"}],"page":{"pagePath":"api-reference/calls/create-web-session","slug":"/api-reference/calls/create-web-session","pageMetadata":{"title":"Create web session","description":"Mint a single-use session for a browser call placed from a page you host. Returns a\nshort-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media\nedge directly; audio never passes through this API.\n\nThe session fixes the script, contact and destination at mint time. A page holding the\ntoken cannot point it at a different script, and cannot start a second call with it.\n\nThe `429` on this endpoint is your team's concurrent-call ceiling, which web calls share\nwith phone calls — distinct from the per-key rate limit, which also returns `429`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-web-session","href":"/api-reference/calls/create-web-session","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: \"Mint a single-use session for a browser call placed from a page you host. Returns a\\nshort-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media\\nedge directly; audio never passes through this API.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The session fixes the script, contact and destination at mint time. A page holding the\\ntoken cannot point it at a different script, and cannot start a second call with it.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"429\"\n }), \" on this endpoint is your team’s concurrent-call ceiling, which web calls share\\nwith phone calls — distinct from the per-key rate limit, which also returns \", _jsx(_components.code, {\n children: \"429\"\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 web session","description":"Mint a single-use session for a browser call placed from a page you host. Returns a\nshort-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media\nedge directly; audio never passes through this API.\n\nThe session fixes the script, contact and destination at mint time. A page holding the\ntoken cannot point it at a different script, and cannot start a second call with it.\n\nThe `429` on this endpoint is your team's concurrent-call ceiling, which web calls share\nwith phone calls — distinct from the per-key rate limit, which also returns `429`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-web-session","href":"/api-reference/calls/create-web-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Calls"],"summary":"Create web session","description":"Mint a single-use session for a browser call placed from a page you host. Returns a\nshort-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media\nedge directly; audio never passes through this API.\n\nThe session fixes the script, contact and destination at mint time. A page holding the\ntoken cannot point it at a different script, and cannot start a second call with it.\n\nThe `429` on this endpoint is your team's concurrent-call ceiling, which web calls share\nwith phone calls — distinct from the per-key rate limit, which also returns `429`.\n","operationId":"createWebSession","requestBody":"983cd004-14c3-40a6-afde-eb582bec0ab8","responses":{"201":"d8769d46-f61a-4847-b7d2-c93a5597c01b","400":"3f40ee8b-c89c-4a30-adc6-df9d8bb85468","401":"cc4c989a-4e46-4d5f-bedc-b08f99ceb72f","404":"0d1fd4b0-bc0c-4ac9-baad-092cc4be278d","429":"577a4a9b-685d-40ba-861a-d244237b2e99","500":"fbd95012-f3ae-472e-b4e7-d7cb20cdbce0"},"method":"post","type":"path","servers":["8a7fee6c-a48e-44d2-8b5d-99abb86bbfca"],"security":["509eff42-a462-4416-8950-ce7083c895d1"],"path":"/api/v1/create-web-session","baseUrlOptions":["https://api.voxworks.ai"],"title":"Create web session","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["script_id"],"properties":{"script_id":{"type":"string","description":"The script the call runs. Must belong to your team.","isRequired":true,"uniqueKey":"script_id","typeLabel":"string"},"contact_id":{"type":"string","description":"Attach the call to a known contact. Omit to use your team's shared web contact.","uniqueKey":"contact_id","typeLabel":"string"},"did":{"type":"string","description":"One of your team's numbers, used as the AI-side number identity on the call record. Omit for a browser-only call.","uniqueKey":"did","typeLabel":"string"},"participant_identity":{"type":"string","description":"A label for the visitor, carried through to the transcript.","uniqueKey":"participant_identity","typeLabel":"string"},"objects":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"objects.additionalProperties","typeLabel":"object"},"description":"Object data keyed by object type name, linked to the contact.","uniqueKey":"objects","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"script_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","participant_identity":"visitor-4821"},"examples":{"Example":{"title":"Example","value":{"script_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","participant_identity":"visitor-4821"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d8769d46-f61a-4847-b7d2-c93a5597c01b":{"description":"Session minted.","content":{"application/json":{"schema":{"type":"object","required":["success","session_id","session_token","expires_at","ws_url","sip_domain","sip_username","sip_password","target","headers"],"properties":{"success":{"type":"boolean","example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"session_id":{"type":"string","description":"Identifies this session. No call exists yet — the call is created when the visitor connects.","isRequired":true,"uniqueKey":"session_id","typeLabel":"string"},"session_token":{"type":"string","description":"Single-use token authorising this one call. Pass it to the browser client; it is already included in `headers`.","isRequired":true,"uniqueKey":"session_token","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","description":"When the token stops being redeemable. Roughly two minutes after minting.","isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"ws_url":{"type":"string","description":"Secure WebSocket URL to connect to. Read it from the response on every call rather than hardcoding it.","example":"wss://MEDIA_EDGE_HOST","isRequired":true,"uniqueKey":"ws_url","typeLabel":"string"},"sip_domain":{"type":"string","isRequired":true,"uniqueKey":"sip_domain","typeLabel":"string"},"sip_username":{"type":"string","isRequired":true,"uniqueKey":"sip_username","typeLabel":"string"},"sip_password":{"type":"string","description":"Connection bootstrap, not a credential. It grants no access on its own — the session token is what authorises the call.","isRequired":true,"uniqueKey":"sip_password","typeLabel":"string"},"target":{"type":"string","description":"SIP URI the browser dials.","example":"sip:web@MEDIA_EDGE_HOST","isRequired":true,"uniqueKey":"target","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"headers.additionalProperties","typeLabel":"string"},"description":"Call metadata to forward verbatim. Pass through unchanged; do not construct these yourself.","isRequired":true,"uniqueKey":"headers","typeLabel":"object"},"script_id":{"type":"string","uniqueKey":"script_id","typeLabel":"string"},"contact_id":{"type":"string","uniqueKey":"contact_id","typeLabel":"string"},"did":{"oneOf":[{"type":"string","uniqueKey":"did.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"did.oneOf.1","typeLabel":"null"}],"uniqueKey":"did","typeLabel":"string | null"},"max_concurrent":{"type":"integer","description":"Your team's concurrent-call ceiling, shared between web and phone calls.","uniqueKey":"max_concurrent","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"session_id":"\u003cstring>","session_token":"\u003cstring>","expires_at":"2023-11-07T05:31:56Z","ws_url":"wss://MEDIA_EDGE_HOST","sip_domain":"\u003cstring>","sip_username":"\u003cstring>","sip_password":"\u003cstring>","target":"sip:web@MEDIA_EDGE_HOST","headers":{},"script_id":"\u003cstring>","contact_id":"\u003cstring>","did":"\u003cstring>","max_concurrent":123}}},"exampleType":"generated"}},"exampleType":"generated"},"3f40ee8b-c89c-4a30-adc6-df9d8bb85468":{"description":"Missing or invalid request data.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"cc4c989a-4e46-4d5f-bedc-b08f99ceb72f":{"description":"Missing, malformed, or invalid authorization.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid":{"title":"invalid","value":{"success":false,"message":"Invalid API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"0d1fd4b0-bc0c-4ac9-baad-092cc4be278d":{"description":"The script or contact was not found, or does not belong to your team.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"script_id not found or does not belong to your team"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"script_id not found or does not belong to your team"}}},"exampleType":"examples"}},"exampleType":"examples"},"577a4a9b-685d-40ba-861a-d244237b2e99":{"description":"Your team is at its concurrent-call limit, or the API key hit its rate limit.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"max_concurrent":{"type":"integer","description":"Present when the limit reached was the concurrent-call ceiling.","uniqueKey":"max_concurrent","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Team is at its concurrent call limit of 4","max_concurrent":4},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Team is at its concurrent call limit of 4","max_concurrent":4}}},"exampleType":"examples"}},"exampleType":"examples"},"fbd95012-f3ae-472e-b4e7-d7cb20cdbce0":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"509eff42-a462-4416-8950-ce7083c895d1":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"8a7fee6c-a48e-44d2-8b5d-99abb86bbfca":{"url":"https://api.voxworks.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"voxworks","siteName":"Voxworks","title":"Create web session - Voxworks","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T18:53:23.832Z","originalFileLocation":"api-reference/calls/create-web-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=\"Mint a single-use session for a browser call placed from a page you host. Returns a short-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media edge directly; audio never passes through this API. The session fixes the script, contact and destination at mint time. A page holding the token cannot point it at a different script, and cannot start a second call with it. The 429 on this endpoint is your team\u0026#x27;s concurrent-call ceiling, which web calls share with phone calls — distinct from the per-key rate limit, which also returns 429.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Voxworks\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_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/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_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/voxworks/sDm7UkXPyZDrMcuF/_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/voxworks/sDm7UkXPyZDrMcuF/_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/voxworks/sDm7UkXPyZDrMcuF/_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/voxworks/sDm7UkXPyZDrMcuF/_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/voxworks/sDm7UkXPyZDrMcuF/_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/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create web session - Voxworks\">\u003cmeta data-mint-head property=\"og:description\" content=\"Mint a single-use session for a browser call placed from a page you host. Returns a short-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media edge directly; audio never passes through this API. The session fixes the script, contact and destination at mint time. A page holding the token cannot point it at a different script, and cannot start a second call with it. The 429 on this endpoint is your team\u0026#x27;s concurrent-call ceiling, which web calls share with phone calls — distinct from the per-key rate limit, which also returns 429.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Voxworks\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voxworks.ai/api-reference/calls/create-web-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://voxworks.mintlify.site/_mintlify/api/og/v2?division=Calls\u0026amp;title=Create+web+session\u0026amp;description=Mint+a+single-use+session+for+a+browser+call+placed+from+a+page+you+host.+Returns+a%0Ashort-lived+token+plus+the+SIP+bootstrap+the+browser+needs+to+reach+the+Voxw\u0026amp;theme=c3ce9d6b7615953069414f4f\u0026amp;signature=aeceebd87f6a523c3901ab5a630aa517707f5a018b8e0940e7c8436156c19dad\">\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 web session - Voxworks\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Mint a single-use session for a browser call placed from a page you host. Returns a short-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media edge directly; audio never passes through this API. The session fixes the script, contact and destination at mint time. A page holding the token cannot point it at a different script, and cannot start a second call with it. The 429 on this endpoint is your team\u0026#x27;s concurrent-call ceiling, which web calls share with phone calls — distinct from the per-key rate limit, which also returns 429.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://voxworks.mintlify.site/_mintlify/api/og/v2?division=Calls\u0026amp;title=Create+web+session\u0026amp;description=Mint+a+single-use+session+for+a+browser+call+placed+from+a+page+you+host.+Returns+a%0Ashort-lived+token+plus+the+SIP+bootstrap+the+browser+needs+to+reach+the+Voxw\u0026amp;theme=c3ce9d6b7615953069414f4f\u0026amp;signature=aeceebd87f6a523c3901ab5a630aa517707f5a018b8e0940e7c8436156c19dad\">\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/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Voxworks\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#526FFB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voxworks.ai/api-reference/calls/create-web-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/calls/create-web-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.voxworks.ai/#organization\",\"name\":\"Voxworks\",\"url\":\"https://docs.voxworks.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/voxworks/KU6-tR1KJSXioHJ9/images/voxworks-docs-light.png?fit=max\u0026auto=format\u0026n=KU6-tR1KJSXioHJ9\u0026q=85\u0026s=9962f31765b8d57bab5a98a8f09fe8a0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voxworks.ai#website\",\"name\":\"Voxworks\",\"url\":\"https://docs.voxworks.ai\",\"publisher\":{\"@id\":\"https://docs.voxworks.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session#webpage\",\"url\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session\",\"name\":\"Create web session\",\"description\":\"Mint a single-use session for a browser call placed from a page you host. Returns a short-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media edge directly; audio never passes through this API. The session fixes the script, contact and destination at mint time. A page holding the token cannot point it at a different script, and cannot start a second call with it. The 429 on this endpoint is your team's concurrent-call ceiling, which web calls share with phone calls — distinct from the per-key rate limit, which also returns 429.\",\"dateModified\":\"2026-10-14T18:53:23.832Z\",\"isPartOf\":{\"@id\":\"https://docs.voxworks.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.voxworks.ai/api-reference/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Calls\",\"item\":\"https://docs.voxworks.ai/api-reference/calls/create-phone-call\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create web session\",\"item\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session#apireference\",\"headline\":\"Create web session\",\"name\":\"Create web session\",\"description\":\"Mint a single-use session for a browser call placed from a page you host. Returns a short-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media edge directly; audio never passes through this API. The session fixes the script, contact and destination at mint time. A page holding the token cannot point it at a different script, and cannot start a second call with it. The 429 on this endpoint is your team's concurrent-call ceiling, which web calls share with phone calls — distinct from the per-key rate limit, which also returns 429.\",\"url\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voxworks.ai/api-reference/calls/create-web-session#webpage\"},\"dateModified\":\"2026-10-14T18:53:23.832Z\",\"publisher\":{\"@id\":\"https://docs.voxworks.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voxworks.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Voxworks\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Voxworks\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/calls/create-web-session.md","siteName":"Voxworks","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"Surveys","icon":"square-poll-vertical","pages":[{"title":"Surveys","href":"/surveys/overview"}]},{"tab":"MCP Connector","icon":"plug","pages":[{"title":"MCP Connector","href":"/mcp/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"API Basics","pages":[{"title":"API Overview","href":"/api-reference/overview"},{"title":"API Keys \u0026 Authentication","href":"/api-reference/authentication"},{"title":"API Quickstart","href":"/api-reference/quickstart"},{"title":"Embedded Web Calls","href":"/api-reference/embedded-web-calls"},{"title":"Rate Limits \u0026 Request Limits","href":"/api-reference/rate-limits"},{"title":"Receiving Webhooks from Voxworks","href":"/api-reference/receiving-webhooks"}]},{"group":"Endpoints","pages":[{"group":"Health","expanded":false,"pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/health","href":"/api-reference/health/health-check"}]},{"group":"Contacts","expanded":false,"pages":[{"title":"Create contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-contact","href":"/api-reference/contacts/create-contact"},{"title":"Get contact by phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-contact/{phone_number}","href":"/api-reference/contacts/get-contact-by-phone-number"}]},{"group":"Calls","expanded":false,"pages":[{"title":"Create phone call","description":"Create and schedule an outbound phone call. Contact details are upserted by phone number and optional object data is validated and linked.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-phone-call","href":"/api-reference/calls/create-phone-call"},{"title":"Create web session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-web-session","href":"/api-reference/calls/create-web-session"},{"title":"List calls","description":"List calls for your team with optional filters and cursor pagination.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Get call","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-call/{call_id}","href":"/api-reference/calls/get-call"},{"title":"Get call status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-call-status/{call_id}","href":"/api-reference/calls/get-call-status"},{"title":"Get call result","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-call-result/{call_id}","href":"/api-reference/calls/get-call-result"},{"title":"Cancel call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cancel-call/{call_id}","href":"/api-reference/calls/cancel-call"},{"title":"Reschedule call","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/reschedule-call/{call_id}","href":"/api-reference/calls/reschedule-call"},{"title":"Retry call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/retry-call/{call_id}","href":"/api-reference/calls/retry-call"}]},{"group":"Lists","expanded":false,"pages":[{"title":"List lists","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/lists","href":"/api-reference/lists/list-lists"},{"title":"Create list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/lists","href":"/api-reference/lists/create-list"},{"title":"Get list","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/lists/{list_id}","href":"/api-reference/lists/get-list"},{"title":"Edit list","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/lists/{list_id}","href":"/api-reference/lists/edit-list"},{"title":"Delete list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/lists/{list_id}","href":"/api-reference/lists/delete-list"},{"title":"Add existing contacts to list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/lists/{list_id}/contacts/existing","href":"/api-reference/lists/add-existing-contacts-to-list"},{"title":"Create or add contacts to list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/lists/{list_id}/contacts","href":"/api-reference/lists/create-or-add-contacts-to-list"},{"title":"Remove contacts from list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/lists/{list_id}/contacts","href":"/api-reference/lists/remove-contacts-from-list"}]},{"group":"Custom Variables","expanded":false,"pages":[{"title":"List object types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/object-types","href":"/api-reference/objects/list-object-types"},{"title":"Create object type","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/object-types","href":"/api-reference/objects/create-object-type"},{"title":"Get object type by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/object-types/{object_type_id}","href":"/api-reference/objects/get-object-type-by-id"},{"title":"Get object type by name","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/object-types/by-name/{type_name}","href":"/api-reference/objects/get-object-type-by-name"},{"title":"Create object","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-object","href":"/api-reference/objects/create-object"},{"title":"Upsert object","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/upsert-object","href":"/api-reference/objects/upsert-object"},{"title":"Delete object","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/delete-object/{object_id}","href":"/api-reference/objects/delete-object"},{"title":"Link contact to object","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/link-contact-to-object/{object_id}","href":"/api-reference/objects/link-contact-to-object"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Trigger automation webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/hooks/{token}","href":"/api-reference/webhooks/trigger-automation-webhook"}]}]}]},{"tab":"Updates","icon":"sparkles","pages":[{"title":"Updates","href":"/updates/overview"}]}]},"basePath":"","title":"Create web session - Voxworks","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}