Task-shaped how-tos for rules, workspaces, variables, imports, and more.
Where requests run — the place that
opens each API request’s connection on each surface, how to choose
it, and what a delegated send carries.
More is being written: task-shaped guides for rule and override
recipes, workspaces and sync, git sync, variables and vaults, importing
from other tools, and response overrides, grown from real questions
rather than speculation.Meanwhile the quick starts cover the happy path for every surface,
and the Server quick start covers self-hosting end
to end.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Open Headers","description":"Documentation for Open Headers — the open-source Enterprise API client in your browser. Team Collaboration. Browser Interceptor - modify live traffic.","colors":{"primary":"#2563EB","light":"#3B82F6","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/openheaders/WfyAsr6gNVo6Xyj0/logo/light.svg?fit=max\u0026auto=format\u0026n=WfyAsr6gNVo6Xyj0\u0026q=85\u0026s=ab3216b8c5374eaee3319481e8482fab","dark":"https://mintcdn.com/openheaders/WfyAsr6gNVo6Xyj0/logo/dark.svg?fit=max\u0026auto=format\u0026n=WfyAsr6gNVo6Xyj0\u0026q=85\u0026s=ae8a71976ee5cf93e4a1752b49eaaa14","href":"https://openheaders.com"},"favicon":"https://mintcdn.com/openheaders/WfyAsr6gNVo6Xyj0/favicon.svg?fit=max\u0026auto=format\u0026n=WfyAsr6gNVo6Xyj0\u0026q=85\u0026s=6f5bd21fc4c06a67a96ee1aba04d5449","navbar":{"links":[{"href":"https://github.com/OpenHeaders/open-headers","type":"github"}]},"footer":{"socials":{"github":"https://github.com/OpenHeaders/open-headers","website":"https://openheaders.com"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"list","href":"https://openheaders.com/changelog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OpenHeaders/open-headers"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"openheaders","hasAudioNarration":false,"actualSubdomain":"openheaders","customDomains":["docs.openheaders.com"],"gitSource":{"type":"github","owner":"openheaders","repo":"open-headers","deployBranch":"main","contentDirectory":"docs-site","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b02156175655308f1a4cc46","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Server","count":12},{"language":"default","tag":"Operate it","count":6},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Quick starts","count":4},{"language":"default","tag":"Reference","count":4},{"language":"default","tag":"Run it","count":4},{"language":"default","tag":"Guides","count":2},{"language":"default","tag":"API \u0026 MCP","count":1},{"language":"default","tag":"Welcome","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"guides","slug":"/guides","pageMetadata":{"title":"Guides","description":"Task-shaped how-tos for rules, workspaces, variables, imports, and more.","href":"/guides/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Task-shaped how-tos for rules, workspaces, variables, imports, and more.\"\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`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/guides/where-requests-run`,children:`Where requests run`}),` — the place that\nopens each API request’s connection on each surface, how to choose\nit, and what a delegated send carries.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`More is being written: task-shaped guides for rule and override\nrecipes, workspaces and sync, git sync, variables and vaults, importing\nfrom other tools, and response overrides, grown from real questions\nrather than speculation.`}),`\n`,_jsxs(_components.p,{children:[`Meanwhile the `,_jsx(_components.a,{href:`/`,children:`quick starts`}),` cover the happy path for every surface,\nand the `,_jsx(_components.a,{href:`/quickstart/server`,children:`Server quick start`}),` covers self-hosting end\nto end.`]})]})}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":"Guides","description":"Task-shaped how-tos for rules, workspaces, variables, imports, and more.","href":"/guides/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"openheaders","siteName":"Open Headers","title":"Guides - Open Headers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-18T17:04:11.934Z","originalFileLocation":"guides/index.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=\"Task-shaped how-tos for rules, workspaces, variables, imports, and more.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Open Headers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openheaders/_IoIv-H-ceGUbynj/_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/openheaders/_IoIv-H-ceGUbynj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openheaders/_IoIv-H-ceGUbynj/_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/openheaders/_IoIv-H-ceGUbynj/_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/openheaders/_IoIv-H-ceGUbynj/_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/openheaders/_IoIv-H-ceGUbynj/_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/openheaders/_IoIv-H-ceGUbynj/_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/openheaders/_IoIv-H-ceGUbynj/_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/openheaders/_IoIv-H-ceGUbynj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Guides - Open Headers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Task-shaped how-tos for rules, workspaces, variables, imports, and more.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Open Headers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openheaders.com/guides\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://openheaders.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Guides\u0026amp;description=Task-shaped+how-tos+for+rules%2C+workspaces%2C+variables%2C+imports%2C+and+more.\u0026amp;theme=3dce02d64bea27866d2371cd\u0026amp;signature=1b7d6ea3f1637b076262b6884640fdab9f2908d7b59ebf0022c333eddab3da9a\">\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=\"Guides - Open Headers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Task-shaped how-tos for rules, workspaces, variables, imports, and more.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://openheaders.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Guides\u0026amp;description=Task-shaped+how-tos+for+rules%2C+workspaces%2C+variables%2C+imports%2C+and+more.\u0026amp;theme=3dce02d64bea27866d2371cd\u0026amp;signature=1b7d6ea3f1637b076262b6884640fdab9f2908d7b59ebf0022c333eddab3da9a\">\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/openheaders/_IoIv-H-ceGUbynj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Open Headers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openheaders.com/guides\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openheaders.com/#organization\",\"name\":\"Open Headers\",\"url\":\"https://docs.openheaders.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/openheaders/WfyAsr6gNVo6Xyj0/logo/light.svg?fit=max\u0026auto=format\u0026n=WfyAsr6gNVo6Xyj0\u0026q=85\u0026s=ab3216b8c5374eaee3319481e8482fab\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openheaders.com#website\",\"name\":\"Open Headers\",\"url\":\"https://docs.openheaders.com\",\"publisher\":{\"@id\":\"https://docs.openheaders.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openheaders.com/guides#webpage\",\"url\":\"https://docs.openheaders.com/guides\",\"name\":\"Guides\",\"description\":\"Task-shaped how-tos for rules, workspaces, variables, imports, and more.\",\"dateModified\":\"2026-09-18T17:04:11.934Z\",\"isPartOf\":{\"@id\":\"https://docs.openheaders.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.openheaders.com/guides#article\",\"headline\":\"Guides\",\"name\":\"Guides\",\"description\":\"Task-shaped how-tos for rules, workspaces, variables, imports, and more.\",\"url\":\"https://docs.openheaders.com/guides\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openheaders.com/guides#webpage\"},\"dateModified\":\"2026-09-18T17:04:11.934Z\",\"publisher\":{\"@id\":\"https://docs.openheaders.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openheaders.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Open Headers\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Open Headers\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/guides.md","siteName":"Open Headers","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"list","href":"https://openheaders.com/changelog"},{"anchor":"GitHub","icon":"github","href":"https://github.com/OpenHeaders/open-headers"}]},"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"},{"title":"Where requests run","description":"Every API request names the place that opens its connection — this device, the desktop app, or the workspace's server — and lets you choose where more than one can.","href":"/guides/where-requests-run"}]},{"tab":"Server","pages":[{"title":"Server","href":"/server"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference"}]},{"tab":"API \u0026 MCP","pages":[{"title":"API \u0026 MCP","href":"/api-mcp"}]}]},"basePath":"","title":"Guides - Open Headers","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}