Start an outbound call using a workspace agent. Requires ‘to_phone’ (required), optional ‘from_phone’, ‘record’ (defaults to true), and ‘parameters’ (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the ‘start_call’ scope.
Voqo number the call is made from, in E.164 format. Optional: when omitted, the number connected to this agent is used. The request fails with 404 if the agent has no connected number.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Voqo AI Docs","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/heffronai/KV6HO4h8tpBJL03E/logo/voqo-logo-light.png?fit=max\u0026auto=format\u0026n=KV6HO4h8tpBJL03E\u0026q=85\u0026s=72c46707b1122709932ac1a13e4a0de8","dark":"https://mintcdn.com/heffronai/KV6HO4h8tpBJL03E/logo/voqo-logo-dark.png?fit=max\u0026auto=format\u0026n=KV6HO4h8tpBJL03E\u0026q=85\u0026s=d8ec3ae058b1d3fbce43d525cdae9675"},"favicon":"https://mintcdn.com/heffronai/KV6HO4h8tpBJL03E/favicon.ico?fit=max\u0026auto=format\u0026n=KV6HO4h8tpBJL03E\u0026q=85\u0026s=74abab87f120bd18d2e2e1ef7829f1f5","api":{"openapi":["api-reference/openapi.json"],"mdx":{"auth":{"method":"bearer"},"server":"https://api.voqo.ai"}},"navbar":{"links":[{"href":"mailto:support@voqo.ai","label":"Support"}],"primary":{"type":"button","label":"Login","href":"https://platform.voqo.ai/auth/login"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/voqo-ai"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"WhatsApp Community","icon":{"style":"brands","name":"whatsapp"},"href":"https://chat.whatsapp.com/CHL5omlbYJH5vreq0SgtCu"},{"anchor":"Pricing","icon":"credit-card","href":"https://www.voqo.ai/pricing"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heffronai","hasAudioNarration":false,"actualSubdomain":"heffronai","customDomains":["docs.voqo.ai"],"gitSource":{"type":"github","owner":"heffron-ai","repo":"heffron-ai","deployBranch":"main","contentDirectory":"docs/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae58811f07e7eef79d41a41","collectionId":"b1dc3c71-be07-40a8-99ac-ac95925c5530","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae58811f07e7eef79d41a41"},"entitlements":{},"buildId":"6ae58811f07e7eef79d41a41","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Tutorials","count":87},{"language":"default","tag":"Run Your AI Agent","count":23},{"language":"default","tag":"Integrate Your Systems","count":22},{"language":"default","tag":"Scale with Automation","count":20},{"language":"default","tag":"Admin and Billing","count":7},{"language":"default","tag":"Start Here","count":7},{"language":"default","tag":"Troubleshooting","count":6},{"language":"default","tag":"Developer API","count":5},{"language":"default","tag":"API Reference","count":4},{"language":"default","tag":"Google Calendar","count":4}]},"assistantConfig":{},"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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"changelog-gate.css","content":"html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #changelog-filters,html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #content,html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #content-area,html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #page-context-menu,html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #page-title,html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #pagination,html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #sidebar,html.voqo-changelog-locked:not(.voqo-changelog-unlocked) #table-of-contents,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #changelog-filters,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #content,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #content-area,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #page-context-menu,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #page-title,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #pagination,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #sidebar,html[data-current-path^=\"/change-log\"]:not(.voqo-changelog-unlocked) #table-of-contents{visibility:hidden!important}#voqo-changelog-gate{position:fixed;top:4rem;right:0;bottom:0;left:0;z-index:40;display:flex;align-items:center;justify-content:center;padding:1.5rem;background:rgba(15,23,42,.08)}html.dark #voqo-changelog-gate{background:rgba(2,6,23,.55)}#voqo-changelog-gate-card{width:100%;max-width:26rem;padding:1.75rem 1.5rem 1.5rem;border:1px solid #d1d5db;border-radius:.75rem;background:#fff;box-shadow:0 16px 40px rgba(15,23,42,.12)}html.dark #voqo-changelog-gate-card{border-color:#334155;background:#0f172a;box-shadow:0 16px 40px rgba(0,0,0,.35)}#voqo-changelog-gate-title{margin:0 0 .5rem;color:#0f172a;font-size:1.25rem;font-weight:650;line-height:1.3}html.dark #voqo-changelog-gate-title{color:#f8fafc}#voqo-changelog-gate-copy{margin:0 0 1.25rem;color:#475569;font-size:.95rem;line-height:1.5}html.dark #voqo-changelog-gate-copy{color:#cbd5e1}#voqo-changelog-gate-form{display:flex;flex-direction:column;gap:.75rem}#voqo-changelog-gate-label{color:#334155;font-size:.85rem;font-weight:600}html.dark #voqo-changelog-gate-label{color:#e2e8f0}#voqo-changelog-gate-input{width:100%;padding:.7rem .8rem;border:1px solid #cbd5e1;border-radius:.5rem;background:#fff;color:#0f172a;font-size:.95rem}html.dark #voqo-changelog-gate-input{border-color:#475569;background:#1e293b;color:#f8fafc}#voqo-changelog-gate-input:focus{outline:2px solid #0d9373;outline-offset:1px}#voqo-changelog-gate-submit{width:100%;padding:.7rem .9rem;border:0;border-radius:.5rem;background:#0d9373;color:#fff;font-size:.95rem;font-weight:650;cursor:pointer}#voqo-changelog-gate-submit:hover{background:#0b7d62}#voqo-changelog-gate-error{display:none;margin:0;color:#b91c1c;font-size:.85rem}#voqo-changelog-gate-error.is-visible{display:block}html.dark #voqo-changelog-gate-error{color:#fca5a5}"}],"page":{"pagePath":"api-reference/endpoint/start-call","slug":"/api-reference/endpoint/start-call","pageMetadata":{"title":"Start Call","openapi":"POST /api/v1/workspaces/{workspace_id}/agents/{agent_id}/start-call","description":"Start an outbound call using a workspace agent. Requires 'to_phone' (required), optional 'from_phone', 'record' (defaults to true), and 'parameters' (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the 'start_call' scope.","href":"/api-reference/endpoint/start-call"},"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: \"Start an outbound call using a workspace agent. Requires ‘to_phone’ (required), optional ‘from_phone’, ‘record’ (defaults to true), and ‘parameters’ (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the ‘start_call’ scope.\"\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":"Start Call","openapi":"POST /api/v1/workspaces/{workspace_id}/agents/{agent_id}/start-call","description":"Start an outbound call using a workspace agent. Requires 'to_phone' (required), optional 'from_phone', 'record' (defaults to true), and 'parameters' (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the 'start_call' scope.","href":"/api-reference/endpoint/start-call"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/heffronai/7a0e932d9a99c673/changelog-gate.js"],"openApiReferenceData":{"operation":{"tags":["Workspaces"],"summary":"Start Call","description":"Start an outbound call using a workspace agent. Requires 'to_phone' (required), optional 'from_phone', 'record' (defaults to true), and 'parameters' (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the 'start_call' scope.","operationId":"start_call_api_v1_workspaces__workspace_id__agents__agent_id__start_call_post","security":["7a92251a-c1fc-41b3-8089-e3491b9da9b7"],"parameters":["e184f8ea-710c-4f01-bad1-9f6760e8f6a8","71492d12-3fa9-482d-a0b6-7345a4a1feba"],"requestBody":"987d74b5-6a30-4853-a690-34318abb4b3b","responses":{"201":"ead4c582-6a28-43b2-aaa3-6dc8ed765aa8","401":"efbc22e5-ff11-42fb-b63f-7ccdf85860fa","403":"35d7d2ee-1887-44d0-a90f-af89a0121e3e","404":"92cb53ec-4a16-48e4-878a-3f6b130d425f","422":"f3d19e05-6161-4d76-a3a9-a34e85788a3f","500":"c3b1ea35-0859-4eed-a411-f97c24a75c8b"},"method":"post","type":"path","servers":["29de11da-83e2-49f6-991f-726f154e71ab"],"path":"/api/v1/workspaces/{workspace_id}/agents/{agent_id}/start-call","baseUrlOptions":["https://api.voqo.ai"],"title":"Start Call","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e184f8ea-710c-4f01-bad1-9f6760e8f6a8":{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","title":"Workspace Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"71492d12-3fa9-482d-a0b6-7345a4a1feba":{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"to_phone":{"type":"string","title":"To Phone","description":"Phone number to call, in E.164 format (for example +61400000000). This is the person the AI agent rings.","isRequired":true,"uniqueKey":"to_phone","typeLabel":"string"},"from_phone":{"oneOf":[{"type":"string","title":"From Phone","description":"Voqo number the call is made from, in E.164 format. Optional: when omitted, the number connected to this agent is used. The request fails with 404 if the agent has no connected number.","uniqueKey":"from_phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"From Phone","description":"Voqo number the call is made from, in E.164 format. Optional: when omitted, the number connected to this agent is used. The request fails with 404 if the agent has no connected number.","uniqueKey":"from_phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_phone","typeLabel":"string | null"},"record":{"oneOf":[{"type":"boolean","title":"Record","description":"Record the call. Defaults to true. Recordings appear in Call Logs and in the post-call webhook.","default":true,"uniqueKey":"record.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Record","description":"Record the call. Defaults to true. Recordings appear in Call Logs and in the post-call webhook.","default":true,"uniqueKey":"record.oneOf.1","typeLabel":"null"}],"uniqueKey":"record","typeLabel":"boolean | null"},"parameters":{"oneOf":[{"type":"object","title":"Parameters","description":"Optional key-value pairs the agent can use during the call, such as the callee's name or the meeting time. Reference them in the agent prompt.","example":{"callee_name":"Sarah","callee_occupation":"Property Manager","meeting_time":"Tuesday 10am"},"additionalProperties":{"type":"string","uniqueKey":"parameters.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"parameters.oneOf.0","typeLabel":"Parameters · object"},{"type":"null","title":"Parameters","description":"Optional key-value pairs the agent can use during the call, such as the callee's name or the meeting time. Reference them in the agent prompt.","example":{"callee_name":"Sarah","callee_occupation":"Property Manager","meeting_time":"Tuesday 10am"},"uniqueKey":"parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"parameters","typeLabel":"Parameters · object | null"}},"type":"object","required":["to_phone"],"title":"CallWorkspaceCreateRequest","description":"Start an outbound call from a workspace agent. Only to_phone is required.","examples":[{"to_phone":"+61400000000","from_phone":"+61868656583","record":true,"parameters":{"callee_name":"Sarah","callee_occupation":"Property Manager","meeting_time":"Tuesday 10am"}}],"uniqueKey":"","typeLabel":"CallWorkspaceCreateRequest · object"},"examples":{"Example":{"title":"Example","value":{"to_phone":"+61400000000","from_phone":"+61868656583","record":true,"parameters":{"callee_name":"Sarah","callee_occupation":"Property Manager","meeting_time":"Tuesday 10am"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ead4c582-6a28-43b2-aaa3-6dc8ed765aa8":{"description":"Call started successfully","content":{"application/json":{"schema":{"properties":{"to_phone":{"type":"string","title":"To Phone","description":"To phone number","isRequired":true,"uniqueKey":"to_phone","typeLabel":"string"},"created_by":{"type":"string","title":"Created By","description":"Created by","isRequired":true,"uniqueKey":"created_by","typeLabel":"string"},"from_phone":{"oneOf":[{"type":"string","title":"From Phone","description":"From phone number","uniqueKey":"from_phone.oneOf.0","typeLabel":"string"},{"type":"null","title":"From Phone","description":"From phone number","uniqueKey":"from_phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_phone","typeLabel":"string | null"},"record":{"oneOf":[{"type":"boolean","title":"Record","description":"Whether to record the call","default":true,"uniqueKey":"record.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Record","description":"Whether to record the call","default":true,"uniqueKey":"record.oneOf.1","typeLabel":"null"}],"uniqueKey":"record","typeLabel":"boolean | null"},"status":{"type":"string","enum":["created","initiated","connected","inprogress","completed","failed"],"title":"CallStatus","description":"Call status","default":"created","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"oneOf":[{"type":"string","title":"Created At","description":"Call created at","format":"date-time","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At","description":"Call created at","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["to_phone","created_by"],"title":"CallCreateResponse","description":"Response schema for starting a call","examples":[{"created_at":"2021-07-22T00:00:00+00:00","created_by":"example@gmail.com","from_phone":"+61298063002","status":"created","to_phone":"+61451660338"}],"uniqueKey":"","typeLabel":"CallCreateResponse · object"},"examples":{"Example":{"title":"Example","value":{"created_at":"2021-07-22T00:00:00+00:00","created_by":"example@gmail.com","from_phone":"+61298063002","status":"created","to_phone":"+61451660338"}}},"exampleType":"generated"}},"exampleType":"generated"},"efbc22e5-ff11-42fb-b63f-7ccdf85860fa":{"description":"Invalid access token or API key","content":{"application/json":{"example":{"error":"Unauthorized"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"35d7d2ee-1887-44d0-a90f-af89a0121e3e":{"description":"API key lacks required scope or wrong workspace","content":{"application/json":{"examples":{"wrong_workspace":{"title":"wrong_workspace","value":{"error":"API key not authorized for this workspace"}},"missing_scope":{"title":"missing_scope","value":{"error":"API key lacks required scope: start_call"}}},"exampleType":"examples"}},"exampleType":"examples"},"92cb53ec-4a16-48e4-878a-3f6b130d425f":{"description":"Not Found","content":{"application/json":{"examples":{"number_not_found":{"title":"number_not_found","value":{"error":"Number not found in workspace"}},"workspace_not_found":{"title":"workspace_not_found","value":{"error":"Workspace not found"}},"agent_not_found":{"title":"agent_not_found","value":{"error":"Number not associated with an agent"}}},"exampleType":"examples"}},"exampleType":"examples"},"f3d19e05-6161-4d76-a3a9-a34e85788a3f":{"description":"Invalid request body","content":{"application/json":{"example":{"detail":[{"type":"missing","loc":["body","to_phone"],"msg":"Field required","input":{}}]},"examples":{"Example":{"title":"Example","value":{"detail":[{"type":"missing","loc":["body","to_phone"],"msg":"Field required","input":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"c3b1ea35-0859-4eed-a411-f97c24a75c8b":{"description":"Internal Server Error","content":{"application/json":{"example":{"error":"Internal server error. Please try again later."},"examples":{"Example":{"title":"Example","value":{"error":"Internal server error. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7a92251a-c1fc-41b3-8089-e3491b9da9b7":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"29de11da-83e2-49f6-991f-726f154e71ab":{"url":"https://api.voqo.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"heffronai","siteName":"Voqo AI Docs","title":"Start Call - Voqo AI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-28T02:07:09.696Z","originalFileLocation":"api-reference/endpoint/start-call.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=\"Start an outbound call using a workspace agent. Requires \u0026#x27;to_phone\u0026#x27; (required), optional \u0026#x27;from_phone\u0026#x27;, \u0026#x27;record\u0026#x27; (defaults to true), and \u0026#x27;parameters\u0026#x27; (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the \u0026#x27;start_call\u0026#x27; scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Voqo AI Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heffronai/nUrqhzo5_Y8lFKMj/_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/heffronai/nUrqhzo5_Y8lFKMj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heffronai/nUrqhzo5_Y8lFKMj/_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/heffronai/nUrqhzo5_Y8lFKMj/_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/heffronai/nUrqhzo5_Y8lFKMj/_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/heffronai/nUrqhzo5_Y8lFKMj/_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/heffronai/nUrqhzo5_Y8lFKMj/_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/heffronai/nUrqhzo5_Y8lFKMj/_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/heffronai/nUrqhzo5_Y8lFKMj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start Call - Voqo AI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start an outbound call using a workspace agent. Requires \u0026#x27;to_phone\u0026#x27; (required), optional \u0026#x27;from_phone\u0026#x27;, \u0026#x27;record\u0026#x27; (defaults to true), and \u0026#x27;parameters\u0026#x27; (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the \u0026#x27;start_call\u0026#x27; scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Voqo AI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voqo.ai/api-reference/endpoint/start-call\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heffronai.mintlify.app/_mintlify/api/og/v2?division=Developer+API\u0026amp;title=Start+Call\u0026amp;description=Start+an+outbound+call+using+a+workspace+agent.+Requires+%27to_phone%27+%28required%29%2C+optional+%27from_phone%27%2C+%27record%27+%28defaults+to+true%29%2C+and+%27parameters%27+%28key-value+\u0026amp;theme=26cbdd36cbef1e14020c097e\u0026amp;signature=7528877688b9d762bdc5bb8d1d445ed2fed2f203673a24d6aef8f6e0d4851d45\">\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=\"Start Call - Voqo AI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start an outbound call using a workspace agent. Requires \u0026#x27;to_phone\u0026#x27; (required), optional \u0026#x27;from_phone\u0026#x27;, \u0026#x27;record\u0026#x27; (defaults to true), and \u0026#x27;parameters\u0026#x27; (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the \u0026#x27;start_call\u0026#x27; scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heffronai.mintlify.app/_mintlify/api/og/v2?division=Developer+API\u0026amp;title=Start+Call\u0026amp;description=Start+an+outbound+call+using+a+workspace+agent.+Requires+%27to_phone%27+%28required%29%2C+optional+%27from_phone%27%2C+%27record%27+%28defaults+to+true%29%2C+and+%27parameters%27+%28key-value+\u0026amp;theme=26cbdd36cbef1e14020c097e\u0026amp;signature=7528877688b9d762bdc5bb8d1d445ed2fed2f203673a24d6aef8f6e0d4851d45\">\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/heffronai/nUrqhzo5_Y8lFKMj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Voqo AI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voqo.ai/api-reference/endpoint/start-call\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/start-call.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.voqo.ai/#organization\",\"name\":\"Voqo AI Docs\",\"url\":\"https://docs.voqo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heffronai/KV6HO4h8tpBJL03E/logo/voqo-logo-light.png?fit=max\u0026auto=format\u0026n=KV6HO4h8tpBJL03E\u0026q=85\u0026s=72c46707b1122709932ac1a13e4a0de8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voqo.ai#website\",\"name\":\"Voqo AI Docs\",\"url\":\"https://docs.voqo.ai\",\"publisher\":{\"@id\":\"https://docs.voqo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voqo.ai/api-reference/endpoint/start-call#webpage\",\"url\":\"https://docs.voqo.ai/api-reference/endpoint/start-call\",\"name\":\"Start Call\",\"description\":\"Start an outbound call using a workspace agent. Requires 'to_phone' (required), optional 'from_phone', 'record' (defaults to true), and 'parameters' (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the 'start_call' scope.\",\"dateModified\":\"2026-08-28T02:07:09.696Z\",\"isPartOf\":{\"@id\":\"https://docs.voqo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voqo.ai/api-reference/endpoint/start-call#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voqo.ai/api-reference/endpoint/start-call#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developer API\",\"item\":\"https://docs.voqo.ai/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start Call\",\"item\":\"https://docs.voqo.ai/api-reference/endpoint/start-call\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voqo.ai/api-reference/endpoint/start-call#apireference\",\"headline\":\"Start Call\",\"name\":\"Start Call\",\"description\":\"Start an outbound call using a workspace agent. Requires 'to_phone' (required), optional 'from_phone', 'record' (defaults to true), and 'parameters' (key-value pairs for call personalization). Supports both Clerk JWT (dashboard) and API key authentication. For API key auth, the key must have the 'start_call' scope.\",\"url\":\"https://docs.voqo.ai/api-reference/endpoint/start-call\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voqo.ai/api-reference/endpoint/start-call#webpage\"},\"dateModified\":\"2026-08-28T02:07:09.696Z\",\"publisher\":{\"@id\":\"https://docs.voqo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voqo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Voqo AI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Voqo AI Docs","nav":{"global":{"anchors":[{"anchor":"WhatsApp Community","icon":{"style":"brands","name":"whatsapp"},"href":"https://chat.whatsapp.com/CHL5omlbYJH5vreq0SgtCu"},{"anchor":"Pricing","icon":"credit-card","href":"https://www.voqo.ai/pricing"}]},"tabs":[{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Developer API","pages":[{"title":"API Reference","description":"Use Voqo API by domain: auth/admin, calling, campaigns, integrations, workflows, billing, developer tooling, and webhooks.","href":"/api-reference/introduction"},{"title":"Start Call","openapi":"POST /api/v1/workspaces/{workspace_id}/agents/{agent_id}/start-call","href":"/api-reference/endpoint/start-call"},{"title":"Pricing Model","openapi":"GET /api/v1/payment/pricing-model","description":null,"href":"/api-reference/endpoint/pricing-model"},{"title":"Public Recording and SMS Replies API","href":"/api-reference/public-recording-and-sms-replies"}]}]},{"tab":"Change Log","pages":[{"title":"Change Log","href":"/change-log/product-updates"}]}]},"basePath":"","title":"Start Call - Voqo AI Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}