{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"HeyMilo AI Documentation","colors":{"primary":"#1976d2","light":"#42a5f5","dark":"#1565c0"},"logo":{"light":"https://mintcdn.com/heymilo/1qxCNW6j6jqz7IAZ/images/HeyMilo_Logo_Primary.svg?fit=max\u0026auto=format\u0026n=1qxCNW6j6jqz7IAZ\u0026q=85\u0026s=e66a830eafb646a025265c1f784731ee","dark":"https://mintcdn.com/heymilo/sD7bprECHmd4gxYn/images/HeyMilo_Logo_Full_White.svg?fit=max\u0026auto=format\u0026n=sD7bprECHmd4gxYn\u0026q=85\u0026s=e6f5fcf3c549c76a46269215055d5ee7"},"favicon":"https://mintcdn.com/heymilo/1qxCNW6j6jqz7IAZ/images/HeyMilo_Icon_Primary.png?fit=max\u0026auto=format\u0026n=1qxCNW6j6jqz7IAZ\u0026q=85\u0026s=2bc77c79483508c8925f10e5fc9b9531","navbar":{"links":[{"href":"mailto:hello@heymilo.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://admin.heymilo.ai"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/heymilo"}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"posthog":{"apiKey":"phc_oQCWs4B60yvLBlAhHWFtamuaBYWQkymhDWK6b3tLQNg","sessionRecording":false}},"navigation":{"global":{"anchors":[{"anchor":"HeyMilo AI","icon":"house","color":{"light":"#0052FF","dark":"#0052FF"},"href":"https://www.heymilo.ai/"},{"anchor":"HeyMilo Red","icon":"shield-check","color":{"light":"#D62828","dark":"#E63946"},"href":"https://heymilo.red/docs"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heymilo","hasAudioNarration":false,"actualSubdomain":"heymilo","customDomains":["docs.heymilo.ai"],"gitSource":{"type":"github","owner":"heymilo","repo":"pub-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf828516765f5140a18fdc","collectionId":"e9f1034e-eeb1-47c4-a3c9-9bc4d81ddca4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf828516765f5140a18fdc"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adf85ceb6ccf8efa60c690f","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":69},{"language":"default","tag":"Public API (v2)","count":67},{"language":"default","tag":"v2 API Reference","count":60},{"language":"default","tag":"Integrations","count":46},{"language":"default","tag":"Deep Dive","count":45},{"language":"default","tag":"Guides","count":21},{"language":"default","tag":"ATS guides","count":18},{"language":"default","tag":"Interviews","count":16},{"language":"default","tag":"Getting Started","count":14},{"language":"default","tag":"Settings \u0026 Admin","count":10}]},"assistantConfig":{},"hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"API Reference","description":"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.","keywords":["api","public api","v2 api","api reference","heymilo api","integrations","developer"],"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: \"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.\"\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`,ol:`ol`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`HeyMilo has two API versions. `,_jsx(_components.strong,{children:`Use v2 for all new integrations.`})]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`v2 API (recommended)`})}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`Legacy API (v1)`})})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Base URL`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://api.heymilo.ai/api/v2`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://api.heymilo.network/api`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Docs`})}),_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/api-reference/overview`,children:`v2 API Overview`}),` + `,_jsx(_components.a,{href:`/api-reference/interviews/get-full-interview-data`,children:`v2 API Reference`})]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/legacy-v1/documentation`,children:`Legacy API (v1)`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Status`})}),_jsx(_components.td,{children:`Current, full surface area`}),_jsx(_components.td,{children:`Deprecated, maintenance only`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`start-here-v2`,children:`Start here (v2)`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Read the `,_jsx(_components.a,{href:`/api-reference/overview`,children:`v2 API Overview`}),` for auth, response shapes, and migration notes from v1.`]}),`\n`,_jsxs(_components.li,{children:[`Browse endpoint docs in `,_jsx(_components.strong,{children:`v2 API Reference`}),` (generated from our OpenAPI spec).`]}),`\n`,_jsxs(_components.li,{children:[`Try a `,_jsx(_components.a,{href:`/api-reference/guides/voice-agent-video`,children:`quickstart guide`}),` if you want a full walkthrough.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`common-v2-endpoints`,children:`Common v2 endpoints`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`I want to…`}),_jsx(_components.th,{children:`Endpoint doc`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Get interview results (scorecard, transcript, etc.)`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/interviews/get-full-interview-data`,children:`Get full interview data`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`List interviewers`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/interviewers/list-interviewers`,children:`List interviewers`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Ingest a candidate`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/candidates/ingest-a-single-candidate`,children:`Ingest a single candidate`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Register a webhook`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/webhooks/register-a-webhook`,children:`Register a webhook`})})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`On v1 already?`}),` The `,_jsx(_components.a,{href:`/api-reference/legacy-v1/documentation`,children:`Legacy API (v1)`}),` docs are still available, but we recommend migrating to v2. See the `,_jsx(_components.a,{href:`/api-reference/overview#endpoint-mapping-legacy-%E2%86%92-v2`,children:`endpoint mapping table`}),` in the overview.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Reference","description":"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.","keywords":["api","public api","v2 api","api reference","heymilo api","integrations","developer"],"href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Start here (v2)","slug":"start-here-v2","depth":2,"children":[]},{"title":"Common v2 endpoints","slug":"common-v2-endpoints","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"heymilo","siteName":"HeyMilo AI Documentation","title":"API Reference - HeyMilo AI Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-10T12:47:18.400Z","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=\"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HeyMilo AI Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heymilo/WyW8Dy4eYqnJ2HYo/_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/heymilo/WyW8Dy4eYqnJ2HYo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heymilo/WyW8Dy4eYqnJ2HYo/_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/heymilo/WyW8Dy4eYqnJ2HYo/_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/heymilo/WyW8Dy4eYqnJ2HYo/_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/heymilo/WyW8Dy4eYqnJ2HYo/_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/heymilo/WyW8Dy4eYqnJ2HYo/_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/heymilo/WyW8Dy4eYqnJ2HYo/_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/heymilo/WyW8Dy4eYqnJ2HYo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - HeyMilo AI Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HeyMilo AI Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heymilo.ai/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heymilo.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+Reference\u0026amp;description=HeyMilo+Public+API+documentation.+Use+v2+%28api.heymilo.ai%29+for+all+new+integrations.\u0026amp;theme=93ff494a8b6eda6bf87beecd\u0026amp;signature=5ee6b933a50e6c89553f3cc7ac7e63e0a36202852525eaf37299f93ad0c1fa6f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API Reference - HeyMilo AI Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heymilo.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+Reference\u0026amp;description=HeyMilo+Public+API+documentation.+Use+v2+%28api.heymilo.ai%29+for+all+new+integrations.\u0026amp;theme=93ff494a8b6eda6bf87beecd\u0026amp;signature=5ee6b933a50e6c89553f3cc7ac7e63e0a36202852525eaf37299f93ad0c1fa6f\">\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/heymilo/WyW8Dy4eYqnJ2HYo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HeyMilo AI Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1976d2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heymilo.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.heymilo.ai/#organization\",\"name\":\"HeyMilo AI Documentation\",\"url\":\"https://docs.heymilo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heymilo/1qxCNW6j6jqz7IAZ/images/HeyMilo_Logo_Primary.svg?fit=max\u0026auto=format\u0026n=1qxCNW6j6jqz7IAZ\u0026q=85\u0026s=e66a830eafb646a025265c1f784731ee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heymilo.ai#website\",\"name\":\"HeyMilo AI Documentation\",\"url\":\"https://docs.heymilo.ai\",\"publisher\":{\"@id\":\"https://docs.heymilo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heymilo.ai/api-reference/introduction#webpage\",\"url\":\"https://docs.heymilo.ai/api-reference/introduction\",\"name\":\"API Reference\",\"description\":\"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.\",\"dateModified\":\"2026-09-10T12:47:18.400Z\",\"isPartOf\":{\"@id\":\"https://docs.heymilo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heymilo.ai/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heymilo.ai/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"HeyMilo AI Documentation\",\"item\":\"https://docs.heymilo.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.heymilo.ai/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.heymilo.ai/api-reference/introduction#article\",\"headline\":\"API Reference\",\"name\":\"API Reference\",\"description\":\"HeyMilo Public API documentation. Use v2 (api.heymilo.ai) for all new integrations.\",\"url\":\"https://docs.heymilo.ai/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heymilo.ai/api-reference/introduction#webpage\"},\"dateModified\":\"2026-09-10T12:47:18.400Z\",\"keywords\":\"api, public api, v2 api, api reference, heymilo api, integrations, developer\",\"publisher\":{\"@id\":\"https://docs.heymilo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heymilo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HeyMilo AI Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HeyMilo AI Documentation","nav":{"global":{"anchors":[{"anchor":"HeyMilo AI","icon":"house","color":{"light":"#0052FF","dark":"#0052FF"},"href":"https://www.heymilo.ai/"},{"anchor":"HeyMilo Red","icon":"shield-check","color":{"light":"#D62828","dark":"#E63946"},"href":"https://heymilo.red/docs"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/get-started/landing"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/ats-quickstarts"}]},{"tab":"API Reference","groups":[{"group":"Public API (v2)","icon":"globe","root":{"title":"API Reference","href":"/api-reference/introduction"},"expanded":true,"pages":[{"title":"v2 API Overview","description":"What's new in the HeyMilo v2 Public API — base URL, auth, response shapes, and migration from Legacy API (v1).","href":"/api-reference/overview"},{"title":"API \u0026 Integration FAQ","description":"Answers to common questions from teams building on the HeyMilo API: webhook signing, interview results, and candidate experience details that show up in API data.","href":"/api-reference/faq"},{"group":"v2 API Reference","pages":[{"group":"Health","pages":[{"title":"Health Check","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /health","href":"/api-reference/health/health-check"}]},{"group":"Interviewers","pages":[{"title":"List interviewers","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings","href":"/api-reference/interviewers/list-interviewers"},{"title":"Create an interviewer","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings","href":"/api-reference/interviewers/create-an-interviewer"},{"title":"List interviewer summaries","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings/list","href":"/api-reference/interviewers/list-interviewer-summaries"},{"title":"Get an interviewer","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings/{posting_id}","href":"/api-reference/interviewers/get-an-interviewer"},{"title":"Update an interviewer","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json patch /api/v2/postings/{posting_id}","href":"/api-reference/interviewers/update-an-interviewer"},{"title":"Get interviewer stats","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings/{posting_id}/stats","href":"/api-reference/interviewers/get-interviewer-stats"},{"title":"Update a workflow step's config","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json patch /api/v2/postings/{posting_id}/workflow/{step_id}","href":"/api-reference/interviewers/update-a-workflow-steps-config"},{"title":"Archive an interviewer","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/archive","href":"/api-reference/interviewers/archive-an-interviewer"},{"title":"Activate an interviewer","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/activate","href":"/api-reference/interviewers/activate-an-interviewer"},{"title":"Clone an interviewer","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/clone","href":"/api-reference/interviewers/clone-an-interviewer"}]},{"group":"Candidates","pages":[{"title":"List candidates for an interviewer","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings/{posting_id}/candidates","href":"/api-reference/candidates/list-candidates-for-an-interviewer"},{"title":"Ingest a single candidate","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/candidates","href":"/api-reference/candidates/ingest-a-single-candidate"},{"title":"Bulk ingest candidates","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/candidates/bulk","href":"/api-reference/candidates/bulk-ingest-candidates"},{"title":"Async ingest a single candidate","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/candidates/async","href":"/api-reference/candidates/async-ingest-a-single-candidate"},{"title":"Async bulk ingest candidates","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/candidates/bulk/async","href":"/api-reference/candidates/async-bulk-ingest-candidates"}]},{"group":"Interviews","pages":[{"title":"Get full interview data","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/interviews/{interview_id}/data","href":"/api-reference/interviews/get-full-interview-data"},{"title":"Get interview metadata","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/interviews/{interview_id}/metadata","href":"/api-reference/interviews/get-interview-metadata"},{"title":"Set interview metadata","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/interviews/{interview_id}/metadata","href":"/api-reference/interviews/set-interview-metadata"},{"title":"Delete interview metadata","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json delete /api/v2/interviews/{interview_id}/metadata","href":"/api-reference/interviews/delete-interview-metadata"}]},{"group":"Schema Discovery","pages":[{"title":"List agent types","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/schemas/agents","href":"/api-reference/schema-discovery/list-agent-types"},{"title":"List question types","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/schemas/question-types","href":"/api-reference/schema-discovery/list-question-types"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Register a webhook","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/webhooks","href":"/api-reference/webhooks/register-a-webhook"},{"title":"Get webhook details","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-webhook-details"},{"title":"Deactivate a webhook","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json delete /api/v2/webhooks/{webhook_id}","href":"/api-reference/webhooks/deactivate-a-webhook"}]},{"group":"Email Templates","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/email-templates","href":"/api-reference/email-templates/list-email-templates"},{"title":"Get an email template","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/email-templates/{template_id}","href":"/api-reference/email-templates/get-an-email-template"}]},{"group":"Email Template Groups","pages":[{"title":"List email template groups","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/email-template-groups","href":"/api-reference/email-template-groups/list-email-template-groups"},{"title":"Get an email template group","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/email-template-groups/{group_id}","href":"/api-reference/email-template-groups/get-an-email-template-group"}]},{"group":"Design Templates","pages":[{"title":"List design templates","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/design-templates","href":"/api-reference/design-templates/list-design-templates"},{"title":"Get a design template","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/design-templates/{template_id}","href":"/api-reference/design-templates/get-a-design-template"}]},{"group":"Design Template Groups","pages":[{"title":"List design template groups","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/design-template-groups","href":"/api-reference/design-template-groups/list-design-template-groups"},{"title":"Get a design template group","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/design-template-groups/{group_id}","href":"/api-reference/design-template-groups/get-a-design-template-group"}]},{"group":"Interview Templates","pages":[{"title":"List interview templates","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/interview-templates","href":"/api-reference/interview-templates/list-interview-templates"},{"title":"Get an interview template","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/interview-templates/{template_id}","href":"/api-reference/interview-templates/get-an-interview-template"}]},{"group":"Domains","pages":[{"title":"List custom domains","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/domains","href":"/api-reference/domains/list-custom-domains"},{"title":"Get a custom domain","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/domains/{config_id}","href":"/api-reference/domains/get-a-custom-domain"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/voices","href":"/api-reference/voices/list-voices"},{"title":"Get voice audio preview","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/voices/{voice_id}/preview","href":"/api-reference/voices/get-voice-audio-preview"},{"title":"Get a voice","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/voices/{voice_id}","href":"/api-reference/voices/get-a-voice"}]},{"group":"Phone Numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Get a phone number","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/phone-numbers/{config_id}","href":"/api-reference/phone-numbers/get-a-phone-number"}]},{"group":"Sender Emails","pages":[{"title":"List sender emails","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/sender-emails","href":"/api-reference/sender-emails/list-sender-emails"},{"title":"Get a sender email","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/sender-emails/{sender_email_id}","href":"/api-reference/sender-emails/get-a-sender-email"}]},{"group":"Questions","pages":[{"title":"List questions","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings/{posting_id}/questions","href":"/api-reference/questions/list-questions"},{"title":"Create a question","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/questions","href":"/api-reference/questions/create-a-question"},{"title":"Retrieve a question","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings/{posting_id}/questions/{question_id}","href":"/api-reference/questions/retrieve-a-question"},{"title":"Delete a question","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json delete /api/v2/postings/{posting_id}/questions/{question_id}","href":"/api-reference/questions/delete-a-question"},{"title":"Update a question","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json patch /api/v2/postings/{posting_id}/questions/{question_id}","href":"/api-reference/questions/update-a-question"},{"title":"Reorder questions","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/questions/reorder","href":"/api-reference/questions/reorder-questions"}]},{"group":"Workspaces","pages":[{"title":"List workspaces accessible to the caller","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/workspaces","href":"/api-reference/workspaces/list-workspaces-accessible-to-the-caller"}]},{"group":"ATS","pages":[{"title":"Resolve a candidate in the ATS","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/ats/candidates/resolve","href":"/api-reference/ats/resolve-a-candidate-in-the-ats"},{"title":"Push a candidate to the ATS","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/ats/candidates/push","href":"/api-reference/ats/push-a-candidate-to-the-ats"},{"title":"Get push status","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/ats/candidates/push/{item_id}","href":"/api-reference/ats/get-push-status"},{"title":"List ATS connections","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/ats/connections","href":"/api-reference/ats/list-ats-connections"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/teams","href":"/api-reference/teams/list-teams"},{"title":"List an interviewer's teams","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json get /api/v2/postings/{posting_id}/teams","href":"/api-reference/teams/list-an-interviewers-teams"},{"title":"Assign an interviewer to teams","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json post /api/v2/postings/{posting_id}/teams","href":"/api-reference/teams/assign-an-interviewer-to-teams"},{"title":"Unassign an interviewer from a team","deprecated":null,"version":null,"openapi":"https://api.heymilo.ai/openapi.json delete /api/v2/postings/{posting_id}/teams/{team_id}","href":"/api-reference/teams/unassign-an-interviewer-from-a-team"}]}]},{"group":"Guides","pages":[{"title":null,"description":null,"href":"/api-reference/guides/voice-agent-video"},{"title":null,"description":null,"href":"/api-reference/guides/sms-to-voice-agent"},{"title":null,"description":null,"href":"/api-reference/guides/resume-to-video-agent"},{"title":null,"description":null,"href":"/api-reference/guides/resume-optional-to-voice-agent"}]},{"title":"API Key Usage","description":"Monitor API key usage in the HeyMilo dashboard — track integration activity and troubleshoot issues.","href":"/api-reference/api-key-usage"}]},{"group":"Legacy API (v1)","icon":"archive","root":{"title":"Legacy API (v1)","href":"/api-reference/legacy-v1/documentation"},"pages":[]},{"group":"MCP Server","icon":"project-diagram","root":{"title":"MCP Server","href":"/api-reference/mcp/getting-started"},"pages":[]},{"group":"Webhooks","icon":"broadcast-tower","root":{"title":"Webhooks","href":"/api-reference/webhooks/landing"},"expanded":true,"pages":[{"title":"Webhook Configuration","href":"/api-reference/webhooks/configuration"},{"title":"Webhook Configuration","href":"/api-reference/webhooks/webhook-documentation"}]}]},{"tab":"Deep Dive","pages":[{"title":"Deep Dive","href":"/deep-dive/dashboard"}]}]},"title":"API Reference - HeyMilo AI Documentation","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":[],"chunks":[]}