How to handle vulnerabilities and security-sensitive docs updates.
Report vulnerabilities through the repository security policy in SECURITY.md.Do not publish:
Private audit notes.
Exploit details before remediation.
Customer data.
Real secrets, tokens, webhook signatures, or provider keys.
Public security docs should explain supported configuration and safe operational behavior without exposing active vulnerabilities or private incident details.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Overlay","description":"Documentation for Overlay: using the web app, self-hosting, and building on the API.","colors":{"primary":"#171717","light":"#ededed","dark":"#171717"},"logo":{"light":"https://mintcdn.com/layernorminc/B4pNcuSitLhkHdYq/assets/overlay-lockup-light.svg?fit=max\u0026auto=format\u0026n=B4pNcuSitLhkHdYq\u0026q=85\u0026s=8352728a558c78c84b523d81edf8c77f","dark":"https://mintcdn.com/layernorminc/B4pNcuSitLhkHdYq/assets/overlay-lockup-dark.svg?fit=max\u0026auto=format\u0026n=B4pNcuSitLhkHdYq\u0026q=85\u0026s=d0742ed3bd3b08201ae4061586050204","href":"https://overlay.works"},"favicon":"https://mintcdn.com/layernorminc/NRqALe49CMdqXXei/assets/favicon.png?fit=max\u0026auto=format\u0026n=NRqALe49CMdqXXei\u0026q=85\u0026s=4ec4df52c7b31dc3b181a177a44a7613","api":{"playground":{"display":"interactive","proxy":false},"examples":{"defaults":"required","languages":["typescript","javascript","curl"]}},"appearance":{"default":"system"},"background":{"color":{"light":"#ffffff","dark":"#111111"}},"navbar":{"links":[{"href":"https://overlay.works/pricing","label":"Pricing"},{"href":"https://overlay.works/blog","label":"Blog"}],"primary":{"type":"button","label":"Open app","href":"https://overlay.works/app"}},"footer":{"socials":{"github":"https://github.com/LayerNorm/overlay-web","discord":"https://discord.gg/cag4HPkU6Z"}},"fonts":{"family":"Geist","weight":400},"icons":{"library":"lucide"},"contextual":{"options":["copy","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"layernorminc","hasAudioNarration":false,"actualSubdomain":"layernorminc","customDomains":["getoverlay.io"],"gitSource":{"type":"github","owner":"layernorm","repo":"overlay-web","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b0217304546409c89e3d974","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Developer","count":108},{"language":"default","tag":"REST API","count":99},{"language":"default","tag":"Reference","count":92},{"language":"default","tag":"Self-hosting","count":30},{"language":"default","tag":"Help","count":15},{"language":"default","tag":"Conversations","count":14},{"language":"default","tag":"Configure","count":10},{"language":"default","tag":"Files","count":10},{"language":"default","tag":"Operate","count":8},{"language":"default","tag":"Computers","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--ov-panel: #f7f7f7;--ov-panel-2: #f1f1f1;--ov-line: #ebebeb;--ov-line-2: #e2e2e2;--ov-text: #171717;--ov-muted: #737373;--ov-faint: #a3a3a3;--ov-btn: #171717;--ov-btn-text: #ffffff;--ov-btn-border: transparent;--ov-mono: ui-monospace, SFMono-Regular, 'SF Mono', Menlo, monospace}html.dark{--ov-panel: #171717;--ov-panel-2: #1d1d1d;--ov-line: #232323;--ov-line-2: #2c2c2c;--ov-text: #ededed;--ov-muted: #8f8f8f;--ov-faint: #5f5f5f;--ov-btn: #2a2a2a;--ov-btn-text: #f5f5f5;--ov-btn-border: #3a3a3a}#navbar{border-bottom:1px solid var(--ov-line);box-shadow:none}#navbar .nav-tabs-item{font-weight:400;text-shadow:none;color:var(--ov-muted)}#navbar .nav-tabs-item:hover,#navbar .nav-tabs-item[data-active=\"true\"],#navbar .nav-tabs-item.text-gray-800{color:var(--ov-text)}#navbar .nav-logo{height:24.64px}#topbar-cta-button a{height:32px;padding:0 14px;border-radius:999px;background:var(--ov-btn);color:var(--ov-btn-text);border:1px solid var(--ov-btn-border);font-weight:500;font-size:13px}#topbar-cta-button a>span:first-child{display:none}#topbar-cta-button a:hover{opacity:0.88}#topbar-cta-button a *{color:var(--ov-btn-text)}#page-title,#content-area h1,#content-area h2,#content-area h3,#content-area h4{font-weight:500;letter-spacing:-0.025em}#page-title{letter-spacing:-0.03em}#content-area .eyebrow,#sidebar .sidebar-group-header,#sidebar .sidebar-title{font-family:var(--ov-mono);font-size:11px;font-weight:400;letter-spacing:0.06em;text-transform:uppercase;color:var(--ov-faint)}#sidebar a{text-shadow:none}#sidebar a[aria-current=\"page\"],#sidebar a.bg-primary\\/10{background:var(--ov-panel-2);color:var(--ov-text);font-weight:500}#content-area .prose a:not(.card){color:inherit;font-weight:inherit;text-decoration:underline;text-decoration-color:var(--ov-faint);text-decoration-thickness:1px;text-underline-offset:0.18em;border-bottom:0}#content-area .prose a:not(.card):hover{text-decoration-color:currentColor}#content-area .card{border-radius:14px;border-color:var(--ov-line-2);box-shadow:none}#content-area .card:hover{background:var(--ov-panel)}#content-area .callout,#content-area .code-block,#content-area .code-group,#content-area .accordion,#content-area .accordion-group{border-radius:12px;box-shadow:none}#content-area table th{font-weight:500}#content-area table th,#content-area table td{border-color:var(--ov-line)}"}]}
{"page":{"pagePath":"developer/security","slug":"/developer/security","pageMetadata":{"title":"Reporting a vulnerability","description":"How to handle vulnerabilities and security-sensitive docs updates.","href":"/developer/security"},"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: \"How to handle vulnerabilities and security-sensitive docs updates.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Report vulnerabilities through the repository security policy in `,_jsx(_components.code,{children:`SECURITY.md`}),`.`]}),`\n`,_jsx(_components.p,{children:`Do not publish:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Private audit notes.`}),`\n`,_jsx(_components.li,{children:`Exploit details before remediation.`}),`\n`,_jsx(_components.li,{children:`Customer data.`}),`\n`,_jsx(_components.li,{children:`Real secrets, tokens, webhook signatures, or provider keys.`}),`\n`]}),`\n`,_jsx(_components.p,{children:`Public security docs should explain supported configuration and safe operational behavior without exposing active vulnerabilities or private incident details.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Reporting a vulnerability","description":"How to handle vulnerabilities and security-sensitive docs updates.","href":"/developer/security"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"layernorminc","siteName":"Overlay","title":"Reporting a vulnerability - Overlay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T17:16:34.185Z","originalFileLocation":"developer/security.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=\"How to handle vulnerabilities and security-sensitive docs updates.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Overlay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_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=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Reporting a vulnerability - Overlay\">\u003cmeta data-mint-head property=\"og:description\" content=\"How to handle vulnerabilities and security-sensitive docs updates.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Overlay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://getoverlay.io/docs/developer/security\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://layernorminc.mintlify.site/docs/_mintlify/api/og/v2?division=Security\u0026amp;title=Reporting+a+vulnerability\u0026amp;description=How+to+handle+vulnerabilities+and+security-sensitive+docs+updates.\u0026amp;theme=a4ce32f38218ad79a2234c60\u0026amp;signature=2cea0120810fe8222ba8701b261e62ddef91abf15102ba806b82094e7504f0d6\">\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=\"Reporting a vulnerability - Overlay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"How to handle vulnerabilities and security-sensitive docs updates.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://layernorminc.mintlify.site/docs/_mintlify/api/og/v2?division=Security\u0026amp;title=Reporting+a+vulnerability\u0026amp;description=How+to+handle+vulnerabilities+and+security-sensitive+docs+updates.\u0026amp;theme=a4ce32f38218ad79a2234c60\u0026amp;signature=2cea0120810fe8222ba8701b261e62ddef91abf15102ba806b82094e7504f0d6\">\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=\"/docs/mintlify-assets/_mintlify/favicons/layernorminc/NLsLtAjXL9Eof586/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Overlay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://getoverlay.io/docs/developer/security\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/developer/security.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://getoverlay.io/#organization\",\"name\":\"Overlay\",\"url\":\"https://getoverlay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/layernorminc/B4pNcuSitLhkHdYq/assets/overlay-lockup-light.svg?fit=max\u0026auto=format\u0026n=B4pNcuSitLhkHdYq\u0026q=85\u0026s=8352728a558c78c84b523d81edf8c77f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://getoverlay.io/docs#website\",\"name\":\"Overlay\",\"url\":\"https://getoverlay.io/docs\",\"publisher\":{\"@id\":\"https://getoverlay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://getoverlay.io/docs/developer/security#webpage\",\"url\":\"https://getoverlay.io/docs/developer/security\",\"name\":\"Reporting a vulnerability\",\"description\":\"How to handle vulnerabilities and security-sensitive docs updates.\",\"dateModified\":\"2026-10-23T17:16:34.185Z\",\"isPartOf\":{\"@id\":\"https://getoverlay.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://getoverlay.io/docs/developer/security#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://getoverlay.io/docs/developer/security#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overlay\",\"item\":\"https://getoverlay.io/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Reporting a vulnerability\",\"item\":\"https://getoverlay.io/docs/developer/security\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://getoverlay.io/docs/developer/security#article\",\"headline\":\"Reporting a vulnerability\",\"name\":\"Reporting a vulnerability\",\"description\":\"How to handle vulnerabilities and security-sensitive docs updates.\",\"url\":\"https://getoverlay.io/docs/developer/security\",\"mainEntityOfPage\":{\"@id\":\"https://getoverlay.io/docs/developer/security#webpage\"},\"dateModified\":\"2026-10-23T17:16:34.185Z\",\"publisher\":{\"@id\":\"https://getoverlay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://getoverlay.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Overlay\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Overlay\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/developer/security.md","siteName":"Overlay","nav":{"global":null,"tabs":[{"tab":"Help","icon":"life-buoy","pages":[{"title":"Help","href":"/introduction"}]},{"tab":"Self-hosting","icon":"server","pages":[{"title":"Self-hosting","href":"/self-hosting/overview"}]},{"tab":"Developer","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Build on Overlay","href":"/developer"},{"title":"Authentication","href":"/developer/authentication"}]},{"group":"MCP","pages":[{"title":"MCP server","href":"/developer/mcp"}]},{"group":"REST API","pages":[{"title":"REST API","href":"/developer/api/overview"},{"group":"Guides","pages":[{"title":"Bootstrap","href":"/developer/api/guides/bootstrap"},{"title":"Conversations","href":"/developer/api/guides/conversations"},{"title":"Files","href":"/developer/api/guides/files"},{"title":"Memory and knowledge","href":"/developer/api/guides/memory"},{"title":"Automations","href":"/developer/api/guides/automations"},{"title":"Billing","href":"/developer/api/guides/billing"}]},{"group":"Reference","pages":[{"group":"Account","pages":[{"title":"Update the signed-in account profile","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/account/profile","href":"/developer/api/reference/account/update-the-signed-in-account-profile"},{"title":"Read an authorized account profile photo","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/account/profile/photo","href":"/developer/api/reference/account/read-an-authorized-account-profile-photo"},{"title":"Upload an account profile photo","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/account/profile/photo","href":"/developer/api/reference/account/upload-an-account-profile-photo"}]},{"group":"Agents","pages":[{"title":"Agents asking agents: list who can be asked, ask one, or read a reply that was still being written","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/agent-asks","href":"/developer/api/reference/agents/agents-asking-agents:-list-who-can-be-asked-ask-one-or-read-a-reply-that-was-still-being-written"}]},{"group":"Automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/automations","href":"/developer/api/reference/automations/list-automations"},{"title":"Create an automation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/automations","href":"/developer/api/reference/automations/create-an-automation"},{"title":"Delete an automation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/automations","href":"/developer/api/reference/automations/delete-an-automation"},{"title":"Update an automation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/automations","href":"/developer/api/reference/automations/update-an-automation"},{"title":"Run an automation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/automations/run","href":"/developer/api/reference/automations/run-an-automation"},{"title":"Test an automation draft","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/automations/test","href":"/developer/api/reference/automations/test-an-automation-draft"}]},{"group":"Bootstrap","pages":[{"title":"Load signed-in app bootstrap state","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/bootstrap","href":"/developer/api/reference/bootstrap/load-signed-in-app-bootstrap-state"},{"title":"Read web capabilities","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/capabilities","href":"/developer/api/reference/bootstrap/read-web-capabilities"}]},{"group":"Computers","pages":[{"title":"List caller-visible workspace computers","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/computers","href":"/developer/api/reference/computers/list-caller-visible-workspace-computers"},{"title":"Provision a workspace computer (idempotent per owner)","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/computers","href":"/developer/api/reference/computers/provision-a-workspace-computer-idempotent-per-owner"},{"title":"Read one workspace computer","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/computers/{computerId}","href":"/developer/api/reference/computers/read-one-workspace-computer"},{"title":"Destroy a computer and its backing machine","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/computers/{computerId}","href":"/developer/api/reference/computers/destroy-a-computer-and-its-backing-machine"},{"title":"Take or release human control of a computer","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/computers/{computerId}/control","href":"/developer/api/reference/computers/take-or-release-human-control-of-a-computer"},{"title":"Issue a short-lived desktop stream ticket","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/computers/{computerId}/desktop","href":"/developer/api/reference/computers/issue-a-short-lived-desktop-stream-ticket"},{"title":"Resume a stopped computer machine","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/computers/{computerId}/start","href":"/developer/api/reference/computers/resume-a-stopped-computer-machine"},{"title":"Stop a running computer machine","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/computers/{computerId}/stop","href":"/developer/api/reference/computers/stop-a-running-computer-machine"}]},{"group":"Conversations","pages":[{"title":"List or read conversations","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/conversations","href":"/developer/api/reference/conversations/list-or-read-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/conversations","href":"/developer/api/reference/conversations/create-a-conversation"},{"title":"Delete a conversation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/conversations","href":"/developer/api/reference/conversations/delete-a-conversation"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/conversations","href":"/developer/api/reference/conversations/update-a-conversation"},{"title":"Run an Act turn","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/conversations/act","href":"/developer/api/reference/conversations/run-an-act-turn"},{"title":"Wait for durable conversation changes after a cursor","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/conversations/events","href":"/developer/api/reference/conversations/wait-for-durable-conversation-changes-after-a-cursor"},{"title":"Add a conversation message","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/conversations/message","href":"/developer/api/reference/conversations/add-a-conversation-message"},{"title":"Delete a conversation message","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/conversations/message","href":"/developer/api/reference/conversations/delete-a-conversation-message"},{"title":"Read the authoritative AgentRun for a conversation","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/conversations/run","href":"/developer/api/reference/conversations/read-the-authoritative-agentrun-for-a-conversation"},{"title":"Approve or deny a waiting AgentRun tool call","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/conversations/run/approval","href":"/developer/api/reference/conversations/approve-or-deny-a-waiting-agentrun-tool-call"},{"title":"Provide requested input to a waiting personal or native Harness AgentRun","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/conversations/run/input","href":"/developer/api/reference/conversations/provide-requested-input-to-a-waiting-personal-or-native-harness-agentrun"},{"title":"Update conversation sharing","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/conversations/share","href":"/developer/api/reference/conversations/update-conversation-sharing"},{"title":"Stop a running conversation turn","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/conversations/stop","href":"/developer/api/reference/conversations/stop-a-running-conversation-turn"},{"title":"Stream the complete public transcript of an assistant message","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/conversations/trace","href":"/developer/api/reference/conversations/stream-the-complete-public-transcript-of-an-assistant-message"}]},{"group":"Files","pages":[{"title":"List or read files","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/files","href":"/developer/api/reference/files/list-or-read-files"},{"title":"Create a file","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/files","href":"/developer/api/reference/files/create-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/files","href":"/developer/api/reference/files/delete-a-file"},{"title":"Update a file","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/files","href":"/developer/api/reference/files/update-a-file"},{"title":"Download file content","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/files/{fileId}/content","href":"/developer/api/reference/files/download-file-content"},{"title":"Ingest an uploaded document","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/files/ingest-document","href":"/developer/api/reference/files/ingest-an-uploaded-document"},{"title":"Presign file access","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/files/presign","href":"/developer/api/reference/files/presign-file-access"},{"title":"Search file text","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/files/search-text","href":"/developer/api/reference/files/search-file-text"},{"title":"Update file sharing","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/files/share","href":"/developer/api/reference/files/update-file-sharing"},{"title":"Create an upload URL","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/files/upload-url","href":"/developer/api/reference/files/create-an-upload-url"}]},{"group":"Media","pages":[{"title":"Generate an image","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/generate-image","href":"/developer/api/reference/media/generate-an-image"},{"title":"Generate a video","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/generate-video","href":"/developer/api/reference/media/generate-a-video"},{"title":"Transcribe audio","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/transcribe","href":"/developer/api/reference/media/transcribe-audio"}]},{"group":"Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/integrations","href":"/developer/api/reference/integrations/list-integrations"},{"title":"Connect an integration","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/integrations","href":"/developer/api/reference/integrations/connect-an-integration"}]},{"group":"Knowledge","pages":[{"title":"Search knowledge","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/knowledge/search","href":"/developer/api/reference/knowledge/search-knowledge"}]},{"group":"MCP Servers","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/mcps","href":"/developer/api/reference/mcp-servers/list-mcp-servers"},{"title":"Create an MCP server","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/mcps","href":"/developer/api/reference/mcp-servers/create-an-mcp-server"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/mcps","href":"/developer/api/reference/mcp-servers/delete-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/mcps","href":"/developer/api/reference/mcp-servers/update-an-mcp-server"},{"title":"Start an OAuth authorization for an MCP server","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/mcps/oauth","href":"/developer/api/reference/mcp-servers/start-an-oauth-authorization-for-an-mcp-server"},{"title":"Disconnect OAuth for an MCP server","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/mcps/oauth","href":"/developer/api/reference/mcp-servers/disconnect-oauth-for-an-mcp-server"},{"title":"Test an MCP server","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/mcps/test","href":"/developer/api/reference/mcp-servers/test-an-mcp-server"}]},{"group":"Memory","pages":[{"title":"List memories","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/memory","href":"/developer/api/reference/memory/list-memories"},{"title":"Create a memory","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/memory","href":"/developer/api/reference/memory/create-a-memory"},{"title":"Delete a memory","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/memory","href":"/developer/api/reference/memory/delete-a-memory"},{"title":"Update a memory","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/memory","href":"/developer/api/reference/memory/update-a-memory"}]},{"group":"Models","pages":[{"title":"Read the model catalog","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/model-catalog","href":"/developer/api/reference/models/read-the-model-catalog"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/notes","href":"/developer/api/reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/notes","href":"/developer/api/reference/notes/create-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/notes","href":"/developer/api/reference/notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/notes","href":"/developer/api/reference/notes/update-a-note"}]},{"group":"Outputs","pages":[{"title":"List outputs","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/outputs","href":"/developer/api/reference/outputs/list-outputs"},{"title":"Delete an output","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/outputs","href":"/developer/api/reference/outputs/delete-an-output"},{"title":"Download output content","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/outputs/{outputId}/content","href":"/developer/api/reference/outputs/download-output-content"}]},{"group":"Model Providers","pages":[{"title":"List model provider connections","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/providers/connections","href":"/developer/api/reference/model-providers/list-model-provider-connections"},{"title":"Create a model provider connection","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/providers/connections","href":"/developer/api/reference/model-providers/create-a-model-provider-connection"},{"title":"Delete a model provider connection","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/providers/connections","href":"/developer/api/reference/model-providers/delete-a-model-provider-connection"},{"title":"Update a model provider connection","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/providers/connections","href":"/developer/api/reference/model-providers/update-a-model-provider-connection"},{"title":"Test a model provider connection and discover models","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/providers/connections/test","href":"/developer/api/reference/model-providers/test-a-model-provider-connection-and-discover-models"}]},{"group":"Settings","pages":[{"title":"Read settings","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/settings","href":"/developer/api/reference/settings/read-settings"},{"title":"Update settings","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/settings","href":"/developer/api/reference/settings/update-settings"}]},{"group":"Skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/skills","href":"/developer/api/reference/skills/list-skills"},{"title":"Create a skill","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/skills","href":"/developer/api/reference/skills/create-a-skill"},{"title":"Delete a skill","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/skills","href":"/developer/api/reference/skills/delete-a-skill"},{"title":"Update a skill","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/skills","href":"/developer/api/reference/skills/update-a-skill"}]},{"group":"Billing","pages":[{"title":"Read subscription state","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/subscription","href":"/developer/api/reference/billing/read-subscription-state"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/webhooks","href":"/developer/api/reference/webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/webhooks","href":"/developer/api/reference/webhooks/create-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json delete /api/v1/webhooks","href":"/developer/api/reference/webhooks/delete-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/webhooks","href":"/developer/api/reference/webhooks/update-a-webhook-subscription"}]},{"group":"Workspaces","pages":[{"title":"Read the workspace icon","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/workspaces/{workspaceId}/icon","href":"/developer/api/reference/workspaces/read-the-workspace-icon"},{"title":"Upload a workspace icon","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/workspaces/{workspaceId}/icon","href":"/developer/api/reference/workspaces/upload-a-workspace-icon"},{"title":"Set a preset workspace icon","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/workspaces/{workspaceId}/icon","href":"/developer/api/reference/workspaces/set-a-preset-workspace-icon"},{"title":"Read the current member profile in a workspace","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/workspaces/{workspaceId}/profile","href":"/developer/api/reference/workspaces/read-the-current-member-profile-in-a-workspace"},{"title":"Update the current member profile in a workspace","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json patch /api/v1/workspaces/{workspaceId}/profile","href":"/developer/api/reference/workspaces/update-the-current-member-profile-in-a-workspace"},{"title":"Read an authorized workspace profile photo","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json get /api/v1/workspaces/{workspaceId}/profile/photo","href":"/developer/api/reference/workspaces/read-an-authorized-workspace-profile-photo"},{"title":"Upload a workspace profile photo","deprecated":null,"version":null,"openapi":"/openapi/overlay-web.openapi.json post /api/v1/workspaces/{workspaceId}/profile/photo","href":"/developer/api/reference/workspaces/upload-a-workspace-profile-photo"}]}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/developer/webhooks"}]},{"group":"Contribute","pages":[{"title":"Run Overlay locally","href":"/developer/contribute/run-locally"},{"title":"Repository map","href":"/developer/contribute/repository-map"},{"title":"Architecture","href":"/developer/contribute/architecture"},{"title":"Local integrations","description":"Run provider-dependent web features during local development.","href":"/developer/contribute/local-integrations"}]},{"group":"Security","pages":[{"title":"Reporting a vulnerability","href":"/developer/security"}]}]},{"tab":"Changelog","icon":"history","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Reporting a vulnerability - Overlay","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":[],"chunks":[]}