Track changes to the Surfer API and to these guides.
Entries are newest first, and each links to the current documentation. The generated reference pages under API v2 and API v1 follow the published OpenAPI specification.
Surfer API documentation is available. Get a key through Authentication, make your first requests with the Quickstart, or browse the v2 reference.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Surfer","colors":{"primary":"#783AFB","light":"#8F69FC","dark":"#630DE3"},"logo":{"light":"https://mintcdn.com/surfer-1a8fda11/VcE5s6fiXl3uKqnl/logo/surfer-light.svg?fit=max\u0026auto=format\u0026n=VcE5s6fiXl3uKqnl\u0026q=85\u0026s=9eff4746c5be9be5478e02a18fa5fef7","dark":"https://mintcdn.com/surfer-1a8fda11/VcE5s6fiXl3uKqnl/logo/surfer-dark.svg?fit=max\u0026auto=format\u0026n=VcE5s6fiXl3uKqnl\u0026q=85\u0026s=0af4dee868a1bf68e72c94fbced9c808"},"favicon":"https://mintcdn.com/surfer-1a8fda11/ZwffS_UNUB-eHJT4/favicon.svg?fit=max\u0026auto=format\u0026n=ZwffS_UNUB-eHJT4\u0026q=85\u0026s=3ef5c9f47a32ab30004d8da00240ab39","background":{"color":{"light":"#FFFFFF","dark":"#09090B"}},"navbar":{"links":[{"href":"https://surferseo.com","label":"Website"}],"primary":{"type":"button","label":"Log in","href":"https://app.surferseo.com"}},"seo":{"metatags":{"og:image":"https://devs.surferseo.com/images/og-image.png"}},"fonts":{"family":"Inter"},"styling":{"codeblocks":"system","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"surfer-1a8fda11","hasAudioNarration":false,"actualSubdomain":"surfer-1a8fda11","customDomains":["devs.surferseo.com"],"gitSource":{"type":"github","owner":"surferseo","repo":"surfer","deployBranch":"master","contentDirectory":"packages/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad8b1349cc3966443d2abe2","collectionId":"e83a3286-0441-47bb-9fa7-c4c8b99828fc","liveDeploymentHistoryId":"6ad8b1349cc3966443d2abe2","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad8cbc19cc3966443d300ed","clientVersion":"0.0.3908","searchFilterCounts":[{"language":"default","tag":"API","count":82},{"language":"default","tag":"API v2","count":49},{"language":"default","tag":"API v1 (legacy)","count":22},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"MCP","count":18},{"language":"default","tag":"Content Editors","count":17},{"language":"default","tag":"SEO Guidelines","count":12},{"language":"default","tag":"Overview","count":11},{"language":"default","tag":"Write where you work","count":8},{"language":"default","tag":"Connect","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".surfer-prompt{margin:1.25rem 0}.surfer-prompt-meta{display:flex;align-items:center;gap:.35rem;margin:0 0 .35rem .25rem;font-size:.75rem;font-weight:500;color:rgb(107 114 128)}.dark .surfer-prompt-meta{color:rgb(156 163 175)}.surfer-prompt-bubble{position:relative;border:1px solid rgb(0 0 0/.08);border-radius:.25rem 1.125rem 1.125rem 1.125rem;background:rgb(0 0 0/.035);padding:.85rem 3rem .85rem 1.1rem}.dark .surfer-prompt-bubble{border-color:rgb(255 255 255/.1);background:rgb(255 255 255/.06)}.surfer-prompt-text{margin:0;font-size:.95rem;line-height:1.6}.surfer-prompt-copy{position:absolute;top:.6rem;right:.6rem;display:flex;align-items:center;justify-content:center;width:1.75rem;height:1.75rem;border:0;border-radius:.375rem;background:0 0;color:rgb(107 114 128);cursor:pointer}.surfer-prompt-copy:hover{background:rgb(0 0 0/.06);color:rgb(17 24 39)}.dark .surfer-prompt-copy{color:rgb(156 163 175)}.dark .surfer-prompt-copy:hover{background:rgb(255 255 255/.1);color:rgb(255 255 255)}img[src*='/images/clients/']{box-sizing:content-box;padding:4px;border:1px solid #e4e4e7;border-radius:6px;background:#fafafa;object-fit:contain}.surfer-copy-text{display:inline-flex;align-items:center;gap:.25rem;white-space:nowrap}.surfer-copy-text-button{display:inline-flex;align-items:center;padding:.125rem;border-radius:.25rem;color:rgb(107 114 128);cursor:pointer}.surfer-copy-text-button:hover{color:rgb(17 24 39)}.dark .surfer-copy-text-button:hover{color:rgb(243 244 246)}"}],"page":{"pagePath":"api/changelog","slug":"/api/changelog","pageMetadata":{"title":"Changelog","icon":"clock-rotate-left","description":"Track changes to the Surfer API and to these guides.","sources":["packages/docs/docs.json (API tab pages)","packages/docs/mcp/changelog.mdx (entry format)","https://mintlify.com/docs/components/update"],"areas":["reader-visible public API and guide changes"],"checked":"24942a8eeee8bbf8bd95ea2952fee44727ec78dc","verify":"add an entry for reader-visible endpoint, convention, or guide changes; exact operation contracts stay in the generated reference","href":"/api/changelog"},"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: \"Track changes to the Surfer API and to these guides.\"\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},{Update}=_components;if(!Update)_missingMdxReference(`Update`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Entries are newest first, and each links to the current documentation. The generated reference pages under API v2 and API v1 follow the published OpenAPI specification.`}),`\n`,_jsx(Update,{label:`2026-09-11`,tags:[`Docs`],id:`2026-09-11`,children:_jsxs(_components.p,{children:[`Surfer API documentation is available. Get a key through `,_jsx(_components.a,{href:`/api/authentication`,children:`Authentication`}),`, make your first requests with the `,_jsx(_components.a,{href:`/api/quickstart`,children:`Quickstart`}),`, or browse the `,_jsx(_components.a,{href:`/api/v2/workspaces/list-workspaces`,children:`v2 reference`}),`.`]})})]})}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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Changelog","icon":"clock-rotate-left","description":"Track changes to the Surfer API and to these guides.","sources":["packages/docs/docs.json (API tab pages)","packages/docs/mcp/changelog.mdx (entry format)","https://mintlify.com/docs/components/update"],"areas":["reader-visible public API and guide changes"],"checked":"24942a8eeee8bbf8bd95ea2952fee44727ec78dc","verify":"add an entry for reader-visible endpoint, convention, or guide changes; exact operation contracts stay in the generated reference","href":"/api/changelog"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"2026-09-11","slug":"2026-09-11","depth":1,"children":[]}],"changelogFilters":[{"tag":"Docs","count":1}],"codeExamples":{}},"jsLinks":[],"subdomain":"surfer-1a8fda11","siteName":"Surfer","title":"Changelog - Surfer","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T12:04:45.133Z","originalFileLocation":"api/changelog.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=\"Track changes to the Surfer API and to these guides.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Surfer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Changelog - Surfer\">\u003cmeta data-mint-head property=\"og:description\" content=\"Track changes to the Surfer API and to these guides.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Surfer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://devs.surferseo.com/api/changelog\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://devs.surferseo.com/images/og-image.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=\"Changelog - Surfer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Track changes to the Surfer API and to these guides.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://devs.surferseo.com/images/og-image.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/surfer-1a8fda11/IHIzSAM1SDBKQB0g/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Surfer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#783AFB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://devs.surferseo.com/api/changelog\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/changelog.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://devs.surferseo.com/#organization\",\"name\":\"Surfer\",\"url\":\"https://devs.surferseo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/surfer-1a8fda11/VcE5s6fiXl3uKqnl/logo/surfer-light.svg?fit=max\u0026auto=format\u0026n=VcE5s6fiXl3uKqnl\u0026q=85\u0026s=9eff4746c5be9be5478e02a18fa5fef7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://devs.surferseo.com#website\",\"name\":\"Surfer\",\"url\":\"https://devs.surferseo.com\",\"publisher\":{\"@id\":\"https://devs.surferseo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://devs.surferseo.com/api/changelog#webpage\",\"url\":\"https://devs.surferseo.com/api/changelog\",\"name\":\"Changelog\",\"description\":\"Track changes to the Surfer API and to these guides.\",\"dateModified\":\"2026-10-21T12:04:45.133Z\",\"isPartOf\":{\"@id\":\"https://devs.surferseo.com#website\"},\"breadcrumb\":{\"@id\":\"https://devs.surferseo.com/api/changelog#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://devs.surferseo.com/api/changelog#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://devs.surferseo.com/api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Changelog\",\"item\":\"https://devs.surferseo.com/api/changelog\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://devs.surferseo.com/api/changelog#article\",\"headline\":\"Changelog\",\"name\":\"Changelog\",\"description\":\"Track changes to the Surfer API and to these guides.\",\"url\":\"https://devs.surferseo.com/api/changelog\",\"mainEntityOfPage\":{\"@id\":\"https://devs.surferseo.com/api/changelog#webpage\"},\"image\":\"https://devs.surferseo.com/images/og-image.png\",\"dateModified\":\"2026-10-21T12:04:45.133Z\",\"publisher\":{\"@id\":\"https://devs.surferseo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://devs.surferseo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Surfer\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Surfer","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"Integrations","icon":"puzzle-piece","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"API","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Surfer API","icon":"circle-info","href":"/api/overview"},{"title":"Quickstart","icon":"rocket","href":"/api/quickstart"},{"title":"Authentication","icon":"key","href":"/api/authentication"},{"title":"Requests and responses","icon":"code","href":"/api/requests"},{"title":"Async operations and webhooks","icon":"bell","href":"/api/async-and-webhooks"},{"title":"Errors","icon":"triangle-exclamation","href":"/api/errors"},{"title":"Rate limits and credits","icon":"gauge-high","href":"/api/rate-limits"},{"title":"Migrating from v1","icon":"arrow-right-arrow-left","href":"/api/migrating-from-v1"},{"title":"Troubleshooting","icon":"wrench","href":"/api/troubleshooting"},{"title":"Use cases","icon":"lightbulb","description":"Create and share Content Editors in bulk, publish a draft to a CMS, generate an article with outline review, and optimize an existing page.","href":"/api/use-cases"},{"title":"Changelog","icon":"clock-rotate-left","href":"/api/changelog"}]},{"group":"API v2","pages":[{"group":"Workspaces","pages":[{"title":"List workspaces","description":"Returns a paginated list of workspaces for the authenticated organization.\n\nResults can be filtered by workspace type and state, and ordered by name or timestamps.\nUnknown filter keys are ignored. Applied filters are reflected in the response `meta.filters` object.\n\nOnly workspaces with `active` state can be used to manage workspace-related resources.\n\n**Rate limit**: 10 requests/sec\n","deprecated":null,"version":null,"sidebarTitle":"List workspaces","openapi":"/api/openapi-v2.json get /api/v2/workspaces","href":"/api/v2/workspaces/list-workspaces"}]},{"group":"Content Editors","pages":[{"title":"List all Content Editors","deprecated":null,"version":null,"sidebarTitle":"List all content editors","openapi":"/api/openapi-v2.json get /api/v2/content_editors","href":"/api/v2/content-editors/list-all-content-editors"},{"title":"List Content Editors in workspace","deprecated":null,"version":null,"sidebarTitle":"List content editors in workspace","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors","href":"/api/v2/content-editors/list-content-editors-in-workspace"},{"title":"Create Content Editor","deprecated":null,"version":null,"sidebarTitle":"Create content editor","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_editors","href":"/api/v2/content-editors/create-content-editor"},{"title":"Get Content Editor content","deprecated":null,"version":null,"sidebarTitle":"Get content editor content","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/content","href":"/api/v2/content-editors/get-content-editor-content"},{"title":"Update Content Editor content","deprecated":null,"version":null,"sidebarTitle":"Update content editor content","openapi":"/api/openapi-v2.json put /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/content","href":"/api/v2/content-editors/update-content-editor-content"},{"title":"Get Content Editor","deprecated":null,"version":null,"sidebarTitle":"Get content editor","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{id}","href":"/api/v2/content-editors/get-content-editor"},{"title":"Delete Content Editor","deprecated":null,"version":null,"sidebarTitle":"Delete content editor","openapi":"/api/openapi-v2.json delete /api/v2/workspaces/{workspace_id}/content_editors/{id}","href":"/api/v2/content-editors/delete-content-editor"},{"title":"Customize Content Editor","deprecated":null,"version":null,"sidebarTitle":"Customize content editor","openapi":"/api/openapi-v2.json patch /api/v2/workspaces/{workspace_id}/content_editors/{id}","href":"/api/v2/content-editors/customize-content-editor"}]},{"group":"AI Articles","pages":[{"title":"List AI Articles for Content Editor","deprecated":null,"version":null,"sidebarTitle":"List ai articles for content editor","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_articles","href":"/api/v2/ai-articles/list-ai-articles-for-content-editor"},{"title":"Create AI Article","deprecated":null,"version":null,"sidebarTitle":"Create ai article","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_articles","href":"/api/v2/ai-articles/create-ai-article"},{"title":"Get AI Article outline","deprecated":null,"version":null,"sidebarTitle":"Get ai article outline","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_articles/outline","href":"/api/v2/ai-articles/get-ai-article-outline"},{"title":"Submit edited AI Article outline","deprecated":null,"version":null,"sidebarTitle":"Submit edited ai article outline","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_articles/outline","href":"/api/v2/ai-articles/submit-edited-ai-article-outline"},{"title":"Get AI Article","deprecated":null,"version":null,"sidebarTitle":"Get ai article","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_articles/{article_id}","href":"/api/v2/ai-articles/get-ai-article"}]},{"group":"Auto-Optimize","pages":[{"title":"Get latest Auto-Optimize job","deprecated":null,"version":null,"sidebarTitle":"Get latest auto optimize job","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/auto_optimize","href":"/api/v2/auto-optimize/get-latest-auto-optimize-job"},{"title":"Start Auto-Optimize","deprecated":null,"version":null,"sidebarTitle":"Start auto optimize","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/auto_optimize","href":"/api/v2/auto-optimize/start-auto-optimize"},{"title":"Get Auto-Optimize job","deprecated":null,"version":null,"sidebarTitle":"Get auto optimize job","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/auto_optimize/{job_id}","href":"/api/v2/auto-optimize/get-auto-optimize-job"}]},{"group":"SEO Guidelines","pages":[{"title":"Get SEO Guidelines","deprecated":null,"version":null,"sidebarTitle":"Get seo guidelines","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines","href":"/api/v2/seo-guidelines/get-seo-guidelines"},{"title":"List SEO Guidelines competitors","deprecated":null,"version":null,"sidebarTitle":"List seo guidelines competitors","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/competitors","href":"/api/v2/seo-guidelines/list-seo-guidelines-competitors"},{"title":"Update SEO Guidelines competitor inclusion","deprecated":null,"version":null,"sidebarTitle":"Update seo guidelines competitor inclusion","openapi":"/api/openapi-v2.json patch /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/competitors","href":"/api/v2/seo-guidelines/update-seo-guidelines-competitor-inclusion"},{"title":"Load more competitors","deprecated":null,"version":null,"sidebarTitle":"Load more competitors","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/competitors/load_more","href":"/api/v2/seo-guidelines/load-more-competitors"},{"title":"Get SEO Guidelines score","deprecated":null,"version":null,"sidebarTitle":"Get seo guidelines score","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/score","href":"/api/v2/seo-guidelines/get-seo-guidelines-score"},{"title":"Get SEO Guidelines status","deprecated":null,"version":null,"sidebarTitle":"Get seo guidelines status","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/status","href":"/api/v2/seo-guidelines/get-seo-guidelines-status"},{"title":"Get SEO Guidelines structure","deprecated":null,"version":null,"sidebarTitle":"Get seo guidelines structure","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/structure","href":"/api/v2/seo-guidelines/get-seo-guidelines-structure"},{"title":"Update SEO Guidelines structure","deprecated":null,"version":null,"sidebarTitle":"Update seo guidelines structure","openapi":"/api/openapi-v2.json patch /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/structure","href":"/api/v2/seo-guidelines/update-seo-guidelines-structure"},{"title":"List SEO Guidelines terms","deprecated":null,"version":null,"sidebarTitle":"List seo guidelines terms","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms","href":"/api/v2/seo-guidelines/list-seo-guidelines-terms"},{"title":"Update SEO Guidelines terms","deprecated":null,"version":null,"sidebarTitle":"Update seo guidelines terms","openapi":"/api/openapi-v2.json patch /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms","href":"/api/v2/seo-guidelines/update-seo-guidelines-terms"},{"title":"List SEO Guidelines topics and questions","deprecated":null,"version":null,"sidebarTitle":"List seo guidelines topics and questions","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/topics_and_questions","href":"/api/v2/seo-guidelines/list-seo-guidelines-topics-and-questions"},{"title":"Update SEO Guidelines topics inclusion","deprecated":null,"version":null,"sidebarTitle":"Update seo guidelines topics inclusion","openapi":"/api/openapi-v2.json patch /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/topics_and_questions","href":"/api/v2/seo-guidelines/update-seo-guidelines-topics-inclusion"}]},{"group":"AI Search","pages":[{"title":"Get AI Search guidelines for a Content Editor","deprecated":null,"version":null,"sidebarTitle":"Get ai search guidelines for a content editor","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines","href":"/api/v2/ai-search/get-ai-search-guidelines-for-a-content-editor"},{"title":"List AI Search guidelines facts","deprecated":null,"version":null,"sidebarTitle":"List ai search guidelines facts","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/facts","href":"/api/v2/ai-search/list-ai-search-guidelines-facts"},{"title":"Get AI Search score","deprecated":null,"version":null,"sidebarTitle":"Get ai search score","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/ai_search_guidelines/score","href":"/api/v2/ai-search/get-ai-search-score"}]},{"group":"Outline","pages":[{"title":"Get Content Editor outline","deprecated":null,"version":null,"sidebarTitle":"Get content editor outline","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/outline","href":"/api/v2/outline/get-content-editor-outline"},{"title":"Retry failed Content Editor outline generation","deprecated":null,"version":null,"sidebarTitle":"Retry failed content editor outline generation","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/outline/regenerate","href":"/api/v2/outline/retry-failed-content-editor-outline-generation"}]},{"group":"Permalinks","pages":[{"title":"List Content Editor permalinks","deprecated":null,"version":null,"sidebarTitle":"List content editor permalinks","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/permalinks","href":"/api/v2/permalinks/list-content-editor-permalinks"},{"title":"Reset Content Editor permalinks","deprecated":null,"version":null,"sidebarTitle":"Reset content editor permalinks","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/permalinks/reset","href":"/api/v2/permalinks/reset-content-editor-permalinks"}]},{"group":"Content Templates","pages":[{"title":"List content templates","deprecated":null,"version":null,"sidebarTitle":"List content templates","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_templates","href":"/api/v2/content-templates/list-content-templates"},{"title":"Create content template","deprecated":null,"version":null,"sidebarTitle":"Create content template","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/content_templates","href":"/api/v2/content-templates/create-content-template"},{"title":"Get content template","deprecated":null,"version":null,"sidebarTitle":"Get content template","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/content_templates/{id}","href":"/api/v2/content-templates/get-content-template"},{"title":"Update content template","deprecated":null,"version":null,"sidebarTitle":"Update content template put","openapi":"/api/openapi-v2.json put /api/v2/workspaces/{workspace_id}/content_templates/{id}","href":"/api/v2/content-templates/update-content-template-put"},{"title":"Delete content template","deprecated":null,"version":null,"sidebarTitle":"Delete content template","openapi":"/api/openapi-v2.json delete /api/v2/workspaces/{workspace_id}/content_templates/{id}","href":"/api/v2/content-templates/delete-content-template"},{"title":"Update content template","deprecated":null,"version":null,"sidebarTitle":"Update content template patch","openapi":"/api/openapi-v2.json patch /api/v2/workspaces/{workspace_id}/content_templates/{id}","href":"/api/v2/content-templates/update-content-template-patch"}]},{"group":"Custom Voices","pages":[{"title":"List custom voices","deprecated":null,"version":null,"sidebarTitle":"List custom voices","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/custom_voices","href":"/api/v2/custom-voices/list-custom-voices"},{"title":"Create custom voice","deprecated":null,"version":null,"sidebarTitle":"Create custom voice","openapi":"/api/openapi-v2.json post /api/v2/workspaces/{workspace_id}/custom_voices","href":"/api/v2/custom-voices/create-custom-voice"},{"title":"Get custom voice","deprecated":null,"version":null,"sidebarTitle":"Get custom voice","openapi":"/api/openapi-v2.json get /api/v2/workspaces/{workspace_id}/custom_voices/{id}","href":"/api/v2/custom-voices/get-custom-voice"},{"title":"Update custom voice","deprecated":null,"version":null,"sidebarTitle":"Update custom voice put","openapi":"/api/openapi-v2.json put /api/v2/workspaces/{workspace_id}/custom_voices/{id}","href":"/api/v2/custom-voices/update-custom-voice-put"},{"title":"Delete custom voice","deprecated":null,"version":null,"sidebarTitle":"Delete custom voice","openapi":"/api/openapi-v2.json delete /api/v2/workspaces/{workspace_id}/custom_voices/{id}","href":"/api/v2/custom-voices/delete-custom-voice"},{"title":"Update custom voice","deprecated":null,"version":null,"sidebarTitle":"Update custom voice patch","openapi":"/api/openapi-v2.json patch /api/v2/workspaces/{workspace_id}/custom_voices/{id}","href":"/api/v2/custom-voices/update-custom-voice-patch"}]},{"group":"Content Template Presets","pages":[{"title":"List Surfer Content Templates","deprecated":null,"version":null,"sidebarTitle":"List surfer content templates","openapi":"/api/openapi-v2.json get /api/v2/surfer_content_templates","href":"/api/v2/surfer-content-templates/list-surfer-content-templates"}]}]},{"group":"API v1 (legacy)","pages":[{"group":"Content Editors","pages":[{"title":"List Content Editors for a workspace","deprecated":true,"version":null,"sidebarTitle":"List content editors for a workspace","openapi":"/api/openapi-v1.json get /api/v1/content_editors","href":"/api/v1/content-editors/list-content-editors-for-a-workspace"},{"title":"Create Content Editor query","deprecated":true,"version":null,"sidebarTitle":"Create content editor query","openapi":"/api/openapi-v1.json post /api/v1/content_editors","href":"/api/v1/content-editors/create-content-editor-query"},{"title":"Get Content Editor query","deprecated":true,"version":null,"sidebarTitle":"Get content editor query","openapi":"/api/openapi-v1.json get /api/v1/content_editors/{id}","href":"/api/v1/content-editors/get-content-editor-query"},{"title":"Update Content Editor query","deprecated":true,"version":null,"sidebarTitle":"Update content editor query","openapi":"/api/openapi-v1.json patch /api/v1/content_editors/{id}","href":"/api/v1/content-editors/update-content-editor-query"},{"title":"Auto-Optimize Content Editor query","deprecated":true,"version":null,"sidebarTitle":"Auto optimize content editor query","openapi":"/api/openapi-v1.json post /api/v1/content_editors/{id}/auto_optimize","href":"/api/v1/content-editors/auto-optimize-content-editor-query"},{"title":"Get content inside the Content Editor","deprecated":true,"version":null,"sidebarTitle":"Get content inside the content editor","openapi":"/api/openapi-v1.json get /api/v1/content_editors/{id}/content","href":"/api/v1/content-editors/get-content-inside-the-content-editor"},{"title":"Get content score for the Content Editor","deprecated":true,"version":null,"sidebarTitle":"Get content score for the content editor","openapi":"/api/openapi-v1.json get /api/v1/content_editors/{id}/content_score","href":"/api/v1/content-editors/get-content-score-for-the-content-editor"},{"title":"Get structural guidelines for the Content Editor","deprecated":true,"version":null,"sidebarTitle":"Get structural guidelines for the content editor","openapi":"/api/openapi-v1.json get /api/v1/content_editors/{id}/structural_guidelines","href":"/api/v1/content-editors/get-structural-guidelines-for-the-content-editor"},{"title":"Get all terms for the Content Editor","deprecated":true,"version":null,"sidebarTitle":"Get all terms for the content editor","openapi":"/api/openapi-v1.json get /api/v1/content_editors/{id}/terms","href":"/api/v1/content-editors/get-all-terms-for-the-content-editor"}]},{"group":"Audit","pages":[{"title":"Create Audit query","deprecated":null,"version":null,"sidebarTitle":"Create audit query","openapi":"/api/openapi-v1.json post /api/v1/audits","href":"/api/v1/audit/create-audit-query"},{"title":"Get Audit query","deprecated":null,"version":null,"sidebarTitle":"Get audit query","openapi":"/api/openapi-v1.json get /api/v1/audits/{id}","href":"/api/v1/audit/get-audit-query"}]},{"group":"SERP Analyzer","pages":[{"title":"List SERP Analyzer queries for a workspace","deprecated":null,"version":null,"sidebarTitle":"List serp analyzer queries for a workspace","openapi":"/api/openapi-v1.json get /api/v1/exports/csv/serp_analyzer","href":"/api/v1/serp-analyzer/list-serp-analyzer-queries-for-a-workspace"},{"title":"Get prominent terms","deprecated":null,"version":null,"sidebarTitle":"Get prominent terms","openapi":"/api/openapi-v1.json get /api/v1/exports/csv/serp_analyzer/{serp_analyzer_id}/prominent_terms","href":"/api/v1/serp-analyzer/get-prominent-terms"},{"title":"Get search results","deprecated":null,"version":null,"sidebarTitle":"Get search results","openapi":"/api/openapi-v1.json get /api/v1/exports/csv/serp_analyzer/{serp_analyzer_id}/search_results","href":"/api/v1/serp-analyzer/get-search-results"},{"title":"Create SERP Analyzer query","deprecated":true,"version":null,"sidebarTitle":"Create serp analyzer query post create deprecated","openapi":"/api/openapi-v1.json post /api/v1/serp_analyzer","href":"/api/v1/serp-analyzer/create-serp-analyzer-query-post-create-deprecated"},{"title":"Create a batch of SERP Analyzer queries","deprecated":true,"version":null,"sidebarTitle":"Create a batch of serp analyzer queries post create batch deprecated","openapi":"/api/openapi-v1.json post /api/v1/serp_analyzer/batches","href":"/api/v1/serp-analyzer/create-a-batch-of-serp-analyzer-queries-post-create-batch-deprecated"},{"title":"Create SERP Analyzer query","deprecated":null,"version":null,"sidebarTitle":"Create serp analyzer query post create","openapi":"/api/openapi-v1.json post /api/v1/serp_analyzers","href":"/api/v1/serp-analyzer/create-serp-analyzer-query-post-create"},{"title":"Create a batch of SERP Analyzer queries","deprecated":null,"version":null,"sidebarTitle":"Create a batch of serp analyzer queries post create batch","openapi":"/api/openapi-v1.json post /api/v1/serp_analyzers/batch","href":"/api/v1/serp-analyzer/create-a-batch-of-serp-analyzer-queries-post-create-batch"}]},{"group":"Other","pages":[{"title":"Detect AI content in a text","deprecated":null,"version":null,"sidebarTitle":"Detect ai content in a text","openapi":"/api/openapi-v1.json post /api/v1/ai_detector/detect","href":"/api/v1/other/detect-ai-content-in-a-text"},{"title":"Humanize text","deprecated":null,"version":null,"sidebarTitle":"Humanize text","openapi":"/api/openapi-v1.json post /api/v1/humanizer/humanize","href":"/api/v1/other/humanize-text"},{"title":"List supported locations","deprecated":null,"version":null,"sidebarTitle":"List supported locations","openapi":"/api/openapi-v1.json get /api/v1/locations","href":"/api/v1/other/list-supported-locations"},{"title":"List workspaces","deprecated":true,"version":null,"sidebarTitle":"List workspaces","openapi":"/api/openapi-v1.json get /api/v1/workspaces","href":"/api/v1/other/list-workspaces"}]}]}]}]},"title":"Changelog - Surfer","buildId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","deploymentId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","dynamics":[],"chunks":[]}