Use the BuildBetter REST API to integrate your applications and workflows with our data platform.
Welcome to the BuildBetter API documentation. The REST API is the supported path for new customer integrations, including creating recordings, attaching media, managing metadata definitions, and reading transcripts by public recording UUID.
The BuildBetter API is under active development and may change as we improve it. When we intend to make a breaking change, we will make a best-effort attempt to notify affected customers in advance, but advance notice is not guaranteed. Monitor these API docs and avoid relying on undocumented behavior.
The GraphQL API is being deprecated for customer integrations. Move new and existing integrations to the REST API. The GraphQL pages remain available as legacy migration reference while customers transition.
Whether you’re looking to build custom integrations, automate workflows, or extract specific insights, this guide will help you get started and make the most of our API.
Reference existing GraphQL integrations while migrating to REST.
Accessing Data Models
Explore the core data types: Calls (Interviews), Signals (Extractions), and Documents.
Recordings REST API
Create recordings, attach media, and fetch transcripts using public UUIDs.
Agent Chats SDK & API
Send your agent conversations and message feedback. Start with HTTP or explore the Node SDK preview.
Metadata REST API
Manage source namespaces and typed field definitions for API records.
Legacy GraphQL Examples
See legacy query examples for migration reference.
Error Handling & Best Practices
Learn how to handle API errors and follow best practices for efficient integration.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BuildBetter","colors":{"primary":"#5D5D5D","light":"#C7C7C7","dark":"#434343"},"logo":{"light":"https://mintcdn.com/buildbetter-9c5e0345/fQnmnuRFilg_Npja/logo/light.svg?fit=max\u0026auto=format\u0026n=fQnmnuRFilg_Npja\u0026q=85\u0026s=9558de55511d7953eaa7172e7413721d","dark":"https://mintcdn.com/buildbetter-9c5e0345/fQnmnuRFilg_Npja/logo/dark.svg?fit=max\u0026auto=format\u0026n=fQnmnuRFilg_Npja\u0026q=85\u0026s=a100a99a880b30dac6cf13660d775d6b"},"favicon":"https://mintcdn.com/buildbetter-9c5e0345/fQnmnuRFilg_Npja/favicon.svg?fit=max\u0026auto=format\u0026n=fQnmnuRFilg_Npja\u0026q=85\u0026s=b47637e2911e5a943cff751fb804937f","integrations":{"intercom":{"appId":"lmvj0uqx"}},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":""}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"buildbetter-9c5e0345","hasAudioNarration":false,"actualSubdomain":"buildbetter-9c5e0345","customDomains":["docs.buildbetter.ai"],"gitSource":{"type":"github","owner":"buildbetter-app","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae29ada965c86bf05e371ca","collectionId":"278cff7f-3372-4181-af05-dd304b7f5f2e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae29ada965c86bf05e371ca"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae29ada965c86bf05e371ca","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"Documentation","count":159},{"language":"en","tag":"Integrations","count":128},{"language":"en","tag":"Use Cases","count":35},{"language":"en","tag":"Call Recordings","count":23},{"language":"en","tag":"Support \u0026 Ticketing","count":14},{"language":"en","tag":"Inbox","count":14},{"language":"en","tag":"API","count":14},{"language":"en","tag":"Success","count":12},{"language":"en","tag":"FAQ","count":11},{"language":"en","tag":"Forms \u0026 Surveys","count":11}]},"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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"pages/api","slug":"/pages/api","pageMetadata":{"title":"BuildBetter API Documentation","description":"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.","href":"/pages/api/index"},"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: \"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.\"\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={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Welcome to the BuildBetter API documentation. The REST API is the supported path for new customer integrations, including creating recordings, attaching media, managing metadata definitions, and reading transcripts by public recording UUID.`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`The BuildBetter API is under active development and may change as we improve it. When we intend to make a breaking change, we will make a best-effort attempt to notify affected customers in advance, but advance notice is not guaranteed. Monitor these API docs and avoid relying on undocumented behavior.`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`The GraphQL API is being deprecated for customer integrations. Move new and existing integrations to the REST API. The GraphQL pages remain available as legacy migration reference while customers transition.`})}),`\n`,_jsx(_components.p,{children:`Whether you’re looking to build custom integrations, automate workflows, or extract specific insights, this guide will help you get started and make the most of our API.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting Started`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Authentication \u0026 Setup`,icon:`key`,href:`/pages/api/authentication`,children:_jsx(_components.p,{children:`Learn how to authenticate your REST API requests.`})}),_jsx(Card,{title:`Legacy GraphQL Queries`,icon:`code-branch`,href:`/pages/api/query-building`,children:_jsx(_components.p,{children:`Reference existing GraphQL integrations while migrating to REST.`})}),_jsx(Card,{title:`Accessing Data Models`,icon:`database`,href:`/pages/api/data-access`,children:_jsx(_components.p,{children:`Explore the core data types: Calls (Interviews), Signals (Extractions), and Documents.`})}),_jsx(Card,{title:`Recordings REST API`,icon:`file-audio`,href:`/pages/api/recordings`,children:_jsx(_components.p,{children:`Create recordings, attach media, and fetch transcripts using public UUIDs.`})}),_jsx(Card,{title:`Agent Chats SDK \u0026 API`,icon:`comments`,href:`/pages/api/agent-chats-sdk`,children:_jsx(_components.p,{children:`Send your agent conversations and message feedback. Start with HTTP or explore the Node SDK preview.`})}),_jsx(Card,{title:`Metadata REST API`,icon:`tags`,href:`/pages/api/metadata`,children:_jsx(_components.p,{children:`Manage source namespaces and typed field definitions for API records.`})}),_jsx(Card,{title:`Legacy GraphQL Examples`,icon:`file-code`,href:`/pages/api/graphql-examples`,children:_jsx(_components.p,{children:`See legacy query examples for migration reference.`})}),_jsx(Card,{title:`Error Handling \u0026 Best Practices`,icon:`shield-check`,href:`/pages/api/error-handling`,children:_jsx(_components.p,{children:`Learn how to handle API errors and follow best practices for efficient integration.`})})]})]})}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":"BuildBetter API Documentation","description":"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.","href":"/pages/api/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting Started","slug":"getting-started","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"buildbetter-9c5e0345","siteName":"BuildBetter","title":"BuildBetter API Documentation - BuildBetter","navMaps":{"firstHrefInVersion":{"latest":{"href":"/pages/api","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/pages/api","matchLevel":0}}},"lastModified":"2026-09-13T04:41:06.450Z","originalFileLocation":"pages/api/index.mdx","locale":"en"},"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=\"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BuildBetter\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"BuildBetter API Documentation - BuildBetter\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BuildBetter\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.buildbetter.ai/pages/api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://buildbetter-9c5e0345.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=BuildBetter+API+Documentation\u0026amp;description=Use+the+BuildBetter+REST+API+to+integrate+your+applications+and+workflows+with+our+data+platform.\u0026amp;theme=10b0796f28ca0ff355ca2cec\u0026amp;signature=8c66acc46de74296cbcd4b66a90568861e0128cf2100443445a1d7bdef4d60bf\">\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=\"BuildBetter API Documentation - BuildBetter\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://buildbetter-9c5e0345.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=BuildBetter+API+Documentation\u0026amp;description=Use+the+BuildBetter+REST+API+to+integrate+your+applications+and+workflows+with+our+data+platform.\u0026amp;theme=10b0796f28ca0ff355ca2cec\u0026amp;signature=8c66acc46de74296cbcd4b66a90568861e0128cf2100443445a1d7bdef4d60bf\">\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/buildbetter-9c5e0345/Oz0oFXVaXT2Sw_-U/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BuildBetter\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5D5D5D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.buildbetter.ai/pages/api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.buildbetter.ai/#organization\",\"name\":\"BuildBetter\",\"url\":\"https://docs.buildbetter.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/buildbetter-9c5e0345/fQnmnuRFilg_Npja/logo/light.svg?fit=max\u0026auto=format\u0026n=fQnmnuRFilg_Npja\u0026q=85\u0026s=9558de55511d7953eaa7172e7413721d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.buildbetter.ai#website\",\"name\":\"BuildBetter\",\"url\":\"https://docs.buildbetter.ai\",\"publisher\":{\"@id\":\"https://docs.buildbetter.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.buildbetter.ai/pages/api#webpage\",\"url\":\"https://docs.buildbetter.ai/pages/api\",\"name\":\"BuildBetter API Documentation\",\"description\":\"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.\",\"dateModified\":\"2026-09-13T04:41:06.450Z\",\"isPartOf\":{\"@id\":\"https://docs.buildbetter.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.buildbetter.ai/pages/api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.buildbetter.ai/pages/api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.buildbetter.ai/pages/api/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"BuildBetter API Documentation\",\"item\":\"https://docs.buildbetter.ai/pages/api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.buildbetter.ai/pages/api#article\",\"headline\":\"BuildBetter API Documentation\",\"name\":\"BuildBetter API Documentation\",\"description\":\"Use the BuildBetter REST API to integrate your applications and workflows with our data platform.\",\"url\":\"https://docs.buildbetter.ai/pages/api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.buildbetter.ai/pages/api#webpage\"},\"dateModified\":\"2026-09-13T04:41:06.450Z\",\"publisher\":{\"@id\":\"https://docs.buildbetter.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.buildbetter.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BuildBetter\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BuildBetter","nav":{"global":null,"languages":[{"language":"en","versions":[{"version":"latest","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/pages/Use Cases/quick-start/product-first-calls"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/pages/Integrations/integrations-overview"}]},{"tab":"FAQ","pages":[{"title":"FAQ","href":"/pages/FAQ"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Legal","pages":[{"title":"Legal","href":"/pages/Legal/privacy-policy"}]},{"tab":"Trust Portal","href":"https://trust.buildbetter.ai"},{"tab":"Affiliate","pages":[{"title":"Affiliate","href":"/pages/Affiliate"}]},{"tab":"Support","pages":[{"title":"Support","href":"/pages/Help/common-issues"}]},{"tab":"API","groups":[{"group":"Getting Started","pages":[{"title":"BuildBetter API Documentation","href":"/pages/api"},{"title":"Authentication \u0026 Endpoint Setup","description":"Learn how to authenticate your requests to the BuildBetter API.","href":"/pages/api/authentication"}]},{"group":"Legacy GraphQL API","pages":[{"title":"Legacy GraphQL Queries","href":"/pages/api/graphql-queries"},{"title":"Legacy GraphQL Examples","href":"/pages/api/graphql-examples"},{"title":"Legacy GraphQL Query Building","href":"/pages/api/query-building"},{"title":"Accessing Data Models","href":"/pages/api/data-access"}]},{"group":"REST API","pages":[{"title":"Recordings API","href":"/pages/api/recordings"},{"title":"Metadata API","href":"/pages/api/metadata"},{"title":"Agent Chats API","href":"/pages/api/agent-chats"},{"title":"Agent Chats SDK","href":"/pages/api/agent-chats-sdk"},{"title":"Feedback Ingestion API","href":"/pages/api/feedback-ingestion"},{"title":"Feedback Ingestion Examples","href":"/pages/api/feedback-examples"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/pages/api/webhooks"}]},{"group":"Reference","pages":[{"title":"Error Handling \u0026 Best Practices","href":"/pages/api/error-handling"}]}]},{"tab":"Local Recorder (BETA)","pages":[{"title":"Local Recorder (BETA)","href":"/pages/Local Recorder/overview"}]},{"tab":"ZeroShot (CLI)","pages":[{"title":"ZeroShot (CLI)","href":"/pages/ZeroShot/overview"}]}]}]}]},"basePath":"","title":"BuildBetter API Documentation - BuildBetter","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":[],"chunks":[]}