Append the endpoint path shown in the reference. For example, GET /client becomes GET https://api.getkarta.ai/public/v1/client.Send JSON request bodies with Content-Type: application/json. For WebSocket connections, use the URL returned by Create WebSocket session.
Authentication
Authenticate each REST API request with your Karta API key:
Authorization: Bearer YOUR_KARTA_API_KEY
Keep your API key on your server. See authentication for details.
Try an endpoint
Click Try it on an endpoint page, enter your API key, fill in the request fields, and click Send. Requests go directly from your browser to the production API. Start with Get account to verify your key.
Playground requests affect your account. Calls and campaigns can consume credits, and cancelling a campaign stops future calls. Use test agents, campaigns, and phone numbers you control.
For calls and campaigns, set a unique X-Request-ID for each new action and preserve it with the same body when retrying.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Karta API","description":"Public API documentation for Karta","colors":{"primary":"#FF8256","light":"#FF8256","dark":"#FF8256"},"logo":{"light":"https://mintcdn.com/karta-ai/yiE-h5kOgKoDT-G-/logo/light.svg?fit=max\u0026auto=format\u0026n=yiE-h5kOgKoDT-G-\u0026q=85\u0026s=8df96a7426f71bb793915ed039564b6b","dark":"https://mintcdn.com/karta-ai/yiE-h5kOgKoDT-G-/logo/dark.svg?fit=max\u0026auto=format\u0026n=yiE-h5kOgKoDT-G-\u0026q=85\u0026s=18f9f0036a7fc5dc01d890b1e9bf2e16"},"favicon":"https://mintcdn.com/karta-ai/dUWfvinbcsvHjZta/favicon.ico?fit=max\u0026auto=format\u0026n=dUWfvinbcsvHjZta\u0026q=85\u0026s=e13cab584c9db65ef254944157ea4359","api":{"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"mailto:support@getkarta.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.getkarta.ai"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/getkarta"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"karta-ai","hasAudioNarration":false,"actualSubdomain":"karta-ai","customDomains":["docs.getkarta.ai"],"gitSource":{"type":"github","owner":"getkarta","repo":"karta-public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae04eb359d1c248245fb90a","clientVersion":"0.0.4138","searchFilterCounts":[{"language":"default","tag":"API reference","count":16},{"language":"default","tag":"Documentation","count":10},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Voice","count":4},{"language":"default","tag":"Agents","count":3},{"language":"default","tag":"Calls","count":3},{"language":"default","tag":"Campaigns","count":3},{"language":"default","tag":"Account","count":2},{"language":"default","tag":"Billing","count":2},{"language":"default","tag":"Webhooks","count":2}]},"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":false},"customCss":[],"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"Karta API reference","sidebarTitle":"Introduction","description":"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.","href":"/api-reference/overview"},"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: \"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.\"\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`,strong:`strong`,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:[_jsx(Heading,{level:`2`,id:`what-you-can-do`,children:`What you can do`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`List agents, retrieve voice agent settings, and search call logs.`}),`\n`,_jsx(_components.li,{children:`Create phone and web calls, and retrieve call details.`}),`\n`,_jsx(_components.li,{children:`List phone numbers and manage outbound campaigns.`}),`\n`,_jsx(_components.li,{children:`Create WebSocket sessions for voice conversations.`}),`\n`,_jsx(_components.li,{children:`View account pricing, credit balances, and transactions.`}),`\n`,_jsxs(_components.li,{children:[`Receive `,_jsx(_components.a,{href:`/api-reference/webhooks/call-events`,children:`call events`}),` at a configured webhook URL.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(_components.p,{children:`Use this base URL for REST API requests:`}),`\n`,_jsx(CodeBlock,{filename:``,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.getkarta.ai/public/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Append the endpoint path shown in the reference. For example, `,_jsx(_components.code,{children:`GET /client`}),` becomes `,_jsx(_components.code,{children:`GET https://api.getkarta.ai/public/v1/client`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Send JSON request bodies with `,_jsx(_components.code,{children:`Content-Type: application/json`}),`. For WebSocket connections, use the URL returned by `,_jsx(_components.a,{href:`/api-reference/realtime/create-websocket-session`,children:`Create WebSocket session`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`Authenticate each REST API request with your Karta API key:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer YOUR_KARTA_API_KEY`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Keep your API key on your server. See `,_jsx(_components.a,{href:`/authentication`,children:`authentication`}),` for details.`]}),`\n`,_jsx(Heading,{level:`2`,id:`try-an-endpoint`,children:`Try an endpoint`}),`\n`,_jsxs(_components.p,{children:[`Click `,_jsx(_components.strong,{children:`Try it`}),` on an endpoint page, enter your API key, fill in the request fields, and click `,_jsx(_components.strong,{children:`Send`}),`. Requests go directly from your browser to the production API. Start with `,_jsx(_components.strong,{children:`Get account`}),` to verify your key.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Playground requests affect your account. Calls and campaigns can consume credits, and cancelling a campaign stops future calls. Use test agents, campaigns, and phone numbers you control.`})}),`\n`,_jsxs(_components.p,{children:[`For calls and campaigns, set a unique `,_jsx(_components.code,{children:`X-Request-ID`}),` for each new action and preserve it with the same body when retrying.`]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/guides/phone-calls`,children:`Make a phone call`}),` or `,_jsx(_components.a,{href:`/guides/campaigns`,children:`run a campaign`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Review `,_jsx(_components.a,{href:`/errors`,children:`errors`}),` and `,_jsx(_components.a,{href:`/idempotency`,children:`idempotency`}),` before adding automatic retries.`]}),`\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":"Karta API reference","sidebarTitle":"Introduction","description":"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.","href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What you can do","slug":"what-you-can-do","depth":2,"children":[]},{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Try an endpoint","slug":"try-an-endpoint","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"karta-ai","siteName":"Karta API","title":"Karta API reference - Karta API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T05:07:13.387Z","originalFileLocation":"api-reference/overview.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=\"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Karta API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/karta-ai/uk0rRc4uKsjKwtaR/_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/karta-ai/uk0rRc4uKsjKwtaR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/karta-ai/uk0rRc4uKsjKwtaR/_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/karta-ai/uk0rRc4uKsjKwtaR/_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/karta-ai/uk0rRc4uKsjKwtaR/_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/karta-ai/uk0rRc4uKsjKwtaR/_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/karta-ai/uk0rRc4uKsjKwtaR/_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/karta-ai/uk0rRc4uKsjKwtaR/_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/karta-ai/uk0rRc4uKsjKwtaR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Karta API reference - Karta API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Karta API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getkarta.ai/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://karta-ai.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Karta+API+reference\u0026amp;description=Authentication%2C+base+URL%2C+and+endpoints+for+integrating+voice+calls%2C+campaigns%2C+WebSocket+sessions%2C+and+billing.\u0026amp;theme=1a84d298eeb1b9a7917fc4bf\u0026amp;signature=e7e514f725d80eebf96257f7ea86bc354fd210af20ceed05d84fb4f5257e00a3\">\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=\"Karta API reference - Karta API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://karta-ai.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Karta+API+reference\u0026amp;description=Authentication%2C+base+URL%2C+and+endpoints+for+integrating+voice+calls%2C+campaigns%2C+WebSocket+sessions%2C+and+billing.\u0026amp;theme=1a84d298eeb1b9a7917fc4bf\u0026amp;signature=e7e514f725d80eebf96257f7ea86bc354fd210af20ceed05d84fb4f5257e00a3\">\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/karta-ai/uk0rRc4uKsjKwtaR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Karta API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF8256\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getkarta.ai/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getkarta.ai/#organization\",\"name\":\"Karta API\",\"url\":\"https://docs.getkarta.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/karta-ai/yiE-h5kOgKoDT-G-/logo/light.svg?fit=max\u0026auto=format\u0026n=yiE-h5kOgKoDT-G-\u0026q=85\u0026s=8df96a7426f71bb793915ed039564b6b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getkarta.ai#website\",\"name\":\"Karta API\",\"url\":\"https://docs.getkarta.ai\",\"publisher\":{\"@id\":\"https://docs.getkarta.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getkarta.ai/api-reference/overview#webpage\",\"url\":\"https://docs.getkarta.ai/api-reference/overview\",\"name\":\"Karta API reference\",\"description\":\"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.\",\"dateModified\":\"2026-10-08T05:07:13.387Z\",\"isPartOf\":{\"@id\":\"https://docs.getkarta.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getkarta.ai/api-reference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getkarta.ai/api-reference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Karta API\",\"item\":\"https://docs.getkarta.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Karta API reference\",\"item\":\"https://docs.getkarta.ai/api-reference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.getkarta.ai/api-reference/overview#article\",\"headline\":\"Karta API reference\",\"name\":\"Karta API reference\",\"description\":\"Authentication, base URL, and endpoints for integrating voice calls, campaigns, WebSocket sessions, and billing.\",\"url\":\"https://docs.getkarta.ai/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getkarta.ai/api-reference/overview#webpage\"},\"dateModified\":\"2026-10-08T05:07:13.387Z\",\"publisher\":{\"@id\":\"https://docs.getkarta.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getkarta.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Karta API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Karta API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/overview.md","siteName":"Karta API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Get started","pages":[{"title":"Karta API reference","sidebarTitle":"Introduction","href":"/api-reference/overview"}]},{"group":"Account","pages":[{"openapi":"openapi.json GET /client","description":"Retrieve your account details and pricing.","title":"Get account","href":"/api-reference/account/get-account"}]},{"group":"Agents","pages":[{"openapi":"openapi.json GET /client/agents","title":"List agents","href":"/api-reference/agents/list-agents"},{"openapi":"openapi.json GET /voice/agents/{agent_id}","title":"Get voice agent details","href":"/api-reference/agents/get-voice-agent-details"},{"openapi":"openapi.json POST /agent/logs","title":"Get agent logs","href":"/api-reference/agents/list-agent-logs"}]},{"group":"Calls","pages":[{"openapi":"openapi.json POST /voice/calls/phone","title":"Create phone call","href":"/api-reference/calls/create-phone-call"},{"openapi":"openapi.json POST /voice/calls/web","title":"Create web call","href":"/api-reference/calls/create-web-call"},{"openapi":"openapi.json GET /voice/calls/{call_id}","title":"Get call","href":"/api-reference/calls/get-call"}]},{"group":"Phone numbers","pages":[{"openapi":"openapi.json GET /voice/phone-numbers","title":"List phone numbers","href":"/api-reference/phone-numbers/list-phone-numbers"}]},{"group":"Campaigns","pages":[{"openapi":"openapi.json POST /voice/campaigns","title":"Create campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"openapi.json GET /voice/campaigns","title":"List campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"openapi.json PATCH /voice/campaigns/{campaign_id}","title":"Cancel campaign","href":"/api-reference/campaigns/cancel-campaign"}]},{"group":"WebSocket sessions","pages":[{"openapi":"openapi.json POST /websocket/sessions","title":"Create WebSocket session","href":"/api-reference/realtime/create-websocket-session"}]},{"group":"Billing","pages":[{"openapi":"openapi.json GET /billing","title":"Get credit balance","href":"/api-reference/billing/get-credit-balance"},{"openapi":"openapi.json GET /billing/transactions","title":"List transactions","href":"/api-reference/billing/list-transactions"}]},{"group":"Webhooks","pages":[{"openapi":"openapi.json webhook callEvent","playground":"none","title":"Call events","href":"/api-reference/webhooks/call-events"}]}]}]},"basePath":"","title":"Karta API reference - Karta API","buildId":"dpl_715YoAgvjTGBDdo8RtXmHKM22b5p","deploymentId":"dpl_715YoAgvjTGBDdo8RtXmHKM22b5p","dynamics":[],"chunks":[]}