source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by
Listen to this pageabout 6 min
This page is part of an AI coding agent skill and is written for agents, not humans. For the human-readable Base44 docs, see the developer documentation.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Base44 Support Documentation","colors":{"primary":"#FF6A00","light":"#FF8E5D","dark":"#FF6A00"},"logo":{"light":"https://mintcdn.com/base44/jhCpOaGylNweq32m/logo/new-brand-light.svg?fit=max\u0026auto=format\u0026n=jhCpOaGylNweq32m\u0026q=85\u0026s=7724705143e6cfece3b0a237be2a6890","dark":"https://mintcdn.com/base44/jhCpOaGylNweq32m/logo/new-brand-dark.svg?fit=max\u0026auto=format\u0026n=jhCpOaGylNweq32m\u0026q=85\u0026s=6c3ad8a8d1ae8299c119d554dc371843","href":"/"},"favicon":"https://mintcdn.com/base44/XkAHbvyG1CwOBCSP/images/base44-favicon.svg?fit=max\u0026auto=format\u0026n=XkAHbvyG1CwOBCSP\u0026q=85\u0026s=2a7fda75e5497e8b44f47f01bb3aa807","api":{"playground":{}},"background":{"color":{"light":"#FAF9F7","dark":"#1E1E24"}},"navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/changelog/product","label":"Changelog"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"footer":{"socials":{"twitter":"https://x.com/base44","discord":"https://discord.com/invite/ThpYPZpVts","linkedin":"https://www.linkedin.com/company/base44"}},"seo":{"metatags":{"canonical":"https://docs.base44.com","og:image":"https://docs.base44.com/images/base44-docs-og.png","og:image:width":"2400","og:image:height":"1260","twitter:image":"https://docs.base44.com/images/base44-docs-og.png","twitter:card":"summary_large_image"},"indexing":"all"},"integrations":{"mixpanel":{"projectToken":"cc6e9e106e4b833fc3a3819c11b74138"}},"contextual":{"options":["copy","view","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"pt-BR","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/pt-BR/changelog/product","label":"Registro de alterações"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"pt-BR"},{"language":"es","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/es/changelog/product","label":"Registro de cambios"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"es"},{"language":"he","hidden":true,"navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/he/changelog/product","label":"יומן שינויים"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"he"},{"language":"ja","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/ja/changelog/product","label":"変更履歴"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"ja"},{"language":"de","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/de/changelog/product","label":"Änderungsprotokoll"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"de"},{"language":"fr","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/fr/changelog/product","label":"Notes de version"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"fr"},{"language":"it","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/it/changelog/product","label":"Registro modifiche"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"href":"it"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"base44","hasAudioNarration":true,"actualSubdomain":"base44","customDomains":["docs.base44.com"],"gitSource":{"type":"github","owner":"base44-dev","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae9d3f0382c567ac45689f4","collectionId":"3d07f2ab-2af4-4df5-8999-bd77b47e8cec","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9d3f0382c567ac45689f4"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae9d3f0382c567ac45689f4","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"en","tag":"Developers","count":819},{"language":"en","tag":"APIs","count":581},{"language":"en","tag":"Apps API (Beta)","count":453},{"language":"de","tag":"Entwickler","count":139},{"language":"es","tag":"Desarrolladores","count":139},{"language":"fr","tag":"Développeurs","count":139},{"language":"he","tag":"מפתחים","count":139},{"language":"it","tag":"Sviluppatori","count":139},{"language":"ja","tag":"開発者","count":139},{"language":"pt-BR","tag":"Desenvolvedores","count":139},{"language":"en","tag":"API Reference","count":115},{"language":"en","tag":"Apps","count":107},{"language":"en","tag":"Skills","count":93},{"language":"en","tag":"Google Ads","count":90},{"language":"de","tag":"Apps","count":76},{"language":"es","tag":"Aplicaciones","count":76},{"language":"fr","tag":"Applications","count":76},{"language":"it","tag":"App","count":76},{"language":"ja","tag":"アプリ","count":76},{"language":"pt-BR","tag":"Apps","count":76},{"language":"en","tag":"Workspace API (Beta)","count":75},{"language":"he","tag":"אפליקציות","count":75},{"language":"en","tag":"CLI","count":59},{"language":"de","tag":"CLI","count":59},{"language":"es","tag":"CLI","count":59},{"language":"fr","tag":"CLI","count":59},{"language":"he","tag":"CLI","count":59},{"language":"it","tag":"CLI","count":59},{"language":"ja","tag":"CLI","count":59},{"language":"pt-BR","tag":"CLI","count":59},{"language":"en","tag":"Commands","count":57},{"language":"de","tag":"Commands","count":57},{"language":"es","tag":"Commands","count":57},{"language":"fr","tag":"Commands","count":57},{"language":"he","tag":"Commands","count":57},{"language":"it","tag":"Commands","count":57},{"language":"ja","tag":"Commands","count":57},{"language":"pt-BR","tag":"Commands","count":57},{"language":"de","tag":"App erstellen","count":45},{"language":"es","tag":"Creando tu app","count":45},{"language":"fr","tag":"Créer votre app","count":45},{"language":"he","tag":"בניית האפליקציה","count":45},{"language":"it","tag":"Creare la tua app","count":45},{"language":"ja","tag":"アプリの構築","count":45},{"language":"pt-BR","tag":"Criando seu app","count":45},{"language":"de","tag":"Backend (Beta)","count":42},{"language":"es","tag":"Backend (Beta)","count":42},{"language":"fr","tag":"Backend (Beta)","count":42},{"language":"he","tag":"Backend (בטא)","count":42},{"language":"it","tag":"Backend (Beta)","count":42},{"language":"ja","tag":"バックエンド (Beta)","count":42},{"language":"pt-BR","tag":"Backend (Beta)","count":42},{"language":"de","tag":"Konto \u0026 Abrechnung","count":31},{"language":"es","tag":"Cuenta y facturación","count":31},{"language":"fr","tag":"Compte et facturation","count":31},{"language":"he","tag":"חשבון וחיוב","count":31},{"language":"it","tag":"Account e fatturazione","count":31},{"language":"ja","tag":"アカウントと請求","count":31},{"language":"pt-BR","tag":"Conta e faturamento","count":31},{"language":"de","tag":"SDKs","count":30},{"language":"es","tag":"SDKs","count":30},{"language":"fr","tag":"SDKs","count":30},{"language":"he","tag":"SDKs","count":30},{"language":"it","tag":"SDKs","count":30},{"language":"ja","tag":"SDKs","count":30},{"language":"pt-BR","tag":"SDKs","count":30},{"language":"de","tag":"App SDK","count":23},{"language":"es","tag":"App SDK","count":23},{"language":"fr","tag":"App SDK","count":23},{"language":"he","tag":"App SDK","count":23},{"language":"it","tag":"App SDK","count":23},{"language":"ja","tag":"App SDK","count":23},{"language":"pt-BR","tag":"App SDK","count":23},{"language":"de","tag":"Unternehmen","count":21},{"language":"es","tag":"Empresas","count":21},{"language":"fr","tag":"Entreprise","count":21},{"language":"he","tag":"ארגונים","count":21},{"language":"it","tag":"Aziende","count":21},{"language":"ja","tag":"エンタープライズ","count":21},{"language":"pt-BR","tag":"Empresas","count":21},{"language":"default","tag":"Developers","count":2},{"language":"default","tag":"APIs","count":2},{"language":"default","tag":"Audit Logs API","count":2},{"language":"default","tag":"API Reference","count":2},{"language":"default","tag":"audit-logs","count":2}],"searchSettings":{"showContentSnippets":true,"maxResults":10}},"assistantConfig":{"enableStarterQuestions":true},"basePath":"","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":"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}],"starterQuestions":[{"_id":"68f8934ac32e3459832881b0","deploymentId":"6792c6d6e85c02040dc386df","questionText":"Which plans come with a free domain?","status":"active","generatedBy":"manual","createdAt":"2025-10-22T08:18:18.293Z","updatedAt":"2025-10-22T08:18:18.293Z","__v":0},{"_id":"68f892c4c32e345983287064","deploymentId":"6792c6d6e85c02040dc386df","questionText":"How are credits used?","status":"active","generatedBy":"manual","createdAt":"2025-10-22T08:16:04.700Z","updatedAt":"2025-10-22T08:16:24.261Z","__v":0},{"_id":"68f892aec32e345983286ddf","deploymentId":"6792c6d6e85c02040dc386df","questionText":"How do I use Discuss mode?","status":"active","generatedBy":"manual","createdAt":"2025-10-22T08:15:42.469Z","updatedAt":"2025-10-22T08:15:42.469Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","href":"/_mintlify/custom/base44/07406dc4820eb06f/custom.css"}],"page":{"pagePath":"developers/skills/base44-platform-actors/references/mobile","slug":"/developers/skills/base44-platform-actors/references/mobile","pageMetadata":{"title":"Base44 actors: Realtime actors (mobile apps)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-actors/references/mobile","hidden":true},"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: \"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by\"\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`,p:`p`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[`This page is part of an AI coding agent skill and is written for agents, not humans. For the human-readable Base44 docs, see the `,_jsx(_components.a,{href:`/developers`,children:`developer documentation`}),`.`]})}),`\n`,_jsx(Heading,{level:`1`,id:`base44-actors-realtime-actors-mobile-apps`,children:`Base44 actors: Realtime actors (mobile apps)`}),`\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":"Base44 actors: Realtime actors (mobile apps)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-actors/references/mobile","hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base44 actors: Realtime actors (mobile apps)","slug":"base44-actors-realtime-actors-mobile-apps","depth":1,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/base44/ca59cb34fe66af72/custom-analytics.js","/_mintlify/custom/base44/878f3d61142901ae/changelog-display.js","/_mintlify/custom/base44/655d636252386031/cta-cards.js"],"narration":{"path":"developers/skills/base44-platform-actors/references/mobile","locale":"en","estimatedDurationSec":380},"subdomain":"base44","siteName":"Base44 Support Documentation","title":"Base44 actors: Realtime actors (mobile apps) - Base44 Support Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T12:16:19.447Z","originalFileLocation":"developers/skills/base44-platform-actors/references/mobile.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=\"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by\">\u003cmeta data-mint-head name=\"application-name\" content=\"Base44 Support 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/base44/nuCdY9ZGKAmI8mvz/_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/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/base44/nuCdY9ZGKAmI8mvz/_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/base44/nuCdY9ZGKAmI8mvz/_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/base44/nuCdY9ZGKAmI8mvz/_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/base44/nuCdY9ZGKAmI8mvz/_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/base44/nuCdY9ZGKAmI8mvz/_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/base44/nuCdY9ZGKAmI8mvz/_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/base44/nuCdY9ZGKAmI8mvz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Base44 actors: Realtime actors (mobile apps) - Base44 Support Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Base44 Support Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.base44.com/images/base44-docs-og.png\">\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=\"Base44 actors: Realtime actors (mobile apps) - Base44 Support Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.base44.com/images/base44-docs-og.png\">\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/base44/nuCdY9ZGKAmI8mvz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Base44 Support Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6A00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/skills/base44-platform-actors/references/mobile.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.base44.com/#organization\",\"name\":\"Base44 Support Documentation\",\"url\":\"https://docs.base44.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/base44/jhCpOaGylNweq32m/logo/new-brand-light.svg?fit=max\u0026auto=format\u0026n=jhCpOaGylNweq32m\u0026q=85\u0026s=7724705143e6cfece3b0a237be2a6890\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.base44.com#website\",\"name\":\"Base44 Support Documentation\",\"url\":\"https://docs.base44.com\",\"publisher\":{\"@id\":\"https://docs.base44.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile#webpage\",\"url\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile\",\"name\":\"Base44 actors: Realtime actors (mobile apps)\",\"description\":\"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by\",\"dateModified\":\"2026-11-03T12:16:19.447Z\",\"isPartOf\":{\"@id\":\"https://docs.base44.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"base44-platform-actors\",\"item\":\"https://docs.base44.com/developers/skills/base44-platform-actors/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Base44 actors: Realtime actors (mobile apps)\",\"item\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile#article\",\"headline\":\"Base44 actors: Realtime actors (mobile apps)\",\"name\":\"Base44 actors: Realtime actors (mobile apps)\",\"description\":\"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by\",\"url\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile\",\"mainEntityOfPage\":{\"@id\":\"https://docs.base44.com/developers/skills/base44-platform-actors/references/mobile#webpage\"},\"image\":\"https://docs.base44.com/images/base44-docs-og.png\",\"dateModified\":\"2026-11-03T12:16:19.447Z\",\"publisher\":{\"@id\":\"https://docs.base44.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.base44.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Base44 Support Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Base44 Support Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Apps","pages":[{"title":"Apps","href":""}]},{"tab":"Superagents","pages":[{"title":"Superagents","href":"/Getting-Started/superagent"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/Integrations/Using-integrations"}]},{"tab":"Developers","dropdowns":[{"dropdown":"Home","icon":"house","pages":[{"title":"Base44 Developer Platform","mode":"wide","href":"/developers/home"}],"global":{"anchors":[{"anchor":"Backend","icon":"server","href":"/developers/backend/overview/introduction"},{"anchor":"App Code","icon":"code","href":"/developers/app-code/overview/introduction"},{"anchor":"SDKs","icon":"brackets-curly","href":"/developers/references/sdks/overview"},{"anchor":"CLI","icon":"terminal","href":"/developers/references/cli/get-started/overview"},{"anchor":"APIs","icon":"plug","href":"/developers/references/apis/overview"},{"anchor":"White label (Beta)","icon":"tag","href":"/developers/white-label/overview"}]}},{"dropdown":"Backend (Beta)","icon":"server","groups":[{"group":"Overview","icon":"compass","pages":[{"title":"Introduction","href":"/developers/backend/overview/introduction"},{"title":"Backend Service Basics","sidebarTitle":"Backend Service Basics","href":"/developers/backend/overview/backend-service-basics"},{"title":"Features","href":"/developers/backend/overview/features"},{"title":"Pricing","href":"/developers/backend/overview/pricing"},{"title":"Troubleshoot your project","sidebarTitle":"Troubleshooting","href":"/developers/backend/overview/troubleshooting"}]},{"group":"Quickstarts","icon":"rocket","pages":[{"title":"Build with AI","sidebarTitle":"Build with AI","href":"/developers/backend/quickstart/quickstart-with-ai"},{"group":"Templates","pages":[{"title":"Backend only","href":"/developers/backend/quickstart/templates/quickstart-backend-only"},{"title":"React Quickstart","sidebarTitle":"React","href":"/developers/backend/quickstart/templates/quickstart-react-template"}]},{"group":"Frameworks","pages":[{"title":"React Quickstart","sidebarTitle":"React","href":"/developers/backend/quickstart/frameworks/quickstart-with-react"},{"title":"Vue Quickstart","sidebarTitle":"Vue","href":"/developers/backend/quickstart/frameworks/quickstart-vue"},{"title":"Solid JS Quickstart","sidebarTitle":"Solid JS","href":"/developers/backend/quickstart/frameworks/quickstart-solid-js"},{"title":"Refine Quickstart","sidebarTitle":"Refine","href":"/developers/backend/quickstart/frameworks/quickstart-refine"},{"title":"Hono Quickstart","sidebarTitle":"Hono","href":"/developers/backend/quickstart/frameworks/quickstart-hono"},{"title":"React Native (Expo) Quickstart","sidebarTitle":"React Native (Expo)","href":"/developers/backend/quickstart/frameworks/quickstart-with-react-native"}]}]},{"group":"Project","icon":"folder-open","pages":[{"title":"Project Structure","href":"/developers/backend/overview/project-structure"},{"title":"Start from an Existing Base44 App","sidebarTitle":"Start from an Existing Base44 App","href":"/developers/backend/overview/start-from-existing-app"},{"title":"Set Up Local Dev for an Existing App","sidebarTitle":"Set Up Local Dev for an Existing App","href":"/developers/backend/overview/set-up-local-dev-existing-app"},{"title":"Link an Existing Backend Project","sidebarTitle":"Link an Existing Backend Project","href":"/developers/backend/overview/link-existing-project"},{"group":"Local Development","expanded":false,"pages":[{"title":"Local development","sidebarTitle":"Overview","href":"/developers/backend/overview/local-dev/local-development-overview"},{"title":"Local development setup","sidebarTitle":"Setup","href":"/developers/backend/overview/local-dev/get-started"}]},{"title":"Standalone scripts","sidebarTitle":"Standalone scripts","href":"/developers/backend/overview/run-scripts"}]},{"group":"AI Development Tools","icon":"wand-magic-sparkles","pages":[{"title":"AI development tools overview","sidebarTitle":"Overview","href":"/developers/backend/overview/agent-extensions"},{"title":"Skills","sidebarTitle":"Skills","href":"/developers/backend/overview/skills"},{"title":"Base44 MCP server","sidebarTitle":"Base44 MCP server","href":"/developers/backend/overview/mcp-server"},{"title":"Base44 Docs MCP","sidebarTitle":"Docs MCP server","href":"/developers/backend/overview/base44-docs-mcp"}]},{"group":"Resources","icon":"cubes","pages":[{"group":"Agents","expanded":false,"pages":[{"title":"About Agents","sidebarTitle":"Agents","href":"/developers/backend/resources/agents/overview"},{"title":"Agent Skills","sidebarTitle":"Agent Skills","href":"/developers/backend/resources/agents/agent-skills"}]},{"group":"Actors","expanded":false,"pages":[{"title":"Actors Overview","sidebarTitle":"Overview","href":"/developers/backend/resources/actors/overview"},{"title":"Create an Actor","sidebarTitle":"Create an Actor","href":"/developers/backend/resources/actors/create-actor"},{"title":"Actors: Sample Flows","sidebarTitle":"Sample Flows","href":"/developers/backend/resources/actors/sample-flows"},{"title":"Actors Files and Code","sidebarTitle":"Actors Files and Code","href":"/developers/backend/resources/actors/reference"}]},{"title":"Supported Models","sidebarTitle":"Models","href":"/developers/backend/resources/models"},{"title":"Auth","sidebarTitle":"Auth","href":"/developers/backend/resources/auth"},{"group":"Backend Functions","expanded":false,"pages":[{"title":"Backend Functions Overview","sidebarTitle":"Overview","href":"/developers/backend/resources/backend-functions/overview"},{"title":"Automations","href":"/developers/backend/resources/backend-functions/automations"}]},{"group":"Connectors","expanded":false,"pages":[{"title":"Connectors overview","sidebarTitle":"Overview","href":"/developers/backend/resources/connectors"},{"title":"Shared connectors","sidebarTitle":"Shared connectors","href":"/developers/backend/resources/connectors/shared-connectors"},{"title":"App user connectors","sidebarTitle":"App user connectors","href":"/developers/backend/resources/connectors/app-user-connectors"}]},{"group":"Entities","expanded":false,"pages":[{"title":"Entities Overview","sidebarTitle":"Overview","href":"/developers/backend/resources/entities/overview"},{"title":"Entity Schemas","href":"/developers/backend/resources/entities/entity-schemas"},{"title":"User Schema","href":"/developers/backend/resources/entities/user-schema"},{"title":"Security","href":"/developers/backend/resources/entities/security"}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"App Code","icon":"grid-2","groups":[{"group":"Overview","icon":"compass","pages":[{"title":"Introduction","sidebarTitle":"Base44 for Devs","href":"/developers/app-code/overview/introduction"},{"title":"Project Structure","href":"/developers/app-code/overview/project-structure"}]},{"group":"Base44 Editor","icon":"code","pages":[{"title":"Code Tab","href":"/developers/app-code/editor/code-tab"},{"title":"Activity Monitor","sidebarTitle":"Activity Monitor","href":"/developers/app-code/editor/activity-monitor"}]},{"group":"Local Development","icon":"laptop","pages":[{"title":"GitHub Integration","sidebarTitle":"GitHub Integration","href":"/developers/app-code/local-development/github"}]},{"group":"Cloud Sandbox","icon":"cloud","pages":[{"title":"Cloud sandbox","sidebarTitle":"Overview","href":"/developers/app-code/sandbox/overview"},{"title":"Bring your own agent","sidebarTitle":"Bring your own agent","href":"/developers/app-code/sandbox/bring-your-own-agent"}]},{"group":"Enterprise","icon":"building","pages":[{"title":"Enterprise APIs","href":"/developers/references/enterprise-apis"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"SDKs","icon":"brackets-curly","groups":[{"group":"Base44 SDKs","icon":"book-open","expanded":false,"pages":[{"title":"Base44 SDKs","sidebarTitle":"Overview","href":"/developers/references/sdks/overview"}]},{"group":"App SDK","icon":"brackets-curly","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","expanded":false,"pages":[{"title":"SDK overview","href":"/developers/references/sdk/getting-started/overview"},{"title":"Base44 client","href":"/developers/references/sdk/getting-started/client"},{"title":"Work with data","href":"/developers/references/sdk/getting-started/work-with-data"},{"title":"Dynamic Types","href":"/developers/references/sdk/getting-started/dynamic-types"},{"title":"Common SDK uses","href":"/developers/references/sdk/getting-started/work-with-sdk"},{"title":"Connect to third-party APIs","href":"/developers/references/sdk/getting-started/third-party-apis"},{"title":"Generate images with the AI Gateway","sidebarTitle":"Generate images","href":"/developers/references/sdk/getting-started/ai-gateway-images"},{"title":"Generate video with the AI Gateway","sidebarTitle":"Generate video","href":"/developers/references/sdk/getting-started/ai-gateway-video"}]},{"group":"SDK Reference","boost":0.5,"icon":"brackets-curly","expanded":false,"pages":[{"group":"Client","expanded":false,"pages":[{"title":"createClient","href":"/developers/references/sdk/docs/functions/createClient"},{"title":"createClientFromRequest","href":"/developers/references/sdk/docs/functions/createClientFromRequest"}]},{"group":"Modules","expanded":false,"pages":[{"title":"actors","href":"/developers/references/sdk/docs/type-aliases/actors"},{"title":"agents","href":"/developers/references/sdk/docs/interfaces/agents"},{"title":"ai-gateway","href":"/developers/references/sdk/docs/interfaces/ai-gateway"},{"title":"analytics","href":"/developers/references/sdk/docs/interfaces/analytics"},{"title":"app","href":"/developers/references/sdk/docs/interfaces/app"},{"title":"app-logs","href":"/developers/references/sdk/docs/interfaces/app-logs"},{"title":"auth","href":"/developers/references/sdk/docs/interfaces/auth"},{"title":"connectors","href":"/developers/references/sdk/docs/interfaces/connectors"},{"title":"entities","href":"/developers/references/sdk/docs/type-aliases/entities"},{"title":"functions","href":"/developers/references/sdk/docs/interfaces/functions"},{"title":"integrations","href":"/developers/references/sdk/docs/type-aliases/integrations"},{"title":"payments","href":"/developers/references/sdk/docs/interfaces/payments"},{"title":"sso","href":"/developers/references/sdk/docs/interfaces/sso"}]}]}]},{"group":"Platform SDK (Beta)","boost":0.75,"icon":"layer-group","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","expanded":false,"pages":[{"title":"Platform SDK overview","sidebarTitle":"Overview","href":"/developers/references/platform-sdk/overview"}]},{"group":"Platform SDK Reference","icon":"brackets-curly","expanded":false,"pages":[{"group":"Client","expanded":false,"pages":[{"title":"createPlatformClient","href":"/developers/references/platform-sdk/docs/functions/createPlatformClient"},{"title":"createPlatformServer","href":"/developers/references/platform-sdk/docs/functions/createPlatformServer"}]},{"group":"Modules","expanded":false,"pages":[{"title":"chat","href":"/developers/references/platform-sdk/docs/interfaces/chat"},{"title":"webhooks","href":"/developers/references/platform-sdk/docs/interfaces/webhooks"}]},{"group":"React","expanded":false,"pages":[{"title":"useChat","href":"/developers/references/platform-sdk/docs/functions/useChat"}]}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"CLI","icon":"terminal","groups":[{"group":"Get Started","icon":"book-open","expanded":true,"pages":[{"title":"CLI Overview","href":"/developers/references/cli/get-started/overview"},{"title":"CLI Commands Overview","href":"/developers/references/cli/commands/introduction"}]},{"group":"Commands","boost":0.75,"icon":"terminal","pages":[{"group":"Account","pages":[{"title":"login","href":"/developers/references/cli/commands/login"},{"title":"logout","href":"/developers/references/cli/commands/logout"},{"title":"whoami","href":"/developers/references/cli/commands/whoami"}]},{"group":"Projects","pages":[{"title":"create","href":"/developers/references/cli/commands/create"},{"title":"link","href":"/developers/references/cli/commands/link"},{"title":"eject","href":"/developers/references/cli/commands/eject"},{"title":"scaffold","href":"/developers/references/cli/commands/scaffold"},{"title":"dashboard open","href":"/developers/references/cli/commands/dashboard-open"}]},{"group":"Workspaces","pages":[{"title":"workspace get","href":"/developers/references/cli/commands/workspace-get"},{"title":"workspace list","href":"/developers/references/cli/commands/workspace-list"},{"title":"workspace move","href":"/developers/references/cli/commands/workspace-move"}]},{"group":"Functions","pages":[{"title":"functions pull","href":"/developers/references/cli/commands/functions-pull"},{"title":"functions deploy","href":"/developers/references/cli/commands/functions-deploy"},{"title":"functions delete","href":"/developers/references/cli/commands/functions-delete"},{"title":"functions list","href":"/developers/references/cli/commands/functions-list"}]},{"group":"Entities","pages":[{"title":"entities push","href":"/developers/references/cli/commands/entities-push"}]},{"group":"Agents","pages":[{"title":"agents pull","href":"/developers/references/cli/commands/agents-pull"},{"title":"agents push","href":"/developers/references/cli/commands/agents-push"},{"title":"agent-skills pull","href":"/developers/references/cli/commands/agent-skills-pull"},{"title":"agent-skills push","href":"/developers/references/cli/commands/agent-skills-push"}]},{"group":"Actors","pages":[{"title":"actors delete","href":"/developers/references/cli/commands/actors-delete"},{"title":"actors deploy","href":"/developers/references/cli/commands/actors-deploy"}]},{"group":"Workflows","pages":[{"title":"workflows list","href":"/developers/references/cli/commands/workflows-list"},{"title":"workflows runs","href":"/developers/references/cli/commands/workflows-runs"}]},{"group":"Connectors","pages":[{"title":"connectors initiate","href":"/developers/references/cli/commands/connectors-initiate"},{"title":"connectors list-available","href":"/developers/references/cli/commands/connectors-list-available"},{"title":"connectors pull","href":"/developers/references/cli/commands/connectors-pull"},{"title":"connectors push","href":"/developers/references/cli/commands/connectors-push"}]},{"group":"Auth","pages":[{"title":"auth password-login","href":"/developers/references/cli/commands/auth-password-login"},{"title":"auth pull","href":"/developers/references/cli/commands/auth-pull"},{"title":"auth push","href":"/developers/references/cli/commands/auth-push"},{"title":"auth social-login","href":"/developers/references/cli/commands/auth-social-login"},{"title":"auth sso","href":"/developers/references/cli/commands/auth-sso"}]},{"group":"Secrets","pages":[{"title":"secrets set","href":"/developers/references/cli/commands/secrets-set"},{"title":"secrets list","href":"/developers/references/cli/commands/secrets-list"},{"title":"secrets delete","href":"/developers/references/cli/commands/secrets-delete"}]},{"group":"Development","pages":[{"title":"dev","href":"/developers/references/cli/commands/dev"},{"title":"exec","href":"/developers/references/cli/commands/exec"},{"title":"types generate","href":"/developers/references/cli/commands/types-generate"},{"title":"site open","href":"/developers/references/cli/commands/site-open"},{"title":"logs","href":"/developers/references/cli/commands/logs"}]},{"group":"API","pages":[{"title":"api catalog","href":"/developers/references/cli/commands/api-catalog"},{"title":"api fetch","href":"/developers/references/cli/commands/api-fetch"},{"title":"api grep","href":"/developers/references/cli/commands/api-grep"},{"title":"api search","href":"/developers/references/cli/commands/api-search"}]},{"group":"Sandbox","pages":[{"title":"sandbox ls","href":"/developers/references/cli/commands/sandbox-ls"},{"title":"sandbox read","href":"/developers/references/cli/commands/sandbox-read"},{"title":"sandbox grep","href":"/developers/references/cli/commands/sandbox-grep"},{"title":"sandbox write","href":"/developers/references/cli/commands/sandbox-write"},{"title":"sandbox edit","href":"/developers/references/cli/commands/sandbox-edit"},{"title":"sandbox run","href":"/developers/references/cli/commands/sandbox-run"},{"title":"sandbox checkpoint","href":"/developers/references/cli/commands/sandbox-checkpoint"},{"title":"branches list","href":"/developers/references/cli/commands/branches-list"}]},{"group":"Deployment","pages":[{"title":"build","sidebarTitle":"build","href":"/developers/references/cli/commands/build"},{"title":"deploy","href":"/developers/references/cli/commands/deploy"},{"title":"site deploy","href":"/developers/references/cli/commands/site-deploy"},{"title":"visibility","href":"/developers/references/cli/commands/visibility"}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"APIs","icon":"plug","groups":[{"group":"Base44 APIs","icon":"book-open","pages":[{"title":"Base44 APIs","sidebarTitle":"Overview","href":"/developers/references/apis/overview"}]},{"group":"Apps API (Beta)","boost":0.75,"icon":"rocket","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Apps API Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/apps-api/get-started/authentication"},{"title":"Apps API Concepts","sidebarTitle":"Concepts","href":"/developers/references/apps-api/get-started/concepts"},{"title":"Rate Limits","href":"/developers/references/apps-api/get-started/rate-limits"}]},{"group":"Apps","icon":"grid-2","pages":[{"title":"Apps","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/apps"},{"group":"Management","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps","href":"/api-reference/list-apps"},{"title":"Create app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps","href":"/api-reference/create-app"},{"title":"Get app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}","href":"/api-reference/get-app"},{"title":"Update app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}","href":"/api-reference/update-app"},{"title":"Patch app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}","href":"/api-reference/patch-app"},{"title":"Get remix requirements","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/remix/requirements","href":"/api-reference/get-remix-requirements"},{"title":"Remix an app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/remix","href":"/api-reference/remix-an-app"},{"title":"Export app source code","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/coding/export-to-zip","href":"/api-reference/export-app-source-code"},{"title":"Check app delete impact","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/delete-check","href":"/api-reference/check-app-delete-impact"},{"title":"Delete app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}","href":"/api-reference/delete-app"},{"title":"Restore deleted app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps-trash/{app_id}/restore","href":"/api-reference/restore-deleted-app"}]},{"group":"Branding","pages":[{"title":"Change app slug","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/metadata/slug","href":"/api-reference/change-app-slug"},{"title":"Generate app logo","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/metadata/generate-logo","href":"/api-reference/generate-app-logo"},{"title":"Set app logo","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/metadata/update-logo","href":"/api-reference/set-app-logo"},{"title":"Set social image","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/metadata/social-image","href":"/api-reference/set-social-image"},{"title":"Upload app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/files/apps/{app_id}/upload","href":"/api-reference/upload-app-file"},{"title":"List assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/assets","href":"/api-reference/list-assets"},{"title":"Create asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/assets","href":"/api-reference/create-asset"},{"title":"Upload asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/assets/upload","href":"/api-reference/upload-asset"},{"title":"Rename asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/assets/{asset_id}","href":"/api-reference/rename-asset"},{"title":"Delete asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/assets/{asset_id}","href":"/api-reference/delete-asset"}]},{"group":"Secrets","pages":[{"title":"List secrets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/secrets","href":"/api-reference/list-secrets"},{"title":"Set secret","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/secrets","href":"/api-reference/set-secret"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/secrets","href":"/api-reference/delete-secret"}]},{"group":"Ownership transfer","pages":[{"title":"Check ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/preflight","href":"/api-reference/check-ownership-transfer"},{"title":"Start ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer","href":"/api-reference/start-ownership-transfer"},{"title":"Transfer ownership to a workspace member","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/workspace-member","href":"/api-reference/transfer-ownership-to-a-workspace-member"},{"title":"Get pending ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/ownership/transfer/pending","href":"/api-reference/get-pending-ownership-transfer"},{"title":"Resend ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/resend","href":"/api-reference/resend-ownership-transfer"},{"title":"Cancel ownership transfer","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/ownership/transfer/cancel","href":"/api-reference/cancel-ownership-transfer"}]},{"group":"Template listings","pages":[{"title":"Get template listing pending update","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/app-catalog-items/catalog/{item_id}/pending-changes","href":"/api-reference/get-template-listing-pending-update"},{"title":"Submit template listing update","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-catalog-items/catalog/{item_id}/submit-update","href":"/api-reference/submit-template-listing-update"},{"title":"Archive template listing","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-catalog-items/catalog/{item_id}/archive","href":"/api-reference/archive-template-listing"}]},{"group":"SSO and MCP","pages":[{"title":"Get app SSO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/sso/settings","href":"/api-reference/get-app-sso-settings"},{"title":"Update app SSO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/sso/settings","href":"/api-reference/update-app-sso-settings"},{"title":"Get MCP status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/platform/{app_id}/mcp-status","href":"/api-reference/get-mcp-status"},{"title":"Get MCP config","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/platform/{app_id}/mcp/config","href":"/api-reference/get-mcp-config"},{"title":"Update MCP config","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/platform/{app_id}/mcp/config","href":"/api-reference/update-mcp-config"},{"title":"Get app API reference","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/openapi-spec","href":"/api-reference/get-app-api-reference"}]}]},{"group":"Code and sandbox","icon":"code","pages":[{"title":"Code and sandbox","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/code-and-sandbox"},{"title":"List app code files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/code/file-list","href":"/api-reference/list-app-code-files"},{"title":"Get an app code file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/code/content","href":"/api-reference/get-an-app-code-file"},{"title":"Get app code files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/code/content/batch","href":"/api-reference/get-app-code-files"},{"title":"Search app code","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/code/search","href":"/api-reference/search-app-code"},{"title":"Save an app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/coding/write","href":"/api-reference/save-an-app-file"},{"title":"Save several app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/coding/write-batch","href":"/api-reference/save-several-app-files"},{"title":"List app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/list_directory","href":"/api-reference/list-app-files"},{"title":"Read app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/read_file","href":"/api-reference/read-app-files"},{"title":"Search app files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/grep","href":"/api-reference/search-app-files"},{"title":"Write an app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/write_file","href":"/api-reference/write-an-app-file"},{"title":"Edit an app file","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/edit_file","href":"/api-reference/edit-an-app-file"},{"title":"Run a sandbox command","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/run_command","href":"/api-reference/run-a-sandbox-command"},{"title":"Create a sandbox checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/sandbox-bridge/create_checkpoint","href":"/api-reference/create-a-sandbox-checkpoint"},{"title":"List backend functions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/backend-functions","href":"/api-reference/list-backend-functions"},{"title":"Get backend function logs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/functions-mgmt/{function_name}/logs","href":"/api-reference/get-backend-function-logs"},{"title":"Redeploy a backend function","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/coding/redeploy-function/{function_name}","href":"/api-reference/redeploy-a-backend-function"},{"title":"Delete a backend function","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/backend-functions/{function_name}","href":"/api-reference/delete-a-backend-function"},{"title":"List branches","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/branches","href":"/api-reference/list-branches"},{"title":"Create branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches","href":"/api-reference/create-branch"},{"title":"Get branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/branches/{branch_id}","href":"/api-reference/get-branch"},{"title":"Get branch sync status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/branches/{branch_id}/sync-status","href":"/api-reference/get-branch-sync-status"},{"title":"Update branch from main","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches/{branch_id}/sync-from-main","href":"/api-reference/update-branch-from-main"},{"title":"Merge branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches/{branch_id}/merge","href":"/api-reference/merge-branch"},{"title":"Delete branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/branches/{branch_id}","href":"/api-reference/delete-branch"},{"title":"Set main branch protection","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/branches/main/protection","href":"/api-reference/set-main-branch-protection"}]},{"group":"Chat","icon":"comments","pages":[{"title":"Chat","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/chat"},{"title":"Retry chat requests","sidebarTitle":"Retries","href":"/developers/references/apps-api/sections/chat-retries"},{"title":"Read conversation messages","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/chat/full-conversation","href":"/api-reference/read-conversation-messages"},{"title":"Send chat message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/message","href":"/api-reference/send-chat-message"},{"title":"Stop generation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/stop","href":"/api-reference/stop-generation"},{"title":"Submit tool-call input","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/submit-tool-call-input","href":"/api-reference/submit-tool-call-input"},{"title":"Submit tool-call input (batch)","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/submit-tool-call-input/batch","href":"/api-reference/submit-tool-call-input-batch"},{"title":"Edit and resend","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/edit-and-resend","href":"/api-reference/edit-and-resend"},{"title":"Undo message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/message/{message_id}/undo","href":"/api-reference/undo-message"},{"title":"Get message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/chat/queue","href":"/api-reference/get-message-queue"},{"title":"Edit queued message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/chat/queue/{item_id}","href":"/api-reference/edit-queued-message"},{"title":"Reorder message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/chat/queue/reorder","href":"/api-reference/reorder-message-queue"},{"title":"Pause message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/queue/pause","href":"/api-reference/pause-message-queue"},{"title":"Resume message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/chat/queue/resume","href":"/api-reference/resume-message-queue"},{"title":"Remove queued message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/chat/queue/{item_id}","href":"/api-reference/remove-queued-message"},{"title":"Clear message queue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/chat/queue","href":"/api-reference/clear-message-queue"}]},{"group":"Comments","icon":"comment-dots","pages":[{"title":"List comments","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/comments","href":"/api-reference/list-comments"},{"title":"List mentionable users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/comments/mentionable","href":"/api-reference/list-mentionable-users"},{"title":"Create comment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments","href":"/api-reference/create-comment"},{"title":"Reply to comment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/replies","href":"/api-reference/reply-to-comment"},{"title":"Edit comment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/comments/threads/{thread_id}/messages/{message_id}","href":"/api-reference/edit-comment"},{"title":"Update comment anchor","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/comments/threads/{thread_id}/anchor","href":"/api-reference/update-comment-anchor"},{"title":"Toggle comment reaction","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/messages/{message_id}/reactions","href":"/api-reference/toggle-comment-reaction"},{"title":"Resolve comment thread","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/resolve","href":"/api-reference/resolve-comment-thread"},{"title":"Reopen comment thread","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/unresolve","href":"/api-reference/reopen-comment-thread"},{"title":"Mark comment thread read","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/read","href":"/api-reference/mark-comment-thread-read"},{"title":"Mark all comments read","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/read-all","href":"/api-reference/mark-all-comments-read"},{"title":"Create comment screenshot link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/comments/threads/{thread_id}/chat-screenshot-url","href":"/api-reference/create-comment-screenshot-link"},{"title":"Delete comment reply","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/comments/threads/{thread_id}/messages/{message_id}","href":"/api-reference/delete-comment-reply"},{"title":"Delete comment thread","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/comments/threads/{thread_id}","href":"/api-reference/delete-comment-thread"}]},{"group":"Email","icon":"envelope","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails","href":"/api-reference/list-email-templates"},{"title":"Get email template","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails/{template_id}","href":"/api-reference/get-email-template"},{"title":"Send email template test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/emails/{template_id}/test","href":"/api-reference/send-email-template-test"},{"title":"Delete email template","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/emails/{template_id}","href":"/api-reference/delete-email-template"},{"title":"Preview application email","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails/system/{email_type}/preview","href":"/api-reference/preview-application-email"},{"title":"Customize application email","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/emails/system/{email_type}/materialize","href":"/api-reference/customize-application-email"},{"title":"Send application email test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/emails/system/{email_type}/test","href":"/api-reference/send-application-email-test"},{"title":"Get email stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/emails/stats","href":"/api-reference/get-email-stats"}]},{"group":"Checkpoints","icon":"clock-rotate-left","pages":[{"title":"Checkpoints","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/checkpoints"},{"title":"List checkpoints","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/app-checkpoints","href":"/api-reference/list-checkpoints"},{"title":"Create checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/app-checkpoints","href":"/api-reference/create-checkpoint"},{"title":"Get checkpoint files","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/app-checkpoints/{checkpoint_id}/file-tree","href":"/api-reference/get-checkpoint-files"},{"title":"Restore checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/app-checkpoints/{checkpoint_id}/load","href":"/api-reference/restore-checkpoint"},{"title":"Retry checkpoint build","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/app-checkpoints/{checkpoint_id}/retry-build","href":"/api-reference/retry-checkpoint-build"}]},{"group":"Deployment","icon":"cloud-arrow-up","pages":[{"title":"Deployment","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/deployment"},{"title":"Get preview URL","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/sandbox/preview-url","href":"/api-reference/get-preview-url"},{"title":"Deploy an app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/deploy","href":"/api-reference/deploy-an-app"},{"title":"Deploy a prebuilt site","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/deploy-dist","href":"/api-reference/deploy-a-prebuilt-site"},{"title":"Request deploy approval","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/request-deploy","href":"/api-reference/request-deploy-approval"},{"title":"Get published URL","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/platform/{app_id}/published-url","href":"/api-reference/get-published-url"},{"title":"Unpublish app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/undeploy","href":"/api-reference/unpublish-app"}]},{"group":"Entities","icon":"table","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/entities"},{"group":"Schemas","pages":[{"title":"List entity schemas","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entity-schemas","href":"/api-reference/list-entity-schemas"},{"title":"Get entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entity-schemas/{entity_name}","href":"/api-reference/get-entity-schema"},{"title":"Create entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entity-schemas","href":"/api-reference/create-entity-schema"},{"title":"Update entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entity-schemas/{entity_name}","href":"/api-reference/update-entity-schema"},{"title":"Sync entity schemas","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entity-schemas","href":"/api-reference/sync-entity-schemas"},{"title":"Delete entity schema","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entity-schemas/{entity_name}","href":"/api-reference/delete-entity-schema"}]},{"group":"Records","pages":[{"title":"List entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/v2/list","href":"/api-reference/list-entity-records"},{"title":"Get entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/{entity_id}","href":"/api-reference/get-entity-record"},{"title":"Create entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}","href":"/api-reference/create-entity-record"},{"title":"Update entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/{entity_id}","href":"/api-reference/update-entity-record"},{"title":"Delete entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/{entity_name}/{entity_id}","href":"/api-reference/delete-entity-record"},{"title":"Count entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/count","href":"/api-reference/count-entity-records"},{"title":"Aggregate entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/aggregate","href":"/api-reference/aggregate-entity-records"}]},{"group":"Bulk operations","pages":[{"title":"Create entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/bulk","href":"/api-reference/create-entity-records"},{"title":"Update entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/bulk","href":"/api-reference/update-entity-records"},{"title":"Update entity records by filter","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/entities/{entity_name}/update-many","href":"/api-reference/update-entity-records-by-filter"},{"title":"Upsert entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/upsert","href":"/api-reference/upsert-entity-records"},{"title":"Import entity records from CSV","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/{entity_name}/import","href":"/api-reference/import-entity-records-from-csv"},{"title":"Delete entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/{entity_name}","href":"/api-reference/delete-entity-records"}]},{"group":"Trash","pages":[{"title":"List deleted entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/trash","href":"/api-reference/list-deleted-entity-records"},{"title":"Restore entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/{entity_id}/restore","href":"/api-reference/restore-entity-record"},{"title":"Restore entity records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/{entity_name}/trash/restore","href":"/api-reference/restore-entity-records"},{"title":"Permanently delete entity record","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/{entity_name}/{entity_id}/permanent","href":"/api-reference/permanently-delete-entity-record"}]},{"group":"Data checkpoints","pages":[{"title":"Get data version history status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/versions/info","href":"/api-reference/get-data-version-history-status"},{"title":"List data checkpoints","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/versions/checkpoints","href":"/api-reference/list-data-checkpoints"},{"title":"Download data checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/{entity_name}/versions/checkpoints/{checkpoint_id}/snapshot","href":"/api-reference/download-data-checkpoint"},{"title":"Restore data to checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/entities/versions/checkpoints/{checkpoint_id}/restore","href":"/api-reference/restore-data-to-checkpoint"},{"title":"Get data restore status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/versions/restores/batch/{batch_id}","href":"/api-reference/get-data-restore-status"}]}]},{"group":"Users","icon":"users","pages":[{"title":"Users","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/users"},{"title":"List app users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/User","href":"/api-reference/list-app-users"},{"title":"Count app users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/User/count","href":"/api-reference/count-app-users"},{"title":"Get app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/entities/User/{user_id}","href":"/api-reference/get-app-user"},{"title":"Update app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/entities/User/{user_id}","href":"/api-reference/update-app-user"},{"title":"Remove app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/entities/User/{user_id}","href":"/api-reference/remove-app-user"},{"title":"Invite app users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/users/invite-users","href":"/api-reference/invite-app-users"},{"title":"Provision an app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/users/provisions","href":"/api-reference/provision-an-app-user"},{"title":"Deprovision an app user","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/users/provisions","href":"/api-reference/deprovision-an-app-user"},{"title":"List access requests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/access-requests/all","href":"/api-reference/list-access-requests"},{"title":"Approve or deny access request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/access-requests/{request_id}/{action}","href":"/api-reference/approve-or-deny-access-request"},{"title":"Update pending invitee","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/access-requests/{request_id}","href":"/api-reference/update-pending-invitee"},{"title":"List collaborators","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/users/collaborators","href":"/api-reference/list-collaborators"},{"title":"Remove collaborator","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/users/collaborators/{collaborator_id}","href":"/api-reference/remove-collaborator"},{"title":"List group shares","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/group-shares","href":"/api-reference/list-group-shares"},{"title":"Share app with groups","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/group-shares","href":"/api-reference/share-app-with-groups"},{"title":"Update group share","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/group-shares/{share_id}","href":"/api-reference/update-group-share"},{"title":"Remove group share","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/group-shares/{share_id}","href":"/api-reference/remove-group-share"}]},{"group":"Workflows","icon":"diagram-project","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/workflows"},{"group":"Management","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows","href":"/api-reference/list-workflows"},{"title":"Validate a workflow definition","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/validate-definition","href":"/api-reference/validate-a-workflow-definition"},{"title":"Create workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows","href":"/api-reference/create-workflow"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}","href":"/api-reference/get-workflow"},{"title":"Update workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/workflows/{workflow_id}","href":"/api-reference/update-workflow"},{"title":"Toggle workflow status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/toggle-status","href":"/api-reference/toggle-workflow-status"},{"title":"Archive workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/workflows/{workflow_id}","href":"/api-reference/archive-workflow"},{"title":"Restore workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/unarchive","href":"/api-reference/restore-workflow"}]},{"group":"Versions","pages":[{"title":"List workflow versions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/versions","href":"/api-reference/list-workflow-versions"},{"title":"Get workflow version","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/versions/{version_id}","href":"/api-reference/get-workflow-version"}]},{"group":"Runs","pages":[{"title":"Get workflow run-now options","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/run-now-info","href":"/api-reference/get-workflow-run-now-options"},{"title":"Run a workflow now","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/run-now","href":"/api-reference/run-a-workflow-now"},{"title":"List workflow runs for an app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/runs","href":"/api-reference/list-workflow-runs-for-an-app"},{"title":"List runs for a workflow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/runs","href":"/api-reference/list-runs-for-a-workflow"},{"title":"Get workflow run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/{workflow_id}/runs/{run_id}","href":"/api-reference/get-workflow-run"},{"title":"Cancel a workflow run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/runs/{run_id}/cancel","href":"/api-reference/cancel-a-workflow-run"},{"title":"Analyze a failed workflow run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/workflows/{workflow_id}/runs/{run_id}/analyze","href":"/api-reference/analyze-a-failed-workflow-run"}]},{"group":"Insights","pages":[{"title":"Get workflow stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/stats","href":"/api-reference/get-workflow-stats"},{"title":"Suggest workflows","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/workflows/suggestions","href":"/api-reference/suggest-workflows"}]}]},{"group":"Agents","icon":"user-robot","pages":[{"title":"Agents","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/agents"},{"title":"Get the agent profile","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-profile","href":"/api-reference/get-the-agent-profile"},{"title":"Get agent setup suggestions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/setup-suggestions","href":"/api-reference/get-agent-setup-suggestions"},{"title":"List agent conversation users","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/conversation-users","href":"/api-reference/list-agent-conversation-users"},{"title":"Get agent conversation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/conversations/{conversation_id}","href":"/api-reference/get-agent-conversation"},{"title":"List agent memories","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/{name}/memory","href":"/api-reference/list-agent-memories"},{"title":"Get agent usage","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/agent-configs/usage","href":"/api-reference/get-agent-usage"}]},{"group":"Domains and redirects","icon":"globe","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/domains"},{"group":"Custom domains","pages":[{"title":"Check domain availability","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/availability","href":"/api-reference/check-domain-availability"},{"title":"Get domain purchase provider","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/purchase-provider","href":"/api-reference/get-domain-purchase-provider"},{"title":"Create domain checkout link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/purchase-url","href":"/api-reference/create-domain-checkout-link"},{"title":"List domain registrations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/registrations","href":"/api-reference/list-domain-registrations"},{"title":"Update a domain registration","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/custom-domains/{domain_id}/registration","href":"/api-reference/update-a-domain-registration"},{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains","href":"/api-reference/list-custom-domains"},{"title":"Add custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains","href":"/api-reference/add-custom-domain"},{"title":"Get custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/{domain_id}","href":"/api-reference/get-custom-domain"},{"title":"Get custom domain DNS records","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-domains/{domain_id}/dns-records","href":"/api-reference/get-custom-domain-dns-records"},{"title":"Verify custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/verify","href":"/api-reference/verify-custom-domain"},{"title":"Get custom domain status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/status","href":"/api-reference/get-custom-domain-status"},{"title":"Link custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/link","href":"/api-reference/link-custom-domain"},{"title":"Set custom domain redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/custom-domains/{domain_id}/redirect","href":"/api-reference/set-custom-domain-redirect"},{"title":"Unlink custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-domains/{domain_id}/unlink","href":"/api-reference/unlink-custom-domain"},{"title":"Delete custom domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/custom-domains/{domain_id}","href":"/api-reference/delete-custom-domain"}]},{"group":"Email domains","pages":[{"title":"List email domains","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/custom-email-domains","href":"/api-reference/list-email-domains"},{"title":"Enable email sending for a domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-email-domains","href":"/api-reference/enable-email-sending-for-a-domain"},{"title":"Retry email domain setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-email-domains/configure","href":"/api-reference/retry-email-domain-setup"},{"title":"Update email sender details","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/custom-email-domains","href":"/api-reference/update-email-sender-details"},{"title":"Replace the email domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/custom-email-domains/replace","href":"/api-reference/replace-the-email-domain"},{"title":"Disable email sending for a domain","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/custom-email-domains","href":"/api-reference/disable-email-sending-for-a-domain"}]},{"group":"URL redirects","pages":[{"title":"List URL redirects","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/url-redirects","href":"/api-reference/list-url-redirects"},{"title":"Create URL redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/url-redirects","href":"/api-reference/create-url-redirect"},{"title":"Update URL redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/url-redirects/{redirect_id}","href":"/api-reference/update-url-redirect"},{"title":"Delete URL redirect","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/url-redirects/{redirect_id}","href":"/api-reference/delete-url-redirect"}]}]},{"group":"GitHub","icon":"github","pages":[{"title":"GitHub","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/github"},{"title":"List workspace GitHub installations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/workspace-installations","href":"/api-reference/list-workspace-github-installations"},{"title":"List GitHub organizations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/organizations","href":"/api-reference/list-github-organizations"},{"title":"Get GitHub organization policy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/org-policy","href":"/api-reference/get-github-organization-policy"},{"title":"Connect a GitHub repository","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/connect","href":"/api-reference/connect-a-github-repository"},{"title":"Link an existing GitHub repository","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/link-existing","href":"/api-reference/link-an-existing-github-repository"},{"title":"Get GitHub connection","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/github/connection","href":"/api-reference/get-github-connection"},{"title":"Turn automatic GitHub sync on or off","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync/toggle","href":"/api-reference/turn-automatic-github-sync-on-or-off"},{"title":"Pull changes from GitHub","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync","href":"/api-reference/pull-changes-from-github"},{"title":"Push changes to GitHub","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync/manual","href":"/api-reference/push-changes-to-github"},{"title":"Resolve GitHub sync conflicts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/sync/resolve-conflicts","href":"/api-reference/resolve-github-sync-conflicts"},{"title":"Import a GitHub branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/branches/import","href":"/api-reference/import-a-github-branch"},{"title":"Reconnect a GitHub repository","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/github/reconnect","href":"/api-reference/reconnect-a-github-repository"},{"title":"Disconnect a GitHub repository","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/github/disconnect","href":"/api-reference/disconnect-a-github-repository"}]},{"group":"Base code","icon":"laptop-code","pages":[{"title":"Base code","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/imported-app-sessions"},{"title":"Check for main sandbox updates","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/main-update/check","href":"/api-reference/check-for-main-sandbox-updates"},{"title":"Get main sandbox update status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/main-update","href":"/api-reference/get-main-sandbox-update-status"},{"title":"Retry main sandbox update","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/main-update/failures/{failure_id}/retry","href":"/api-reference/retry-main-sandbox-update"},{"title":"Investigate main sandbox update failure","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/main-update/failures/{failure_id}/investigations","href":"/api-reference/investigate-main-sandbox-update-failure"},{"title":"List coding sessions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions","href":"/api-reference/list-coding-sessions"},{"title":"Launch coding session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/sessions","href":"/api-reference/launch-coding-session"},{"title":"Import a Claude Code or Codex session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/session-imports","href":"/api-reference/import-a-claude-code-or-codex-session"},{"title":"Get coding session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/{session_id}","href":"/api-reference/get-coding-session"},{"title":"Get coding session by launch key","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/launch-requests/{launch_key}","href":"/api-reference/get-coding-session-by-launch-key"},{"title":"Get latest coding sessions by reference","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/latest","href":"/api-reference/get-latest-coding-sessions-by-reference"},{"title":"Get a coding session's open question","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/{session_id}/input-request","href":"/api-reference/get-a-coding-sessions-open-question"},{"title":"Send a message to a coding session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/sessions/{session_id}/messages","href":"/api-reference/send-a-message-to-a-coding-session"},{"title":"Get a message sent to a coding session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/sessions/{session_id}/messages/{input_id}","href":"/api-reference/get-a-message-sent-to-a-coding-session"},{"title":"Cancel coding session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/sessions/{session_id}/cancel","href":"/api-reference/cancel-coding-session"},{"title":"Import repository branch","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/branches/import-from-repo","href":"/api-reference/import-repository-branch"},{"title":"Get branch pull request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/pull-request","href":"/api-reference/get-branch-pull-request"},{"title":"Open pull request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/git/pull-request","href":"/api-reference/open-pull-request"},{"title":"Update pull request","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/imported/git/pull-request","href":"/api-reference/update-pull-request"},{"title":"Get pull requests for branches","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/pull-requests/by-branch","href":"/api-reference/get-pull-requests-for-branches"},{"title":"List pull requests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/pull-requests","href":"/api-reference/list-pull-requests"},{"title":"Get branch git status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/imported/git/status","href":"/api-reference/get-branch-git-status"},{"title":"Commit branch changes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/git/commit","href":"/api-reference/commit-branch-changes"},{"title":"Discard branch changes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/imported/git/discard","href":"/api-reference/discard-branch-changes"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/integrations"},{"title":"List connectors","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/external-auth/available-integrations","href":"/api-reference/list-connectors"},{"title":"Get connector policies","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/connector-governance","href":"/api-reference/get-connector-policies"},{"title":"List connector connections","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/list","href":"/api-reference/list-connector-connections"},{"title":"Get connector connection status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/status","href":"/api-reference/get-connector-connection-status"},{"title":"Get connector connection fields","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/connection-config/{integration_type}","href":"/api-reference/get-connector-connection-fields"},{"title":"Get OAuth redirect URIs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/oauth-redirect-uris","href":"/api-reference/get-oauth-redirect-uris"},{"title":"Start connector connection","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/external-auth/initiate","href":"/api-reference/start-connector-connection"},{"title":"Set connector scopes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/external-auth/integrations/{integration_type}","href":"/api-reference/set-connector-scopes"},{"title":"Disconnect connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/external-auth/integrations/{integration_type}","href":"/api-reference/disconnect-connector"},{"title":"Remove connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/external-auth/integrations/{integration_type}/remove","href":"/api-reference/remove-connector"}]},{"group":"Security","icon":"shield-halved","pages":[{"title":"Security","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/security"},{"title":"Run security scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan","href":"/api-reference/run-security-scan"},{"title":"Get security scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/security/scan","href":"/api-reference/get-security-scan"},{"title":"Fix RLS recommendations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan/rls/fix","href":"/api-reference/fix-rls-recommendations"},{"title":"Dismiss RLS recommendation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/security/scan/rls-recommendation/{entity_name}","href":"/api-reference/dismiss-rls-recommendation"},{"title":"Dismiss header recommendation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/security/scan/header-recommendations/{flag}","href":"/api-reference/dismiss-header-recommendation"},{"title":"Enable core integration protection","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan/core-integrations/protect","href":"/api-reference/enable-core-integration-protection"},{"title":"Ignore security finding","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/security/scan/ignore","href":"/api-reference/ignore-security-finding"},{"title":"Restore security finding","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/security/scan/ignore/{fingerprint}","href":"/api-reference/restore-security-finding"},{"title":"Get security headers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/security/headers","href":"/api-reference/get-security-headers"},{"title":"Update security headers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/security/headers","href":"/api-reference/update-security-headers"}]},{"group":"Testing","icon":"vial","pages":[{"title":"Testing","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/testing"},{"title":"List tests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/flows","href":"/api-reference/list-tests"},{"title":"Create test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows","href":"/api-reference/create-test"},{"title":"Get test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/flows/{flow_id}","href":"/api-reference/get-test"},{"title":"Update test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/testing-agent/flows/{flow_id}","href":"/api-reference/update-test"},{"title":"Delete test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/testing-agent/flows/{flow_id}","href":"/api-reference/delete-test"},{"title":"Refine test description","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/refine","href":"/api-reference/refine-test-description"},{"title":"Generate tests from app","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows/generate-from-app-context","href":"/api-reference/generate-tests-from-app"},{"title":"Suggest new tests","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows/suggest-new-tests","href":"/api-reference/suggest-new-tests"},{"title":"Save test generation checkpoint","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/flows/save-generation-checkpoint","href":"/api-reference/save-test-generation-checkpoint"},{"title":"Seed test data","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/data/seed","href":"/api-reference/seed-test-data"},{"title":"Run test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/executions","href":"/api-reference/run-test"},{"title":"List test runs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/executions","href":"/api-reference/list-test-runs"},{"title":"Get latest run per test","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/executions/latest-by-flow","href":"/api-reference/get-latest-run-per-test"},{"title":"Get test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/executions/{execution_id}","href":"/api-reference/get-test-run"},{"title":"Pause test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/executions/{execution_id}/pause","href":"/api-reference/pause-test-run"},{"title":"Cancel test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/executions/{execution_id}/cancel","href":"/api-reference/cancel-test-run"},{"title":"Get test run report","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/testing-agent/analysis/{execution_id}","href":"/api-reference/get-test-run-report"},{"title":"Reanalyze test run","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/analysis/{execution_id}/reanalyze","href":"/api-reference/reanalyze-test-run"},{"title":"Resolve test run issue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/analysis/{execution_id}/issues/resolve","href":"/api-reference/resolve-test-run-issue"},{"title":"Delete test run issue","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/testing-agent/analysis/{execution_id}/issues/delete","href":"/api-reference/delete-test-run-issue"}]},{"group":"SEO","icon":"magnifying-glass","pages":[{"title":"SEO","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/seo"},{"title":"Get SEO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/settings","href":"/api-reference/get-seo-settings"},{"title":"Update SEO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/seo/settings","href":"/api-reference/update-seo-settings"},{"title":"Get page visibility","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/page-visibility","href":"/api-reference/get-page-visibility"},{"title":"Update page SEO settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/seo/page-settings/{page_name}","href":"/api-reference/update-page-seo-settings"},{"title":"Run SEO scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/seo/scan","href":"/api-reference/run-seo-scan"},{"title":"Get last SEO scan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/last-scan","href":"/api-reference/get-last-seo-scan"},{"title":"Get SEO score","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/summary","href":"/api-reference/get-seo-score"},{"title":"Apply SEO fix","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/seo/fix","href":"/api-reference/apply-seo-fix"},{"title":"Preview llms.txt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/preview/llms-txt","href":"/api-reference/preview-llmstxt"},{"title":"Preview JSON-LD","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/preview/json-ld","href":"/api-reference/preview-json-ld"}]},{"group":"SEO research","icon":"microscope","pages":[{"title":"Get keyword ideas","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/keyword-ideas","href":"/api-reference/get-keyword-ideas"},{"title":"Get Google's top 10 for a keyword","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/serp","href":"/api-reference/get-googles-top-10-for-a-keyword"},{"title":"Get search performance","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/search-performance","href":"/api-reference/get-search-performance"},{"title":"Get keywords a competitor wins","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/competitor-gap","href":"/api-reference/get-keywords-a-competitor-wins"},{"title":"Get sites linking to a competitor","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/backlink-gap","href":"/api-reference/get-sites-linking-to-a-competitor"},{"title":"Ask AI assistants about this app's market","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/seo/research/ai-answers","href":"/api-reference/ask-ai-assistants-about-this-apps-market"}]},{"group":"Analytics","icon":"chart-column","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/analytics"},{"title":"Suggest analytics events to track","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/suggestions","href":"/api-reference/suggest-analytics-events-to-track"},{"title":"List analytics event names","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/names","href":"/api-reference/list-analytics-event-names"},{"title":"List analytics event properties","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/{event_name}/properties","href":"/api-reference/list-analytics-event-properties"},{"title":"Query analytics events","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/analytics/query","href":"/api-reference/query-analytics-events"},{"title":"Aggregate analytics events over time","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/analytics/timeseries","href":"/api-reference/aggregate-analytics-events-over-time"},{"title":"Aggregate analytics events by field","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/analytics/grouped","href":"/api-reference/aggregate-analytics-events-by-field"},{"title":"Get analytics user stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/analytics/stats/users","href":"/api-reference/get-analytics-user-stats"},{"title":"Get session recording settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/session-recordings/apps/{app_id}/recording-settings","href":"/api-reference/get-session-recording-settings"},{"title":"Turn session recordings on or off","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/session-recordings/apps/{app_id}/recording-settings","href":"/api-reference/turn-session-recordings-on-or-off"},{"title":"Update session recording capture settings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/session-recordings/apps/{app_id}/recording-settings","href":"/api-reference/update-session-recording-capture-settings"}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/payments"},{"group":"Stripe","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/payments-stripe"},{"title":"Install Stripe integration","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/install","href":"/api-reference/install-stripe-integration"},{"title":"Get Stripe integration status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/status","href":"/api-reference/get-stripe-integration-status"},{"title":"Get Stripe sandbox","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/sandbox","href":"/api-reference/get-stripe-sandbox"},{"title":"Get Stripe onboarding link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/sandbox/claim-url","href":"/api-reference/get-stripe-onboarding-link"},{"title":"Provision live Stripe keys","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/provision-live-keys","href":"/api-reference/provision-live-stripe-keys"},{"title":"Configure live Stripe keys","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/configure-live-keys","href":"/api-reference/configure-live-stripe-keys"},{"title":"List Stripe products","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/products","href":"/api-reference/list-stripe-products"},{"title":"Create Stripe product","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/products","href":"/api-reference/create-stripe-product"},{"title":"Get Stripe product","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/products/{product_id}","href":"/api-reference/get-stripe-product"},{"title":"Update Stripe product","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/payments/stripe/products/{product_id}","href":"/api-reference/update-stripe-product"},{"title":"List Stripe prices","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/prices","href":"/api-reference/list-stripe-prices"},{"title":"Create Stripe price","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/stripe/prices","href":"/api-reference/create-stripe-price"},{"title":"Update Stripe price","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/payments/stripe/prices/{price_id}","href":"/api-reference/update-stripe-price"},{"title":"Remove Stripe integration","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/payments/stripe","href":"/api-reference/remove-stripe-integration"}]},{"group":"Wix Payments","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/payments-wix"},{"title":"Resolve Wix Payments onboarding name","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/payments/wix/resolve-name","href":"/api-reference/resolve-wix-payments-onboarding-name"},{"title":"Get Wix Payments status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/status","href":"/api-reference/get-wix-payments-status"},{"title":"Get Wix Payments dashboard link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/dashboard-url","href":"/api-reference/get-wix-payments-dashboard-link"},{"title":"Switch Wix Payments test mode","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/payments/wix/test-mode","href":"/api-reference/switch-wix-payments-test-mode"},{"title":"List Wix Payments payouts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/payouts","href":"/api-reference/list-wix-payments-payouts"},{"title":"Get Wix Payments payout","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/wix/payouts/{payout_id}","href":"/api-reference/get-wix-payments-payout"},{"title":"Disconnect Wix Payments","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/payments/wix","href":"/api-reference/disconnect-wix-payments"},{"title":"Get Payments by Wix dashboard link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/payments-by-wix/dashboard-url","href":"/api-reference/get-payments-by-wix-dashboard-link"},{"title":"Disconnect Payments by Wix","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/payments/payments-by-wix","href":"/api-reference/disconnect-payments-by-wix"}]},{"group":"Analytics","pages":[{"title":"Get payment analytics","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics","href":"/api-reference/get-payment-analytics"},{"title":"Get recent payment transactions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/recent-transactions","href":"/api-reference/get-recent-payment-transactions"},{"title":"Get top payment customers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/top-customers","href":"/api-reference/get-top-payment-customers"}]},{"group":"Transactions","pages":[{"title":"List payment transactions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/transactions","href":"/api-reference/list-payment-transactions"},{"title":"Export payment transactions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/transactions/export","href":"/api-reference/export-payment-transactions"},{"title":"Get payment transaction","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/analytics/transactions/{transaction_id}","href":"/api-reference/get-payment-transaction"},{"title":"Refund payment transaction","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/payments/analytics/transactions/{transaction_id}/refund","href":"/api-reference/refund-payment-transaction"}]},{"group":"Webhooks","pages":[{"title":"Receive Stripe sandbox event","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/payment-webhooks/stripe","href":"/api-reference/receive-stripe-sandbox-event"},{"title":"Receive Stripe live event","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/payment-webhooks/stripe/live","href":"/api-reference/receive-stripe-live-event"},{"title":"Receive Wix Payments event","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/payment-webhooks/wix-payments","href":"/api-reference/receive-wix-payments-event"}]}]},{"group":"Marketing Agent","icon":"wand-magic-sparkles","pages":[{"title":"Marketing Agent","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/marketing-agent"},{"title":"Start Marketing Agent setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/setup/start","href":"/api-reference/start-marketing-agent-setup"},{"title":"Answer Marketing Agent setup step","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/setup/answer","href":"/api-reference/answer-marketing-agent-setup-step"},{"title":"Get Marketing Agent state","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/cmo/state","href":"/api-reference/get-marketing-agent-state"},{"title":"Get Marketing Agent KPI values","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/cmo/kpi-values","href":"/api-reference/get-marketing-agent-kpi-values"},{"title":"Send Marketing Agent message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/messages","href":"/api-reference/send-marketing-agent-message"},{"title":"Reset Marketing Agent setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/cmo/setup/reset","href":"/api-reference/reset-marketing-agent-setup"}]},{"group":"Virality and social content","icon":"share-nodes","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/virality"},{"group":"Virality","pages":[{"title":"Start social content flow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/start","href":"/api-reference/start-social-content-flow"},{"title":"Submit answers","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/submit-answers","href":"/api-reference/submit-answers"},{"title":"Refine content strategy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/refine-strategy","href":"/api-reference/refine-content-strategy"},{"title":"Generate content plan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/generate","href":"/api-reference/generate-content-plan"},{"title":"Get social content state","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/virality/state","href":"/api-reference/get-social-content-state"},{"title":"Update post content","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/apps/{app_id}/virality/posts/{post_id}","href":"/api-reference/update-post-content"},{"title":"Refine a post","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/posts/{post_id}/refine","href":"/api-reference/refine-a-post"},{"title":"Generate a post image","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/posts/{post_id}/generate-image","href":"/api-reference/generate-a-post-image"},{"title":"Generate teaser posts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/teaser","href":"/api-reference/generate-teaser-posts"},{"title":"Reset social content flow","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/virality/reset","href":"/api-reference/reset-social-content-flow"}]}]},{"group":"Google Ads","icon":"bullhorn","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/google-ads"},{"group":"Accounts","pages":[{"title":"Create Google Ads account for tracking","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/ensure-for-tracking","href":"/api-reference/create-google-ads-account-for-tracking"},{"title":"Get Google Ads account","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/accounts","href":"/api-reference/get-google-ads-account"},{"title":"Accept Google Ads terms","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/accept-terms","href":"/api-reference/accept-google-ads-terms"},{"title":"Retry Google Ads billing setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/retry-billing-setup","href":"/api-reference/retry-google-ads-billing-setup"},{"title":"Update Google Ads monthly spend cap","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/accounts/{account_id}/budget-limit","href":"/api-reference/update-google-ads-monthly-spend-cap"},{"title":"Update Google Ads billing cadence","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/accounts/{account_id}/cadence","href":"/api-reference/update-google-ads-billing-cadence"},{"title":"Turn on Google Ads budget auto-renewal","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/auto-renewal/on","href":"/api-reference/turn-on-google-ads-budget-auto-renewal"},{"title":"Turn off Google Ads budget auto-renewal","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/auto-renewal/off","href":"/api-reference/turn-off-google-ads-budget-auto-renewal"},{"title":"Link a Google Business Profile","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/business-profile/link","href":"/api-reference/link-a-google-business-profile"},{"title":"Unlink the Google Business Profile","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/business-profile/unlink","href":"/api-reference/unlink-the-google-business-profile"},{"title":"Disconnect the Google Ads account","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/disconnect","href":"/api-reference/disconnect-the-google-ads-account"}]},{"group":"Campaigns","pages":[{"title":"List Google Ads campaign briefs","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaign-briefs","href":"/api-reference/list-google-ads-campaign-briefs"},{"title":"Generate Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaign-briefs/generate","href":"/api-reference/generate-google-ads-campaign-brief"},{"title":"Create Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaign-briefs","href":"/api-reference/create-google-ads-campaign-brief"},{"title":"Get Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaign-briefs/{brief_id}","href":"/api-reference/get-google-ads-campaign-brief"},{"title":"Update Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/campaign-briefs/{brief_id}","href":"/api-reference/update-google-ads-campaign-brief"},{"title":"Delete Google Ads campaign brief","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/google-ads/campaign-briefs/{brief_id}","href":"/api-reference/delete-google-ads-campaign-brief"},{"title":"Suggest Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/ai-suggestions","href":"/api-reference/suggest-google-ads-campaigns"},{"title":"Suggest Google Ads budget options","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/suggestions","href":"/api-reference/suggest-google-ads-budget-options"},{"title":"Get Google Ads budget boundaries","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/budget-boundaries","href":"/api-reference/get-google-ads-budget-boundaries"},{"title":"Estimate a Google Ads campaign budget","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/estimate","href":"/api-reference/estimate-a-google-ads-campaign-budget"},{"title":"Estimate Google Ads cost per click","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/cpc-estimate","href":"/api-reference/estimate-google-ads-cost-per-click"},{"title":"List Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns","href":"/api-reference/list-google-ads-campaigns"},{"title":"Create Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns","href":"/api-reference/create-google-ads-campaign"},{"title":"Get Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}","href":"/api-reference/get-google-ads-campaign"},{"title":"Update Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/campaigns/{campaign_id}","href":"/api-reference/update-google-ads-campaign"},{"title":"Delete Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/google-ads/campaigns/{campaign_id}","href":"/api-reference/delete-google-ads-campaign"},{"title":"Get Google Ads campaign targeting","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/targeting","href":"/api-reference/get-google-ads-campaign-targeting"},{"title":"Suggest keyword themes for a Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/keyword-theme-suggestions","href":"/api-reference/suggest-keyword-themes-for-a-google-ads-campaign"},{"title":"List Google Ads campaign optimization suggestions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/optimization-suggestions","href":"/api-reference/list-google-ads-campaign-optimization-suggestions"},{"title":"Apply a Google Ads budget recommendation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/recommendations/apply-budget","href":"/api-reference/apply-a-google-ads-budget-recommendation"},{"title":"Get Google Ads campaign conversion breakdown","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/impact","href":"/api-reference/get-google-ads-campaign-conversion-breakdown"},{"title":"List Google Ads campaign changes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/change-log","href":"/api-reference/list-google-ads-campaign-changes"},{"title":"Pause Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/pause","href":"/api-reference/pause-google-ads-campaign"},{"title":"Resume Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/{campaign_id}/resume","href":"/api-reference/resume-google-ads-campaign"},{"title":"Get Google Ads campaign metrics","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaigns/metrics","href":"/api-reference/get-google-ads-campaign-metrics"},{"title":"Bulk update Google Ads campaign budgets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/campaigns/bulk-budget","href":"/api-reference/bulk-update-google-ads-campaign-budgets"},{"title":"Pause all Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/pause-all","href":"/api-reference/pause-all-google-ads-campaigns"},{"title":"Sync Google Ads campaigns","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/campaigns/sync","href":"/api-reference/sync-google-ads-campaigns"}]},{"group":"Assets","pages":[{"title":"List Google Ads generated assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/assets","href":"/api-reference/list-google-ads-generated-assets"},{"title":"Generate Google Ads assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/generate-all","href":"/api-reference/generate-google-ads-assets"},{"title":"Generate Google Ads text assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/generate-text","href":"/api-reference/generate-google-ads-text-assets"},{"title":"Generate Google Ads image assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/generate-images","href":"/api-reference/generate-google-ads-image-assets"},{"title":"Upload a Google Ads video","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/upload-video","href":"/api-reference/upload-a-google-ads-video"},{"title":"Poll a Google Ads video upload","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/upload-video/poll","href":"/api-reference/poll-a-google-ads-video-upload"},{"title":"Accept a generated Google Ads asset","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/assets/{session_asset_id}/accept","href":"/api-reference/accept-a-generated-google-ads-asset"},{"title":"Regenerate Google Ads asset group creative","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/asset-groups/{asset_group_id}/regenerate-assets","href":"/api-reference/regenerate-google-ads-asset-group-creative"}]},{"group":"Launch","pages":[{"title":"Get Google Ads launch readiness","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/launch-readiness","href":"/api-reference/get-google-ads-launch-readiness"},{"title":"Get Google Ads campaign launch draft","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/campaign-launch-drafts/{draft_id}","href":"/api-reference/get-google-ads-campaign-launch-draft"},{"title":"Launch Google Ads campaign","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/launch","href":"/api-reference/launch-google-ads-campaign"}]},{"group":"Reporting","pages":[{"title":"Get Google Ads performance dashboard","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/dashboard","href":"/api-reference/get-google-ads-performance-dashboard"},{"title":"Get Google Ads metric trend","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/trend","href":"/api-reference/get-google-ads-metric-trend"},{"title":"List Google Ads insights","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/insights","href":"/api-reference/list-google-ads-insights"},{"title":"Dismiss Google Ads insight","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/analytics/insights/dismiss","href":"/api-reference/dismiss-google-ads-insight"},{"title":"List Google Ads search terms","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/search-terms","href":"/api-reference/list-google-ads-search-terms"},{"title":"List Google Ads asset performance","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/asset-performance","href":"/api-reference/list-google-ads-asset-performance"},{"title":"List Google Ads top asset combinations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/analytics/asset-group-top-combinations","href":"/api-reference/list-google-ads-top-asset-combinations"}]},{"group":"Conversions","pages":[{"title":"Scan Google Ads conversion tracking","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/tracking-scan","href":"/api-reference/scan-google-ads-conversion-tracking"},{"title":"Build Google Ads tracking fix prompt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/tracking-scan/build-bootstrap-prompt","href":"/api-reference/build-google-ads-tracking-fix-prompt"},{"title":"Get Google Ads tracking script","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/tracking-script","href":"/api-reference/get-google-ads-tracking-script"},{"title":"List Google Ads conversion actions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/conversion-actions","href":"/api-reference/list-google-ads-conversion-actions"},{"title":"List Google Ads conversion mappings","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/conversion-mappings","href":"/api-reference/list-google-ads-conversion-mappings"},{"title":"Create Google Ads conversion mapping","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/conversion-mappings","href":"/api-reference/create-google-ads-conversion-mapping"},{"title":"Update Google Ads conversion mapping","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/apps/{app_id}/google-ads/conversion-mappings/{mapping_id}","href":"/api-reference/update-google-ads-conversion-mapping"},{"title":"Delete Google Ads conversion mapping","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/apps/{app_id}/google-ads/conversion-mappings/{mapping_id}","href":"/api-reference/delete-google-ads-conversion-mapping"},{"title":"Upload Google Ads conversions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/conversions/upload","href":"/api-reference/upload-google-ads-conversions"},{"title":"Upload enhanced Google Ads conversions","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/conversions/upload-enhanced","href":"/api-reference/upload-enhanced-google-ads-conversions"},{"title":"Get Google Ads conversion stats","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/conversions/stats","href":"/api-reference/get-google-ads-conversion-stats"}]},{"group":"Billing","pages":[{"title":"Get Google Ads billing status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/status","href":"/api-reference/get-google-ads-billing-status"},{"title":"Create Google Ads payment setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/billing/payment-setup","href":"/api-reference/create-google-ads-payment-setup"},{"title":"Create embedded Google Ads payment setup","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/billing/payment-setup-embedded","href":"/api-reference/create-embedded-google-ads-payment-setup"},{"title":"List Google Ads invoices","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/invoices","href":"/api-reference/list-google-ads-invoices"},{"title":"List Google Ads promotional credits","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/credits","href":"/api-reference/list-google-ads-promotional-credits"},{"title":"List Google Ads incentives","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/incentives","href":"/api-reference/list-google-ads-incentives"},{"title":"Apply a Google Ads incentive","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/accounts/{account_id}/incentives/apply","href":"/api-reference/apply-a-google-ads-incentive"},{"title":"Get Google Ads account debt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/accounts/{account_id}/billing/debt","href":"/api-reference/get-google-ads-account-debt"},{"title":"Get Google Ads workspace debt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/billing/workspace-debt","href":"/api-reference/get-google-ads-workspace-debt"},{"title":"Pay Google Ads workspace debt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/billing/workspace-pay-now","href":"/api-reference/pay-google-ads-workspace-debt"}]},{"group":"Suggestions and lookups","pages":[{"title":"Search Google Ads locations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/geo-targets/search","href":"/api-reference/search-google-ads-locations"},{"title":"List Google Ads advertising languages","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/languages","href":"/api-reference/list-google-ads-advertising-languages"},{"title":"Suggest Google Ads setup targeting","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/setup-suggestions","href":"/api-reference/suggest-google-ads-setup-targeting"},{"title":"Suggest Google Ads setup keyword themes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/setup-suggestions/keyword-themes","href":"/api-reference/suggest-google-ads-setup-keyword-themes"},{"title":"Regenerate a Google Ads setup keyword theme","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/setup-suggestions/regenerate-keyword","href":"/api-reference/regenerate-a-google-ads-setup-keyword-theme"},{"title":"Autocomplete Google Ads keyword themes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/suggestions/keyword-themes","href":"/api-reference/autocomplete-google-ads-keyword-themes"},{"title":"Suggest Google Ads search themes","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/suggestions/search-themes","href":"/api-reference/suggest-google-ads-search-themes"},{"title":"Suggest Google Ads text assets","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/suggestions/text-assets","href":"/api-reference/suggest-google-ads-text-assets"},{"title":"Generate Google Ads ad copy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/ai/generate-copy","href":"/api-reference/generate-google-ads-ad-copy"},{"title":"Enhance a Google Ads image prompt","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/suggestions/enhance-prompt","href":"/api-reference/enhance-a-google-ads-image-prompt"},{"title":"Get a Google Ads hero preview","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/google-ads/ai/hero-preview","href":"/api-reference/get-a-google-ads-hero-preview"},{"title":"Ask the Google Ads assistant","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/google-ads/troubleshoot/ask","href":"/api-reference/ask-the-google-ads-assistant"}]}]},{"group":"Embed Tokens","icon":"key","pages":[{"title":"Create an embed sign-in token","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/apps/{app_id}/embed-url","href":"/api-reference/create-an-embed-sign-in-token"}]},{"group":"Socket sessions","icon":"tower-broadcast","pages":[{"title":"Socket sessions","sidebarTitle":"Overview","href":"/developers/references/apps-api/sections/socket-sessions"},{"title":"Socket messages","sidebarTitle":"Socket messages","href":"/developers/references/apps-api/sections/socket-messages"},{"title":"Create socket session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/v1/socket-sessions","href":"/api-reference/create-socket-session"},{"title":"Add app to session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/v1/socket-sessions/{session_id}/apps/{app_id}","href":"/api-reference/add-app-to-session"},{"title":"Remove app from session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/v1/socket-sessions/{session_id}/apps/{app_id}","href":"/api-reference/remove-app-from-session"},{"title":"End socket session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/v1/socket-sessions/{session_id}","href":"/api-reference/end-socket-session"}]}]},{"group":"Workspace API (Beta)","boost":0.75,"icon":"building","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Workspace API Overview","sidebarTitle":"Overview","href":"/developers/references/workspace-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/workspace-api/get-started/authentication"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"Members","pages":[{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/members/list","href":"/api-reference/list-workspace-members"},{"title":"Update workspace member role","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/{email}/role","href":"/api-reference/update-workspace-member-role"},{"title":"Update workspace member roles in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/bulk/role","href":"/api-reference/update-workspace-member-roles-in-bulk"},{"title":"Remove workspace member","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/members/{email}","href":"/api-reference/remove-workspace-member"},{"title":"Remove workspace members in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/members/bulk/remove","href":"/api-reference/remove-workspace-members-in-bulk"}]},{"group":"Groups","pages":[{"title":"List workspace groups","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/groups","href":"/api-reference/list-workspace-groups"},{"title":"Create workspace group","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/groups","href":"/api-reference/create-workspace-group"},{"title":"Update workspace group","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/groups/{group_id}","href":"/api-reference/update-workspace-group"},{"title":"Delete workspace group","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/groups/{group_id}","href":"/api-reference/delete-workspace-group"},{"title":"List group members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/groups/{group_id}/members","href":"/api-reference/list-group-members"},{"title":"Add group members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/groups/{group_id}/members","href":"/api-reference/add-group-members"},{"title":"Remove group members","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/groups/{group_id}/members/remove","href":"/api-reference/remove-group-members"}]},{"group":"Invitations","pages":[{"title":"Invite workspace member","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/invite","href":"/api-reference/invite-workspace-member"},{"title":"Invite workspace members in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/bulk-invite","href":"/api-reference/invite-workspace-members-in-bulk"},{"title":"Resend workspace invitation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/resend","href":"/api-reference/resend-workspace-invitation"},{"title":"Resend workspace invitations in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/invitations/bulk-resend","href":"/api-reference/resend-workspace-invitations-in-bulk"}]},{"group":"Credit limits","pages":[{"title":"Set default member credit limit","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/default-credit-limit","href":"/api-reference/set-default-member-credit-limit"},{"title":"Set member credit limit","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/{email}/credit-limit","href":"/api-reference/set-member-credit-limit"},{"title":"Set member credit limits in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/members/bulk/credit-limit","href":"/api-reference/set-member-credit-limits-in-bulk"}]},{"group":"App folders","pages":[{"title":"List app folders","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/app-folders/tree","href":"/api-reference/list-app-folders"},{"title":"Create app folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-folders","href":"/api-reference/create-app-folder"},{"title":"Update app folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/app-folders/{item_id}","href":"/api-reference/update-app-folder"},{"title":"Delete app folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/app-folders/{item_id}","href":"/api-reference/delete-app-folder"},{"title":"Add apps to folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/app-folders/{folder_id}/items","href":"/api-reference/add-apps-to-folder"},{"title":"Remove app from folder","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/app-folders/{folder_id}/items/{app_id}","href":"/api-reference/remove-app-from-folder"}]},{"group":"Fonts","pages":[{"title":"List workspace fonts","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/fonts","href":"/api-reference/list-workspace-fonts"},{"title":"Upload workspace font","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/fonts","href":"/api-reference/upload-workspace-font"},{"title":"Get workspace font","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/fonts/{font_id}","href":"/api-reference/get-workspace-font"},{"title":"Delete workspace font","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/fonts/{font_id}","href":"/api-reference/delete-workspace-font"}]},{"group":"Connectors","pages":[{"title":"List workspace connectors","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/connectors","href":"/api-reference/list-workspace-connectors"},{"title":"Create workspace connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/{workspace_id}/connectors","href":"/api-reference/create-workspace-connector"},{"title":"Update workspace connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connectors/{connector_id}","href":"/api-reference/update-workspace-connector"},{"title":"Delete workspace connector","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/{workspace_id}/connectors/{connector_id}","href":"/api-reference/delete-workspace-connector"}]},{"group":"Connector governance","pages":[{"title":"Get workspace connector policies","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/connector-governance","href":"/api-reference/get-workspace-connector-policies"},{"title":"Update builder connection policy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connector-governance/{integration_type}/builder-connection","href":"/api-reference/update-builder-connection-policy"},{"title":"Update per-user connection policy","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connector-governance/{integration_type}/per-user-connection","href":"/api-reference/update-per-user-connection-policy"},{"title":"Update workspace connector policies in bulk","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/connector-governance/bulk","href":"/api-reference/update-workspace-connector-policies-in-bulk"}]},{"group":"Brands","pages":[{"title":"List workspace brands","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/brands","href":"/api-reference/list-workspace-brands"},{"title":"Create workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/{workspace_id}/brands","href":"/api-reference/create-workspace-brand"},{"title":"Generate workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/{workspace_id}/brands/generate","href":"/api-reference/generate-workspace-brand"},{"title":"Get workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/{workspace_id}/brands/{brand_id}","href":"/api-reference/get-workspace-brand"},{"title":"Update workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/brands/{brand_id}","href":"/api-reference/update-workspace-brand"},{"title":"Delete workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/{workspace_id}/brands/{brand_id}","href":"/api-reference/delete-workspace-brand"},{"title":"Set default workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/{workspace_id}/brands/{brand_id}/default","href":"/api-reference/set-default-workspace-brand"},{"title":"Clear default workspace brand","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/{workspace_id}/brands/{brand_id}/default","href":"/api-reference/clear-default-workspace-brand"}]},{"group":"Skills","pages":[{"title":"List workspace skills","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/skills","href":"/api-reference/list-workspace-skills"},{"title":"Get workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/workspace/skills/{skill_id}","href":"/api-reference/get-workspace-skill"},{"title":"Create workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/workspace/skills","href":"/api-reference/create-workspace-skill"},{"title":"Update workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json put /api/workspace/skills/{skill_id}","href":"/api-reference/update-workspace-skill"},{"title":"Delete workspace skill","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/workspace/skills/{skill_id}","href":"/api-reference/delete-workspace-skill"}]},{"group":"Billing","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/tiers","href":"/api-reference/list-plans"},{"title":"Get billing info","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/billing-info","href":"/api-reference/get-billing-info"},{"title":"Get mobile subscription status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/mobile/subscription-status","href":"/api-reference/get-mobile-subscription-status"},{"title":"Create billing portal session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/create-portal-session","href":"/api-reference/create-billing-portal-session"},{"title":"Create payment method update session","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/create-update-payment-method-portal-session","href":"/api-reference/create-payment-method-update-session"},{"title":"Open invoice","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/open-invoice/{invoice_id}","href":"/api-reference/open-invoice"},{"title":"Retry failed payment","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/retry-payment","href":"/api-reference/retry-failed-payment"},{"title":"Preview plan change","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/preview-upgrade/{price_id}","href":"/api-reference/preview-plan-change"},{"title":"Create plan checkout","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/create-checkout-session/{price_id}","href":"/api-reference/create-plan-checkout"},{"title":"Change plan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/update-subscription/{price_id}","href":"/api-reference/change-plan"},{"title":"Preview Wix plan change","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/dynamic-offering/preview-subscription","href":"/api-reference/preview-wix-plan-change"},{"title":"Change Wix plan","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/dynamic-offering/update-subscription","href":"/api-reference/change-wix-plan"},{"title":"Turn on auto-renew","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/wix-turn-auto-renew-on","href":"/api-reference/turn-on-auto-renew"},{"title":"Get cancellation impact","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/cancel-subscription/impact","href":"/api-reference/get-cancellation-impact"},{"title":"Preview ILS refund","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/ils-refund-preview","href":"/api-reference/preview-ils-refund"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/cancel-subscription","href":"/api-reference/cancel-subscription"},{"title":"Reactivate subscription","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/reactivate-subscription","href":"/api-reference/reactivate-subscription"},{"title":"Cancel scheduled plan change","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/billing/cancel-schedule","href":"/api-reference/cancel-scheduled-plan-change"},{"title":"Refresh Google Play subscription","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/mobile/google-play/refresh","href":"/api-reference/refresh-google-play-subscription"}]},{"group":"Business email","pages":[{"title":"Get business email status","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/business-email/status","href":"/api-reference/get-business-email-status"},{"title":"Get business email discount","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/business-email/discount","href":"/api-reference/get-business-email-discount"},{"title":"Get business email purchase link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/business-email/purchase-url","href":"/api-reference/get-business-email-purchase-link"},{"title":"Get business email setup link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/business-email/setup-url","href":"/api-reference/get-business-email-setup-link"},{"title":"Get business email management link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/billing/business-email/manage-url","href":"/api-reference/get-business-email-management-link"},{"title":"Get business email admin console link","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/billing/business-email/admin-console-url","href":"/api-reference/get-business-email-admin-console-link"}]}]}]},{"group":"Superagents API (Beta)","boost":0.75,"icon":"user-robot","pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Superagents API Overview","sidebarTitle":"Overview","href":"/developers/references/superagents-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/superagents-api/get-started/authentication"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"title":"Create Superagent","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents","href":"/api-reference/create-superagent"},{"title":"List Superagent conversations","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/conversations","href":"/api-reference/list-superagent-conversations"},{"title":"Create Superagent conversation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/conversations","href":"/api-reference/create-superagent-conversation"},{"title":"Get Superagent conversation","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/conversations/{conversation_id}","href":"/api-reference/get-superagent-conversation"},{"title":"Send Superagent message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/conversations/{conversation_id}/messages","href":"/api-reference/send-superagent-message"},{"title":"Delete Superagent message","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/agents/{agent_id}/conversations/{conversation_id}/messages/{message_id}","href":"/api-reference/delete-superagent-message"},{"title":"List Superagent memories","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/memory","href":"/api-reference/list-superagent-memories"},{"title":"Delete Superagent memory","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/agents/{agent_id}/memory/{memory_id}","href":"/api-reference/delete-superagent-memory"},{"title":"List Superagent webhooks","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json get /api/agents/{agent_id}/webhooks","href":"/api-reference/list-superagent-webhooks"},{"title":"Create Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/webhooks","href":"/api-reference/create-superagent-webhook"},{"title":"Update Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json patch /api/agents/{agent_id}/webhooks/{webhook_id}","href":"/api-reference/update-superagent-webhook"},{"title":"Test Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/webhooks/{webhook_id}/test","href":"/api-reference/test-superagent-webhook"},{"title":"Delete Superagent webhook","deprecated":null,"version":null,"openapi":"/developers/references/app-management/app-management-openapi.json delete /api/agents/{agent_id}/webhooks/{webhook_id}","href":"/api-reference/delete-superagent-webhook"}]}]},{"group":"Monitoring API","icon":"chart-line","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Enterprise Monitoring API Overview","href":"/developers/references/monitoring-api/get-started/overview"},{"title":"Authentication","href":"/developers/references/monitoring-api/get-started/authentication"},{"title":"Rate Limits","href":"/developers/references/monitoring-api/get-started/rate-limits"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"system","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /health","href":"/api-reference/monitoring/system/health-check"}]},{"group":"analytics","pages":[{"title":"Get analytics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /analytics/{workspace_id}","href":"/api-reference/monitoring/analytics/get-analytics"}]},{"group":"users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users","href":"/api-reference/monitoring/users/list-users"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users/{user_id}","href":"/api-reference/monitoring/users/get-user"},{"title":"List user apps","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users/{user_id}/apps","href":"/api-reference/monitoring/users/list-user-apps"},{"title":"List user Superagents","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/users/{user_id}/superagents","href":"/api-reference/monitoring/users/list-user-superagents"}]},{"group":"apps","pages":[{"title":"List app metrics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/apps","href":"/api-reference/monitoring/apps/list-app-metrics"},{"title":"Get app analytics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/apps/{app_id}/analytics","href":"/api-reference/monitoring/apps/get-app-analytics"}]},{"group":"superagents","pages":[{"title":"List Superagents","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/superagents","href":"/api-reference/monitoring/superagents/list-superagents"},{"title":"Get Superagent analytics","deprecated":null,"version":null,"openapi":"/developers/references/monitoring-api/monitoring-openapi.json get /{workspace_id}/superagents/{agent_id}/analytics","href":"/api-reference/monitoring/superagents/get-superagent-analytics"}]}]}]},{"group":"Audit Logs API","icon":"clipboard-list","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Audit Logs API Overview","href":"/developers/references/audit-logs-api/get-started/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/references/audit-logs-api/get-started/authentication"},{"title":"Rate Limits","href":"/developers/references/audit-logs-api/get-started/rate-limits"},{"title":"Event Types","sidebarTitle":"Event Types","href":"/developers/references/audit-logs-api/get-started/event-types"},{"title":"Security scan findings","sidebarTitle":"Security scan findings","href":"/developers/references/audit-logs-api/get-started/security-scan-findings"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"audit-logs","pages":[{"title":"Get security scan findings","deprecated":null,"version":null,"openapi":"/developers/references/audit-logs-api/audit-logs-openapi.json get /{workspace_id}/security-scan-runs/{run_id}","href":"/api-reference/audit-logs/get-security-scan-findings"},{"title":"List audit logs","deprecated":null,"version":null,"openapi":"/developers/references/audit-logs-api/audit-logs-openapi.json post /{workspace_id}/list","href":"/api-reference/audit-logs/list-audit-logs"}]}]}]},{"group":"Outbound webhooks","icon":"paper-plane","expanded":false,"pages":[{"group":"Get Started","icon":"book-open","pages":[{"title":"Outbound webhooks overview","sidebarTitle":"Overview","href":"/developers/references/outbound-webhooks/get-started/overview"},{"title":"Setting up endpoints","sidebarTitle":"Setting up endpoints","href":"/developers/references/outbound-webhooks/get-started/setting-up-endpoints"},{"title":"Verifying requests","sidebarTitle":"Verifying requests","href":"/developers/references/outbound-webhooks/get-started/verifying-requests"},{"title":"Event types","sidebarTitle":"Event types","href":"/developers/references/outbound-webhooks/get-started/event-types"},{"title":"Delivery and retries","sidebarTitle":"Delivery and retries","href":"/developers/references/outbound-webhooks/get-started/delivery-and-retries"}]},{"group":"Events","boost":0.5,"icon":"bolt","pages":[{"title":"app.created.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.created.v1","href":"/developers/references/outbound-webhooks/events/app-created-v1"},{"title":"app.published.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.published.v1","href":"/developers/references/outbound-webhooks/events/app-published-v1"},{"title":"app.unpublished.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.unpublished.v1","href":"/developers/references/outbound-webhooks/events/app-unpublished-v1"},{"title":"app.deleted.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.deleted.v1","href":"/developers/references/outbound-webhooks/events/app-deleted-v1"},{"title":"app.restored.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.restored.v1","href":"/developers/references/outbound-webhooks/events/app-restored-v1"},{"title":"chat.turn_started.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_started.v1","href":"/developers/references/outbound-webhooks/events/chat-turn-started-v1"},{"title":"chat.turn_ended.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_ended.v1","href":"/developers/references/outbound-webhooks/events/chat-turn-ended-v1"},{"title":"webhook.test.v1","openapi":"developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook webhook.test.v1","href":"/developers/references/outbound-webhooks/events/webhook-test-v1"}]},{"group":"API Reference","icon":"brackets-curly","pages":[{"group":"outbound-webhooks","pages":[{"title":"List endpoints","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json get /endpoints","href":"/api-reference/outbound-webhooks/list-endpoints"},{"title":"Register an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints","href":"/api-reference/outbound-webhooks/register-an-endpoint"},{"title":"Get an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json get /endpoints/{endpoint_id}","href":"/api-reference/outbound-webhooks/get-an-endpoint"},{"title":"Delete an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json delete /endpoints/{endpoint_id}","href":"/api-reference/outbound-webhooks/delete-an-endpoint"},{"title":"Update an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json patch /endpoints/{endpoint_id}","href":"/api-reference/outbound-webhooks/update-an-endpoint"},{"title":"Test an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints/{endpoint_id}/test","href":"/api-reference/outbound-webhooks/test-an-endpoint"},{"title":"Pause an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints/{endpoint_id}/pause","href":"/api-reference/outbound-webhooks/pause-an-endpoint"},{"title":"Resume an endpoint","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json post /endpoints/{endpoint_id}/resume","href":"/api-reference/outbound-webhooks/resume-an-endpoint"},{"title":"Get the public key set","deprecated":null,"version":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json get /workspaces/{workspace_id}/keys","href":"/api-reference/outbound-webhooks/get-the-public-key-set"}]},{"group":"events","pages":[{"title":"An app was created","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.created.v1","href":"/api-reference/events/an-app-was-created"},{"title":"An app version was published","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.published.v1","href":"/api-reference/events/an-app-version-was-published"},{"title":"An app was taken offline","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.unpublished.v1","href":"/api-reference/events/an-app-was-taken-offline"},{"title":"An app was moved to trash restorable not erased","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.deleted.v1","href":"/api-reference/events/an-app-was-moved-to-trash-restorable-not-erased"},{"title":"An app was restored from trash","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook app.restored.v1","href":"/api-reference/events/an-app-was-restored-from-trash"},{"title":"The ai started working on a message","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_started.v1","href":"/api-reference/events/the-ai-started-working-on-a-message"},{"title":"The ai finished responding to a message","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook chat.turn_ended.v1","href":"/api-reference/events/the-ai-finished-responding-to-a-message"},{"title":"Endpoint activation test","version":null,"deprecated":null,"openapi":"/developers/references/outbound-webhooks/outbound-webhooks-openapi.json webhook webhook.test.v1","href":"/api-reference/events/endpoint-activation-test"}]}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"White label (Beta)","icon":"tag","groups":[{"group":"Start here","icon":"flag","pages":[{"title":"White Label Overview","sidebarTitle":"Overview","href":"/developers/white-label/overview"},{"title":"Setup checklist","sidebarTitle":"Setup checklist","href":"/developers/white-label/setup-checklist"},{"title":"Tenancy and credentials","sidebarTitle":"Tenancy and credentials","href":"/developers/white-label/tenancy-and-credentials"}]},{"group":"Configure","icon":"gear","pages":[{"title":"Configuring your system prompt","sidebarTitle":"System prompt","href":"/developers/white-label/system-prompt"},{"title":"Design system","sidebarTitle":"Design system","href":"/developers/white-label/design-system"},{"title":"Skills and MCP","sidebarTitle":"Skills and MCP","href":"/developers/white-label/skills-and-mcp"},{"title":"Custom instructions","sidebarTitle":"Custom instructions","href":"/developers/white-label/custom-instructions"}]},{"group":"Build an app","icon":"hammer","pages":[{"title":"The build turn","sidebarTitle":"The build turn","href":"/developers/white-label/the-build-turn"},{"title":"Live updates","sidebarTitle":"Live updates","href":"/developers/white-label/live-updates"},{"title":"Embed the app","sidebarTitle":"Embed the app","href":"/developers/white-label/embed-the-app"},{"title":"Common APIs","description":"The most common APIs to call when building your white label integration.","sidebarTitle":"Common APIs","href":"/developers/white-label/common-apis"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"Skills","icon":"wand-magic-sparkles","hidden":true,"groups":[{"group":"base44-cli","boost":0.3,"hidden":true,"pages":[{"title":"Base44 CLI","description":"The base44 CLI is used for EVERYTHING related to base44 projects: resource configuration (entities, backend functions, realtime actors, ai agents), initialization and actions (resource creation, deployment), and any other operation on an existing app or workspace through the Base44 public API (settings, domains, users, members, source export). This skill is the place for learning about how to configure resources, including actors — the realtime/WebSocket primitive behind multiplayer, collaborative boards, presence and live cursors, in-room chat, and live auctions. When you plan or implement a feature, you must learn this skill","href":"/developers/skills/base44-cli/index"},{"title":"Creating Actors","description":"Actors are Base44's realtime primitive: stateful server rooms over WebSockets. There is exactly one live instance per room id, and every client connected to that id shares it. The actor is authorit...","href":"/developers/skills/base44-cli/references/actors-create"},{"title":"base44 actors deploy","description":"Deploy local actor definitions to Base44.","href":"/developers/skills/base44-cli/references/actors-deploy"},{"title":"base44 agent-skills pull","description":"Pull agent skills from Base44 to local files. Agent skills are reusable instructions that extend what your app's AI agents know how to do, authored as Markdown files with a YAML frontmatter descrip...","href":"/developers/skills/base44-cli/references/agent-skills-pull"},{"title":"base44 agent-skills push","description":"Push local agent skills to Base44. Agent skills are reusable instructions that extend what your app's AI agents know how to do.","href":"/developers/skills/base44-cli/references/agent-skills-push"},{"title":"base44 agents pull","description":"Pull AI agent configurations from Base44 to local files. Agents are conversational AI assistants that can interact with users, access your app's entities, and call backend functions.","href":"/developers/skills/base44-cli/references/agents-pull"},{"title":"base44 agents push","description":"Push local AI agent configurations to Base44. Agents are conversational AI assistants that can interact with users, access your app's entities, and call backend functions.","href":"/developers/skills/base44-cli/references/agents-push"},{"title":"base44 api catalog","description":"List the public Base44 API's areas, or every operation in one area. Use it to browse when you don't know what to search for.","href":"/developers/skills/base44-cli/references/api-catalog"},{"title":"base44 api fetch","description":"Call any public Base44 API operation (Apps API and Workspace API) with your CLI login; no API key or personal access token is needed. Add --help after the method and path to print the operation's c...","href":"/developers/skills/base44-cli/references/api-fetch"},{"title":"base44 api grep","description":"Search the public Base44 API spec with a regular expression, for when api search misses. For example, find every operation that sends or returns a field such as noindex.","href":"/developers/skills/base44-cli/references/api-grep"},{"title":"base44 api search","description":"Search every public Base44 API operation (Apps API and Workspace API) by what it does. This is usually the first step before api fetch.","href":"/developers/skills/base44-cli/references/api-search"},{"title":"base44 login","description":"Authenticate with Base44 using device code flow.","href":"/developers/skills/base44-cli/references/auth-login"},{"title":"base44 logout","description":"Logout from current device and clear stored authentication data.","href":"/developers/skills/base44-cli/references/auth-logout"},{"title":"base44 auth password-login","description":"Enable or disable username \u0026 password authentication for your Base44 app.","href":"/developers/skills/base44-cli/references/auth-password-login"},{"title":"base44 auth pull","description":"Pull the auth configuration from Base44 to local files.","href":"/developers/skills/base44-cli/references/auth-pull"},{"title":"base44 auth push","description":"Push the local auth configuration to Base44.","href":"/developers/skills/base44-cli/references/auth-push"},{"title":"base44 auth social-login","description":"Enable or disable social login providers for your app (Google, Microsoft, Facebook, Apple). Auth config changes are local until you run base44 auth push or base44 deploy.","href":"/developers/skills/base44-cli/references/auth-social-login"},{"title":"base44 auth sso","description":"Configure an SSO (Single Sign-On) identity provider for your app. Supports Google, Microsoft, GitHub, Okta, and custom OIDC providers. Auth config changes are local until you run base44 auth push o...","href":"/developers/skills/base44-cli/references/auth-sso"},{"title":"base44 whoami","description":"Display the currently authenticated user.","href":"/developers/skills/base44-cli/references/auth-whoami"},{"title":"Creating Connectors","description":"Connectors are OAuth integrations that let your Base44 app connect to external services like Google Calendar, Slack, Notion, and more. Once connected, you can use access tokens in backend functions...","href":"/developers/skills/base44-cli/references/connectors-create"},{"title":"base44 connectors initiate","description":"Initialize a connector on an app and start its OAuth flow. Unlike connectors push, this works projectless — it only needs an app id, not a local project directory.","href":"/developers/skills/base44-cli/references/connectors-initiate"},{"title":"base44 connectors list-available","description":"List all integration types available in the Base44 connector catalog.","href":"/developers/skills/base44-cli/references/connectors-list-available"},{"title":"base44 connectors pull","description":"Pull connector configurations from Base44 to local files. Replaces all local connector configs with the remote versions.","href":"/developers/skills/base44-cli/references/connectors-pull"},{"title":"base44 connectors push","description":"Push local connector configurations to Base44, adding new connectors, updating scopes, and handling OAuth authorization. Remote connectors missing locally are only removed with --force.","href":"/developers/skills/base44-cli/references/connectors-push"},{"title":"base44 create","description":"Creates a new Base44 project from a template. This command is framework-agnostic and can either scaffold a complete project or add Base44 configuration to an existing project.","href":"/developers/skills/base44-cli/references/create"},{"title":"base44 dashboard open","description":"Opens the Base44 app dashboard in your default web browser.","href":"/developers/skills/base44-cli/references/dashboard"},{"title":"base44 deploy","description":"Deploys all project resources (entities, functions, actors, agents, agent skills, connectors, and site) to Base44 in a single command.","href":"/developers/skills/base44-cli/references/deploy"},{"title":"base44 dev","description":"Start local development for a linked Base44 project.","href":"/developers/skills/base44-cli/references/dev"},{"title":"base44 eject","description":"Download the code for an existing Base44 project to your local machine.","href":"/developers/skills/base44-cli/references/eject"},{"title":"Creating Entities","description":"Base44 entities are defined locally in your project and then pushed to the Base44 backend.","href":"/developers/skills/base44-cli/references/entities-create"},{"title":"base44 entities push","description":"Push local entity definitions to Base44.","href":"/developers/skills/base44-cli/references/entities-push"},{"title":"base44 exec","description":"Run a script with the Base44 SDK pre-authenticated as the current user. Reads the script from stdin.","href":"/developers/skills/base44-cli/references/exec"},{"title":"Creating Functions","description":"Base44 functions are serverless backend functions. They are defined locally in your project and deployed to the Base44 backend.","href":"/developers/skills/base44-cli/references/functions-create"},{"title":"base44 functions delete","description":"Delete one or more deployed functions from Base44.","href":"/developers/skills/base44-cli/references/functions-delete"},{"title":"base44 functions deploy","description":"Deploy local function definitions to Base44.","href":"/developers/skills/base44-cli/references/functions-deploy"},{"title":"base44 functions list","description":"List all deployed functions on Base44 remote.","href":"/developers/skills/base44-cli/references/functions-list"},{"title":"base44 functions pull","description":"Pull deployed functions from Base44 to local files.","href":"/developers/skills/base44-cli/references/functions-pull"},{"title":"base44 link","description":"Links an existing local Base44 project to a Base44 app in the cloud. Use this when you have a base44/config.jsonc but haven't connected it to a Base44 app yet.","href":"/developers/skills/base44-cli/references/link"},{"title":"RLS Examples","description":"Practical Row-Level Security patterns for common application types.","href":"/developers/skills/base44-cli/references/rls-examples"},{"title":"base44 scaffold","description":"Scaffolds a local project for an existing Base44 app. Use this when you already have a Base44 app (you know its app ID) and want to set up the local project files to work with it. Runs fully non-in...","href":"/developers/skills/base44-cli/references/scaffold"},{"title":"base44 secrets delete","description":"Delete a secret from the current project.","href":"/developers/skills/base44-cli/references/secrets-delete"},{"title":"base44 secrets list","description":"List the names of all secrets configured for the current project.","href":"/developers/skills/base44-cli/references/secrets-list"},{"title":"base44 secrets set","description":"Set one or more project secrets (environment variables stored in Base44).","href":"/developers/skills/base44-cli/references/secrets-set"},{"title":"base44 site deploy","description":"Deploy built site files to Base44 hosting.","href":"/developers/skills/base44-cli/references/site-deploy"},{"title":"base44 site open","description":"Opens the published site in your default web browser.","href":"/developers/skills/base44-cli/references/site-open"},{"title":"`base44 types generate`","description":"Generate TypeScript declaration file (types.d.ts) from project resources (entities, functions, actors, agents, connectors).","href":"/developers/skills/base44-cli/references/types-generate"},{"title":"base44 visibility","description":"Set the app's visibility on the Base44 server.","href":"/developers/skills/base44-cli/references/visibility"},{"title":"base44 workflows list","description":"List this app's workflows with their status and run summary.","href":"/developers/skills/base44-cli/references/workflows-list"},{"title":"base44 workflows runs","description":"List workflow runs for this app, newest first. This is the fastest way to answer \"did my scheduled work fail, and why\" — each failed run carries the task that failed and the underlying error.","href":"/developers/skills/base44-cli/references/workflows-runs"},{"title":"base44 workspace get","description":"Show details for a single workspace by ID.","href":"/developers/skills/base44-cli/references/workspace-get"},{"title":"base44 workspace list","description":"List the workspaces (organizations) you belong to.","href":"/developers/skills/base44-cli/references/workspace-list"},{"title":"base44 workspace move","description":"Move the current app to another workspace (organization).","href":"/developers/skills/base44-cli/references/workspace-move"}]},{"group":"base44-platform-actors","boost":0.3,"hidden":true,"pages":[{"title":"Base44 actors","description":"Base44 realtime actors: stateful server rooms over WebSockets (Durable Objects) under base44/actors/\u003cName>/entry.ts for multiplayer, collaborative boards, presence, live cursors, chat rooms and auctions, with the actor contract, rules and the React client. Use when users interact live in one shared session.","href":"/developers/skills/base44-platform-actors/index"},{"title":"Base44 actors: Realtime actors (mobile apps)","href":"/developers/skills/base44-platform-actors/references/mobile"},{"title":"Base44 actors: Realtime actors (web apps)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-actors/references/web"}]},{"group":"base44-platform-agents","boost":0.3,"hidden":true,"pages":[{"title":"Base44 agents","description":"Base44 in-app AI agents: JSON agent configs under base44/agents/ with entity, backend-function or server-route tools, WhatsApp and Telegram channels, the agents SDK for conversation UIs, and code agents (an agent loop the app runs on the AI gateway). Use when the app needs a conversational assistant or programmable AI.","href":"/developers/skills/base44-platform-agents/index"},{"title":"Base44 agents: Agents (Vite SPA: tools are backend functions)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-agents/references/web-spa"},{"title":"Base44 agents: Agents (TanStack Start: tools are server routes)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-agents/references/web-tanstack"}]},{"group":"base44-platform-backend-functions","boost":0.3,"hidden":true,"pages":[{"title":"Base44 backend functions","description":"Base44 server-side code: backend functions (HTTP handlers in base44/functions/\u003cname>/entry.ts on Cloudflare Workers) for Vite SPA apps, or TanStack Start server functions and server routes. Secrets, the Base44 SDK on the server, auth and service role, webhooks, admin-only handlers, frontend invocation, testing, and the InvokeLLM model table. Use when the app needs external APIs, privileged logic or scheduled work.","href":"/developers/skills/base44-platform-backend-functions/index"},{"title":"Mobile","href":"/developers/skills/base44-platform-backend-functions/references/mobile"},{"title":"Base44 backend functions: Backend functions (Vite SPA)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-backend-functions/references/web-spa"},{"title":"Base44 backend functions: Server functions and server routes (TanStack Start)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-backend-functions/references/web-tanstack"}]},{"group":"base44-platform-connectors","boost":0.3,"hidden":true,"pages":[{"title":"Base44 connectors","description":"Base44 app connectors: OAuth integrations with external services (Google, Slack, GitHub and more) in shared, app-user and BYO-shared modes, how to connect one from an external agent, and how server code reads the token with getConnection. Use when the app must act on a user's or the builder's account at a third-party service.","href":"/developers/skills/base44-platform-connectors/index"},{"title":"Mobile","href":"/developers/skills/base44-platform-connectors/references/mobile"},{"title":"Web spa","href":"/developers/skills/base44-platform-connectors/references/web-spa"},{"title":"Web tanstack","href":"/developers/skills/base44-platform-connectors/references/web-tanstack"}]},{"group":"base44-platform-entities","boost":0.3,"hidden":true,"pages":[{"title":"Base44 entities","description":"Base44 entities: the JSON-schema data models under base44/entities/, the entity SDK, and row-level security (RLS) rules. Use when adding or changing stored data, queries, or per-user access rules in a Base44 app.","href":"/developers/skills/base44-platform-entities/index"},{"title":"Mobile","href":"/developers/skills/base44-platform-entities/references/mobile"},{"title":"Base44 entities: Row-level security (RLS)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-entities/references/rls"},{"title":"Web","href":"/developers/skills/base44-platform-entities/references/web"}]},{"group":"base44-platform-frontend","boost":0.3,"hidden":true,"pages":[{"title":"Base44 frontend","description":"Frontend coding standards for Base44 web apps: code conventions, the installed packages, routing (React Router in the Vite SPA, file routes in TanStack Start), Tailwind and design tokens, styling and componentization rules, npm installs, and how files are edited in the sandbox. Use when writing or changing pages, components or routes.","href":"/developers/skills/base44-platform-frontend/index"},{"title":"Base44 frontend: Native mobile app (Expo, React Native, NativeWind)","description":"source commit is in /SOURCE_COMMIT at the repository root. Edits here are overwritten by","href":"/developers/skills/base44-platform-frontend/references/mobile"},{"title":"Web spa","href":"/developers/skills/base44-platform-frontend/references/web-spa"},{"title":"Web tanstack","href":"/developers/skills/base44-platform-frontend/references/web-tanstack"}]},{"group":"base44-platform-integrations-sdk","boost":0.3,"hidden":true,"pages":[{"title":"Base44 integrations sdk","description":"Base44 built-in integrations on the SDK client: InvokeLLM, SendEmail, file uploads (public and private), signed URLs, data extraction and image generation, with every Core endpoint's input schema, plus analytics event tracking. Use when a feature needs AI, email, files or analytics without a third-party service.","href":"/developers/skills/base44-platform-integrations-sdk/index"},{"title":"Mobile","href":"/developers/skills/base44-platform-integrations-sdk/references/mobile"},{"title":"Web spa","href":"/developers/skills/base44-platform-integrations-sdk/references/web-spa"},{"title":"Web tanstack","href":"/developers/skills/base44-platform-integrations-sdk/references/web-tanstack"}]},{"group":"base44-platform-platform","boost":0.3,"hidden":true,"pages":[{"title":"Base44 platform","description":"Base44 platform concepts for a web app: entities, backend functions or server code, workflows, pages and layouts, the project file structure, authentication (platform login vs the custom-auth boilerplate), user invites and the GitHub features. Read first when starting work on a Base44 web app.","href":"/developers/skills/base44-platform-platform/index"},{"title":"Mobile","href":"/developers/skills/base44-platform-platform/references/mobile"},{"title":"Web spa","href":"/developers/skills/base44-platform-platform/references/web-spa"},{"title":"Web tanstack","href":"/developers/skills/base44-platform-platform/references/web-tanstack"}]},{"group":"base44-platform-workflows","boost":0.3,"hidden":true,"pages":[{"title":"Base44 workflows","description":"Base44 workflows: trigger-driven automated processes defined as CNCF Serverless Workflow files under base44/workflows/ (scheduled, entity, connector, in-app agent, auth, publish and payment triggers; call, wait and switch steps; jq expressions), with the full authoring guide, plus the legacy automations pipeline for apps that predate workflows. Use for any 'when X happens, do Y' or 'every N hours, do Y'.","href":"/developers/skills/base44-platform-workflows/index"},{"title":"Automations legacy","href":"/developers/skills/base44-platform-workflows/references/automations-legacy"},{"title":"Backend functions","href":"/developers/skills/base44-platform-workflows/references/backend-functions"},{"title":"Mobile automations","href":"/developers/skills/base44-platform-workflows/references/mobile-automations"},{"title":"Web tanstack","href":"/developers/skills/base44-platform-workflows/references/web-tanstack"}]},{"group":"base44-remote-dev","boost":0.3,"hidden":true,"pages":[{"title":"Remotely develop a Base44 app over MCP","description":"Develop a Base44 app remotely from your own coding agent (Claude Code, claude.ai, or any MCP client) by connecting it to the Base44 sandbox. Cloud agents connect over MCP; local agents can connect over MCP or drive the same sandbox with the `base44 sandbox` CLI subcommands (the CLI uses shorter names — e.g. read_file is `sandbox read`, list_directory is `sandbox ls`, run_command is `sandbox run`). Covers connecting/ authenticating, the available sandbox tools (run_command, read_file, write_file, edit_file, grep, list_directory, create_checkpoint, list_user_apps, and the connector tools list_connectors / initiate_connector_connection), the edit→preview→verify loop, how changes persist, builder/external-agent concurrency, the in-editor \"Send to Coding Agent\" button + onboarding README URLs, and tips like reading the Vite dev-server logs. Triggers on \"develop my Base44 app remotely\", \"connect Claude Code to Base44\", \"bring my own agent\", \"edit a Base44 app over MCP\", \"Base44 sandbox MCP\", or \"Send to Coding Agent\".","href":"/developers/skills/base44-remote-dev/index"}]},{"group":"base44-sandbox","boost":0.3,"hidden":true,"pages":[{"title":"Base44 in the Cloud Sandbox","description":"Develop a Base44 app remotely inside Base44's cloud sandbox using your own agent — no local checkout and no deploy/push commands. The implementation is remote: writing a resource file into the sandbox is what ships it (backend functions, realtime actors, entities, and agents all auto-sync from the file you write), and OAuth connectors are set up against the remote app via MCP tools or the projectless `base44 connectors` CLI. This skill is the place for learning what you can author in the sandbox, how backend functions, actors, entities, and agents are structured, and how to connect a connector without a local filesystem. Triggers on 'develop my Base44 app remotely', 'no local files', 'cloud sandbox', 'create an entity/agent remotely', 'add realtime/multiplayer/presence remotely', 'connect a connector remotely', 'bring my own agent', or any work editing a Base44 app inside a sandbox.","href":"/developers/skills/base44-sandbox/index"}]},{"group":"base44-sdk","boost":0.3,"hidden":true,"pages":[{"title":"Base44 Coder","description":"The base44 SDK is the library to communicate with base44 services. In projects, you use it to communicate with remote resources (entities, backend functions, realtime actors, ai agents, and the AI gateway for code agents, image, video, and speech generation, and AI decisions) and to write backend functions and actors. This skill is the place for learning about available modules and types, including actors — the realtime/WebSocket primitive for multiplayer, collaborative boards, presence and live cursors, in-room chat, and live auctions. When you plan or implement a feature, you must learn this skill","href":"/developers/skills/base44-sdk/index"},{"title":"Base44 SDK Quick Reference","description":"Compact method signatures for all SDK modules. Verify against this before writing code.","href":"/developers/skills/base44-sdk/references/QUICK_REFERENCE"},{"title":"Actors Module","description":"Connect to realtime server rooms via base44.actors.","href":"/developers/skills/base44-sdk/references/actors"},{"title":"AI Gateway Module","description":"Call Base44's managed AI models from your own backend code via base44.asServiceRole.aiGateway.","href":"/developers/skills/base44-sdk/references/ai-gateway"},{"title":"Analytics Module","description":"Track custom events and user activity via base44.analytics.","href":"/developers/skills/base44-sdk/references/analytics"},{"title":"App Logs Module","description":"Log user activity in your app via base44.appLogs.","href":"/developers/skills/base44-sdk/references/app-logs"},{"title":"Auth Module","description":"User authentication, registration, and session management via base44.auth.","href":"/developers/skills/base44-sdk/references/auth"},{"title":"Agents Module","description":"AI agent conversations and messages via base44.agents.","href":"/developers/skills/base44-sdk/references/base44-agents"},{"title":"Client Setup","description":"How to create and configure the Base44 client.","href":"/developers/skills/base44-sdk/references/client"},{"title":"Connectors Module","description":"OAuth token management for external services.","href":"/developers/skills/base44-sdk/references/connectors"},{"title":"Entities Module","description":"CRUD operations on data models. Access via base44.entities.EntityName.method().","href":"/developers/skills/base44-sdk/references/entities"},{"title":"Functions Module","description":"Invoke custom backend functions via base44.functions.","href":"/developers/skills/base44-sdk/references/functions"},{"title":"Integrations Module","description":"Access third-party services via base44.integrations.","href":"/developers/skills/base44-sdk/references/integrations"},{"title":"SSO Module","description":"Single Sign-On (SSO) support for authenticating Base44 users with external systems. Available via base44.asServiceRole.sso.","href":"/developers/skills/base44-sdk/references/sso"},{"title":"Users Module","description":"Invite users to the app via base44.users.","href":"/developers/skills/base44-sdk/references/users"}]},{"group":"base44-troubleshooter","boost":0.3,"hidden":true,"pages":[{"title":"Troubleshoot Production Issues","description":"Troubleshoot production issues using backend function logs and workflow run history. Use when investigating app errors, debugging function calls, diagnosing why a scheduled job or automation failed, or diagnosing production problems in Base44 apps.","href":"/developers/skills/base44-troubleshooter/index"},{"title":"base44 logs","description":"Fetch function logs for this app.","href":"/developers/skills/base44-troubleshooter/references/project-logs"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}},{"dropdown":"Compliance API","icon":"shield-check","hidden":true,"groups":[{"group":"Compliance API","pages":[{"title":"Compliance API for security partners","description":"Integrate a security product with the Compliance API to inventory the security posture of a customer's Base44 workspace","sidebarTitle":"Overview","href":"/developers/references/compliance-api/get-started/overview"},{"title":"Authentication and scopes","description":"How security partners authenticate with the Compliance API, and how customers grant them access to a workspace","sidebarTitle":"Authentication","href":"/developers/references/compliance-api/get-started/authentication"},{"title":"API conventions","description":"Format, pagination, errors, rate limits, auditing, and versioning for the Compliance API","sidebarTitle":"Conventions","href":"/developers/references/compliance-api/get-started/conventions"},{"title":"Workspace and members","description":"Workspace configuration and member directory endpoints in the Compliance API","sidebarTitle":"Workspace and members","href":"/developers/references/compliance-api/get-started/workspace-and-members"},{"title":"Apps and domains","description":"App inventory and custom domain endpoints in the Compliance API","sidebarTitle":"Apps and domains","href":"/developers/references/compliance-api/get-started/apps-and-domains"},{"title":"API keys, entities, functions, and secrets","description":"Credential hygiene, data model, backend function, and secret metadata endpoints in the Compliance API","sidebarTitle":"Keys, data, and functions","href":"/developers/references/compliance-api/get-started/keys-data-and-functions"},{"title":"Integrations and agents","description":"Third-party connection and AI agent endpoints in the Compliance API","sidebarTitle":"Integrations and agents","href":"/developers/references/compliance-api/get-started/integrations-and-agents"},{"title":"Security findings","description":"Security scanner findings endpoint in the Compliance API","sidebarTitle":"Security findings","href":"/developers/references/compliance-api/get-started/security-findings"},{"title":"Privacy and gaps","description":"What the Compliance API never returns, and what you get when a commonly requested field doesn't exist","sidebarTitle":"Privacy and gaps","href":"/developers/references/compliance-api/get-started/privacy-and-gaps"}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"arrow-left","href":"/developers/home"}]}}]},{"tab":"Account \u0026 Billing","pages":[{"title":"Account \u0026 Billing","href":"/Account-and-billing/Billing-and-plans"}]},{"tab":"Enterprise","pages":[{"title":"Enterprise","href":"/Enterprise/Base44-for-enterprises"}]}]},{"language":"pt-BR","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/pt-BR/changelog/product","label":"Registro de alterações"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"pt-BR","href":"/pt-BR"}]},{"language":"es","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/es/changelog/product","label":"Registro de cambios"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"es","href":"/es"}]},{"language":"he","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/he/changelog/product","label":"יומן שינויים"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"hidden":true,"pages":[{"title":"he","href":"/he/index","hidden":true}]},{"language":"ja","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/ja/changelog/product","label":"変更履歴"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"ja","href":"/ja"}]},{"language":"de","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/de/changelog/product","label":"Änderungsprotokoll"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"de","href":"/de"}]},{"language":"fr","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/fr/changelog/product","label":"Notes de version"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"fr","href":"/fr"}]},{"language":"it","navbar":{"links":[{"href":"https://app.base44.com/support/conversations","label":"Support"},{"href":"/it/changelog/product","label":"Registro modifiche"}],"primary":{"type":"button","label":"Base44","href":"https://base44.com/?utm_source=Mintlify\u0026utm_medium=Main\u0026utm_content=menu"}},"pages":[{"title":"it","href":"/it"}]}]},"basePath":"","title":"Base44 actors: Realtime actors (mobile apps) - Base44 Support Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["2bfc744e19"],"chunks":["NarrationPlayer-Cl1Ao-dR.js","types-CiTgMxws.js","shallow-BupWh095.js"]}
