Welcome to the Kalimna API documentation. Our API allows you to programmatically interact with the Kalimna platform, enabling you to create and manage leads, schedule calls, and more.
Base URL
All API requests should be made to the following base URL:
https://app.kalimna.ai/api
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Kalimna","colors":{"primary":"#06df4b","light":"#06df4b","dark":"#65fe50"},"favicon":"https://kalimna.ai/images/favicon.png","logo":{"light":"https://mintcdn.com/kalimna/CllIMR4Q_OAFdPq2/resources/logo/light.png?fit=max\u0026auto=format\u0026n=CllIMR4Q_OAFdPq2\u0026q=85\u0026s=ddba3da65398e53202ffd217f82384b0","dark":"https://mintcdn.com/kalimna/CllIMR4Q_OAFdPq2/resources/logo/dark.png?fit=max\u0026auto=format\u0026n=CllIMR4Q_OAFdPq2\u0026q=85\u0026s=5beacc34ed49254437b7d82716aca790"},"api":{"mdx":{"server":"https://app.kalimna.ai/api/","auth":{"method":"bearer","name":null}}},"navbar":{"links":[{"label":"Home","href":"https://kalimna.ai"},{"label":"Support","href":"https://kalimna.ai/contact"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.kalimna.ai"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/kalimna"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kalimna","hasAudioNarration":false,"actualSubdomain":"kalimna","customDomains":["docs.kalimna.ai"],"gitSource":{"type":"github","owner":"hypez-dev","repo":"kalimnadocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92c09a637ddc8d8792dc3:success","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Platform Guide","count":44},{"language":"default","tag":"No-Code Automation","count":11},{"language":"default","tag":"AI Assistants Overview","count":9},{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"No-Code Automation platform","count":7},{"language":"default","tag":"Outbound Calls","count":6},{"language":"default","tag":"Phone Numbers","count":5},{"language":"default","tag":"AI Prompting \u0026 Conversation Design","count":4},{"language":"default","tag":"Inbound Calls","count":4},{"language":"default","tag":"Troubleshooting \u0026 FAQs","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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","icon":"book-open","description":"Welcome to the Kalimna.ai API","href":"/api-reference/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Welcome to the Kalimna.ai API\"\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={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Welcome to the Kalimna API documentation. Our API allows you to programmatically interact with the Kalimna platform, enabling you to create and manage leads, schedule calls, and more.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(_components.p,{children:`All API requests should be made to the following base URL:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://app.kalimna.ai/api`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}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":"Introduction","icon":"book-open","description":"Welcome to the Kalimna.ai API","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"kalimna","siteName":"Kalimna","title":"Introduction - Kalimna","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-08T08:06:25.350Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Welcome to the Kalimna.ai API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kalimna\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://kalimna.ai/images/favicon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://kalimna.ai/images/favicon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://kalimna.ai/images/favicon.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://kalimna.ai/images/favicon.png\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Kalimna\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Kalimna.ai API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kalimna\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kalimna.ai/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kalimna.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Introduction\u0026amp;description=Welcome+to+the+Kalimna.ai+API\u0026amp;theme=76711c893cebd32c5c6d2fa1\u0026amp;signature=aa9614e990fb710f3e0970751676b7e68442d8dbcbcc1976ec3dabde659a673f\">\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=\"Introduction - Kalimna\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Kalimna.ai API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kalimna.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Introduction\u0026amp;description=Welcome+to+the+Kalimna.ai+API\u0026amp;theme=76711c893cebd32c5c6d2fa1\u0026amp;signature=aa9614e990fb710f3e0970751676b7e68442d8dbcbcc1976ec3dabde659a673f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/kalimna/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kalimna\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#06df4b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kalimna.ai/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kalimna.ai/#organization\",\"name\":\"Kalimna\",\"url\":\"https://docs.kalimna.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kalimna/CllIMR4Q_OAFdPq2/resources/logo/light.png?fit=max\u0026auto=format\u0026n=CllIMR4Q_OAFdPq2\u0026q=85\u0026s=ddba3da65398e53202ffd217f82384b0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kalimna.ai#website\",\"name\":\"Kalimna\",\"url\":\"https://docs.kalimna.ai\",\"publisher\":{\"@id\":\"https://docs.kalimna.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kalimna.ai/api-reference/introduction#webpage\",\"url\":\"https://docs.kalimna.ai/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Kalimna.ai API\",\"dateModified\":\"2025-08-08T08:06:25.350Z\",\"isPartOf\":{\"@id\":\"https://docs.kalimna.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kalimna.ai/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kalimna.ai/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Kalimna\",\"item\":\"https://docs.kalimna.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.kalimna.ai/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.kalimna.ai/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Kalimna.ai API\",\"url\":\"https://docs.kalimna.ai/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kalimna.ai/api-reference/introduction#webpage\"},\"dateModified\":\"2025-08-08T08:06:25.350Z\",\"publisher\":{\"@id\":\"https://docs.kalimna.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kalimna.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kalimna\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Kalimna\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/introduction.md","siteName":"Kalimna","nav":{"global":null,"anchors":[{"anchor":"Platform Guide","icon":"book","pages":[{"title":"Platform Guide","href":"/introduction/how-it-works"}]},{"anchor":"No-Code Automation","icon":"wand-magic-sparkles","color":{"light":"#6c63ff","dark":"#6c63ff"},"pages":[{"title":"No-Code Automation","href":"/automation-platform/introduction"}]},{"anchor":"API Reference","icon":"code","color":{"light":"#1c51fc","dark":"#1c51fc"},"groups":[{"group":"API Reference","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"},{"title":"Authentication","icon":"key","description":"Learn how to authenticate your API requests","href":"/api-reference/authentication"},{"title":"Create lead","api":"POST /user/lead","icon":"user-plus","href":"/api-reference/leads/create"},{"title":"List campaigns","api":"GET /user/campaigns","icon":"list","href":"/api-reference/campaigns/index"}]}]}]},"basePath":"","title":"Introduction - Kalimna","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}