Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check.
Only pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day.
Limits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours.
Force Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.
Site-relative paths to refresh, e.g. /pricing. 1 to 100 entries, each up to 2,048 characters. Full or protocol-relative URLs are rejected. Paths are trimmed and normalized (lowercased, trailing slash and query string dropped), and duplicates after normalization are merged. / is the homepage.
Required array length: 1 - 100 elements
Response
One outcome per requested path, in request order, plus the brand's remaining quota.
The brand's remaining refresh quota. A path is queued only while both windows have room.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Scrunch API Docs","colors":{"primary":"#84A027","light":"#D8FC3B","dark":"#434E0D"},"logo":{"light":"https://mintcdn.com/scrunchai/wmS3vnEYkMiks-uo/logo/scrunch-dark.svg?fit=max\u0026auto=format\u0026n=wmS3vnEYkMiks-uo\u0026q=85\u0026s=1ea209cf21e43eae27a79f766cb2cd31","dark":"https://mintcdn.com/scrunchai/wmS3vnEYkMiks-uo/logo/scrunch-light.svg?fit=max\u0026auto=format\u0026n=wmS3vnEYkMiks-uo\u0026q=85\u0026s=f34563ac089933acd9bc841be78f0869","href":"https://developers.scrunch.com/"},"favicon":"https://mintcdn.com/scrunchai/lCDS3kviKweSb6eg/logo/favicon-green.png?fit=max\u0026auto=format\u0026n=lCDS3kviKweSb6eg\u0026q=85\u0026s=87f0c724d3b7bb2f310e2ffd6b54a30e","api":{"examples":{"prefill":true}},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"https://helpcenter.scrunchai.com/en/","label":"Help Center"},{"href":"https://scrunch.com/blog","label":"Blog"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.scrunchai.com"}},"footer":{"socials":{"x":"https://x.com/scrunchai","linkedin":"https://linkedin.com/company/scrunchai"}},"integrations":{"telemetry":{"enabled":false}},"contextual":{"options":["copy","view","mcp","claude","chatgpt"],"display":"header"},"thumbnails":{"fonts":{"family":"Inter"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"flag","href":"https://status.scrunchai.com"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scrunchai","hasAudioNarration":false,"actualSubdomain":"scrunchai","customDomains":["developers.scrunch.com"],"gitSource":{"type":"github","owner":"excelsa-labs","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aecbab8c0268c64ff115d55","collectionId":"320bd78c-3ca2-4501-a284-85395dac7e6d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecbab8c0268c64ff115d55"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aecbab8c0268c64ff115d55","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":77},{"language":"default","tag":"MCP","count":40},{"language":"default","tag":"Workflows","count":24},{"language":"default","tag":"Configure","count":22},{"language":"default","tag":"Measure","count":21},{"language":"default","tag":"Configuration API","count":19},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Deprecated","count":14},{"language":"default","tag":"Prompt Library","count":12},{"language":"default","tag":"Optimize","count":11}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@scrunchai.com","showHelpButton":false}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles/global.css","content":".welcome-card-img-dark{display:none!important}html.dark .welcome-card-img-dark{display:block!important}html.dark .welcome-card-img-light{display:none!important}.welcome-card{display:block;text-decoration:none!important;border-bottom:none!important;color:inherit}.welcome-card p{text-decoration:none!important;border-bottom:none!important}.welcome-card-img{width:100%;border-radius:12px;display:block;transition:transform 0.2s ease;pointer-events:none}.welcome-card:hover .welcome-card-img{transform:scale(1.03)}.api-intro-hero{display:grid;grid-template-columns:3fr 2fr;gap:32px;align-items:center;margin-bottom:8px}.api-intro-hero-img{width:100%;max-width:280px;justify-self:end;border-radius:12px}@media (max-width: 640px){.api-intro-hero{grid-template-columns:1fr}.api-intro-hero-img{display:none}}html:not(.dark) .prompt{background-color:#FFFFFF!important}html:not(.dark) body,html:not(.dark) body>div,html:not(.dark) .mintlify,html:not(.dark) .pageWrapper,html:not(.dark) main{background-color:#FBF9F6!important}.update h2{font-size:1.0625rem;line-height:1.45;font-weight:600;letter-spacing:-0.01em;margin-top:0;margin-bottom:0.375rem}.update h2~h2,.update [data-as=\"p\"]+[data-as=\"p\"]{display:block;margin-top:1.375rem;padding-top:1.375rem;border-top:1px solid rgb(0 0 0 / 0.07)}html.dark .update h2~h2,html.dark .update [data-as=\"p\"]+[data-as=\"p\"]{border-top-color:rgb(255 255 255 / 0.1)}.update{scroll-margin-top:7rem}.cl-jump{display:flex;flex-direction:column;padding-top:1.25rem;border-top:1px solid rgb(0 0 0 / 0.07)}html.dark .cl-jump{border-top-color:rgb(255 255 255 / 0.1)}.cl-jump-title{font-weight:500;color:rgb(55 65 81);margin-bottom:0.75rem}html.dark .cl-jump-title{color:rgb(209 213 219)}.cl-jump-year{font-size:0.6875rem;font-weight:600;letter-spacing:0.06em;text-transform:uppercase;color:rgb(107 114 128);margin-bottom:0.5rem}.cl-jump-months{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:0.25rem;list-style:none;margin:0 0 0.75rem;padding:0}.cl-jump-months:last-child{margin-bottom:0}.cl-jump-month{display:flex;align-items:baseline;justify-content:space-between;gap:0.5rem;width:100%;padding:0.25rem 0.5rem;border-radius:0.375rem;font-size:0.8125rem;line-height:1.4;color:rgb(75 85 99);background:transparent;cursor:pointer;transition:background-color 0.12s ease, color 0.12s ease}html.dark .cl-jump-month{color:rgb(156 163 175)}.cl-jump-month:hover{background:rgb(0 0 0 / 0.04);color:rgb(17 24 39)}html.dark .cl-jump-month:hover{background:rgb(255 255 255 / 0.06);color:rgb(243 244 246)}.cl-jump-month.is-active{background:rgb(174 206 49 / 0.45);color:#40362E;font-weight:500}html.dark .cl-jump-month.is-active{background:rgb(132 160 39 / 0.40);color:#FFFFFF}.cl-jump-count{font-variant-numeric:tabular-nums;font-size:0.75rem;opacity:0.55}.cl-cat--analytics{--cl-bg: rgb(60 103 245 / 0.18);--cl-fg: #1F2CAE}.cl-cat--integrations{--cl-bg: rgb(31 44 174 / 0.16);--cl-fg: #1F2CAE}.cl-cat--platform{--cl-bg: rgb(147 192 254 / 0.45);--cl-fg: #1F2CAE}.cl-cat--settings-admin{--cl-bg: rgb(184 171 142 / 0.45);--cl-fg: #40362E}.cl-cat--ui-ux{--cl-bg: rgb(239 190 3 / 0.35);--cl-fg: #88520B}.cl-cat--data-crawling{--cl-bg: rgb(255 232 67 / 0.55);--cl-fg: #88520B}.cl-cat--performance{--cl-bg: rgb(136 82 11 / 0.16);--cl-fg: #88520B}.cl-cat--api-mcp{--cl-bg: rgb(88 107 22 / 0.13);--cl-fg: #586B16}.cl-cat--bug-fix{--cl-bg: #F1E8C7;--cl-fg: #40362E}.cl-cat--general{--cl-bg: transparent;--cl-fg: #40362E;box-shadow:inset 0 0 0 1px rgb(64 54 46 / 0.35)}html.dark .cl-cat--analytics{--cl-bg: rgb(60 103 245 / 0.30);--cl-fg: #93C0FE}html.dark .cl-cat--integrations{--cl-bg: rgb(31 44 174 / 0.50);--cl-fg: #93C0FE}html.dark .cl-cat--platform{--cl-bg: rgb(147 192 254 / 0.20);--cl-fg: #93C0FE}html.dark .cl-cat--settings-admin{--cl-bg: rgb(184 171 142 / 0.22);--cl-fg: #B8AB8E}html.dark .cl-cat--ui-ux{--cl-bg: rgb(239 190 3 / 0.24);--cl-fg: #FFE843}html.dark .cl-cat--data-crawling{--cl-bg: rgb(255 232 67 / 0.16);--cl-fg: #FFE843}html.dark .cl-cat--api-mcp{--cl-bg: rgb(88 107 22 / 0.45);--cl-fg: #AECE31}html.dark .cl-cat--performance{--cl-bg: rgb(136 82 11 / 0.45);--cl-fg: #FFE843}html.dark .cl-cat--bug-fix{--cl-bg: rgb(241 232 199 / 0.20);--cl-fg: #F1E8C7}html.dark .cl-cat--general{--cl-bg: transparent;--cl-fg: #B8AB8E;box-shadow:inset 0 0 0 1px rgb(184 171 142 / 0.35)}[data-component-part=\"update-tag\"].cl-cat,#changelog-filters-content button.cl-cat{font-weight:500;background-color:var(--cl-bg)!important;color:var(--cl-fg)!important}[data-component-part=\"update-tag\"].cl-cat{padding:0.125rem 0.5rem}#changelog-filters-content button{transition:box-shadow 0.15s ease, transform 0.15s ease}#changelog-filters-content button:hover{box-shadow:0 2px 6px rgb(64 54 46 / 0.16), 0 1px 2px rgb(64 54 46 / 0.1);transform:translateY(-1px)}html.dark #changelog-filters-content button:hover{box-shadow:0 2px 6px rgb(0 0 0 / 0.5), 0 1px 2px rgb(0 0 0 / 0.35)}@media (prefers-reduced-motion: reduce){#changelog-filters-content button{transition:none}#changelog-filters-content button:hover{transform:none}}.update [data-component-part=\"update-label\"],.update [data-component-part=\"update-tag\"],#changelog-filters-content button,.cl-jump-month{border-radius:9999px}"}],"page":{"pagePath":"api-reference/agent-pages/force-refresh","slug":"/api-reference/agent-pages/force-refresh","pageMetadata":{"title":"Force Refresh","description":"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check.\n\nOnly pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day.\n\nLimits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours.\n\nForce Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/refresh","href":"/api-reference/agent-pages/force-refresh","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Only pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Limits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Force Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.\"\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":"Force Refresh","description":"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check.\n\nOnly pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day.\n\nLimits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours.\n\nForce Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/refresh","href":"/api-reference/agent-pages/force-refresh","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/scrunchai/bca9f10e73242105/changelog-enhance.js"],"openApiReferenceData":{"operation":{"tags":["agent-pages"],"summary":"Force Refresh","description":"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check.\n\nOnly pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day.\n\nLimits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours.\n\nForce Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.","operationId":"refreshAgentPages","security":["cbb51711-9f67-4c7a-b47a-2101543daf78"],"parameters":["f3311bfa-8e8d-424c-afbe-071311fcbe79","ee8b54f5-f071-42f0-acbf-712dc4b227dc"],"requestBody":"afec48c9-16d2-45ab-9f69-47a78fab93ce","responses":{"202":"565aa043-74ac-41e5-8428-7a8fbf3a0be2","404":"50de41b4-9f66-4a01-a1cc-e929d21315e0","409":"4d0e1e10-1494-4bed-9cbf-741599319bca","422":"df00df05-3032-4e2e-8e2a-b033363a557e","429":"7a7768be-936b-4a87-a517-3e23166a99f9","503":"fe9f5cb2-69a7-4a31-8f7d-57ba35593194"},"method":"post","type":"path","servers":["1d10363d-9b3c-4d3c-8a9a-ee6bdfb031bb"],"path":"/{brand_id}/sites/{site_id}/agent-pages/refresh","baseUrlOptions":["https://api.scrunchai.com/v1"],"title":"Force Refresh","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.paths.items.0":"\u003cstring>"}]},"dependencies":{"parameters":{"f3311bfa-8e8d-424c-afbe-071311fcbe79":{"name":"brand_id","in":"path","required":true,"schema":{"type":"integer","title":"Brand Id","description":"The unique identifier for the brand that owns the site.","isRequired":true,"uniqueKey":"","typeLabel":"integer"},"description":"The unique identifier for the brand that owns the site."},"ee8b54f5-f071-42f0-acbf-712dc4b227dc":{"name":"site_id","in":"path","required":true,"schema":{"type":"string","title":"Site Id","description":"The ULID of the registered site whose Agent Pages you are refreshing.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The ULID of the registered site whose Agent Pages you are refreshing."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"paths":{"items":{"type":"string","uniqueKey":"paths.items.[INDEX]","typeLabel":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Paths","description":"Site-relative paths to refresh, e.g. `/pricing`. 1 to 100 entries, each up to 2,048 characters. Full or protocol-relative URLs are rejected. Paths are trimmed and normalized (lowercased, trailing slash and query string dropped), and duplicates after normalization are merged. `/` is the homepage.","isRequired":true,"uniqueKey":"paths","typeLabel":"string[]"}},"type":"object","required":["paths"],"title":"AgentPagesRefreshRequest","uniqueKey":"","typeLabel":"AgentPagesRefreshRequest · object"},"examples":{"Example":{"title":"Example","value":{"paths":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"565aa043-74ac-41e5-8428-7a8fbf3a0be2":{"description":"One outcome per requested path, in request order, plus the brand's remaining quota.","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"path":{"type":"string","title":"Path","description":"The normalized path this outcome applies to.","isRequired":true,"uniqueKey":"results.items.[INDEX].path","typeLabel":"string"},"outcome":{"type":"string","enum":["queued","not_found","excluded","cooldown","rate_limited"],"title":"Outcome","description":"What happened to this path. `queued`: accepted; the page will be refetched, re-optimized and republished. `not_found`: the site has no active Agent Page at this path. `excluded`: the site's Ignore or Priority List doesn't allow this path. `cooldown`: this page was refreshed in the last 5 minutes; retry after `retry_after`. `rate_limited`: the brand's hourly or daily quota ran out partway through this batch.","isRequired":true,"uniqueKey":"results.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"retry_after":{"oneOf":[{"type":"string","title":"Retry After","description":"For `cooldown`, when this path can be refreshed again. Null otherwise.","format":"date-time","uniqueKey":"results.items.[INDEX].retry_after.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Retry After","description":"For `cooldown`, when this path can be refreshed again. Null otherwise.","uniqueKey":"results.items.[INDEX].retry_after.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].retry_after","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["path","outcome"],"title":"AgentPagesRefreshResult","uniqueKey":"results.items.[INDEX]","typeLabel":"AgentPagesRefreshResult · object"},"type":"array","title":"Results","description":"One entry per requested path, in request order (after duplicates are merged).","isRequired":true,"uniqueKey":"results","typeLabel":"AgentPagesRefreshResult · object[]"},"quota":{"properties":{"hourly":{"properties":{"limit":{"type":"integer","title":"Limit","description":"This window's cap.","isRequired":true,"uniqueKey":"quota.hourly.limit","typeLabel":"integer"},"remaining":{"type":"integer","title":"Remaining","description":"Paths left in this window after this request.","isRequired":true,"uniqueKey":"quota.hourly.remaining","typeLabel":"integer"},"resets_at":{"oneOf":[{"type":"string","title":"Resets At","description":"When the oldest path counted in the window expires and frees a slot. Null when nothing has been used.","format":"date-time","uniqueKey":"quota.hourly.resets_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Resets At","description":"When the oldest path counted in the window expires and frees a slot. Null when nothing has been used.","uniqueKey":"quota.hourly.resets_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.hourly.resets_at","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["limit","remaining"],"title":"AgentPagesRefreshQuota","description":"500 refreshes per brand per rolling hour.","isRequired":true,"uniqueKey":"quota.hourly","typeLabel":"AgentPagesRefreshQuota · object"},"daily":{"properties":{"limit":{"type":"integer","title":"Limit","description":"This window's cap.","isRequired":true,"uniqueKey":"quota.daily.limit","typeLabel":"integer"},"remaining":{"type":"integer","title":"Remaining","description":"Paths left in this window after this request.","isRequired":true,"uniqueKey":"quota.daily.remaining","typeLabel":"integer"},"resets_at":{"oneOf":[{"type":"string","title":"Resets At","description":"When the oldest path counted in the window expires and frees a slot. Null when nothing has been used.","format":"date-time","uniqueKey":"quota.daily.resets_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Resets At","description":"When the oldest path counted in the window expires and frees a slot. Null when nothing has been used.","uniqueKey":"quota.daily.resets_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"quota.daily.resets_at","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["limit","remaining"],"title":"AgentPagesRefreshQuota","description":"5,000 refreshes per brand per rolling 24 hours.","isRequired":true,"uniqueKey":"quota.daily","typeLabel":"AgentPagesRefreshQuota · object"}},"type":"object","required":["hourly","daily"],"title":"AgentPagesRefreshQuotas","description":"The brand's remaining refresh quota. A path is queued only while both windows have room.","isRequired":true,"uniqueKey":"quota","typeLabel":"AgentPagesRefreshQuotas · object"}},"type":"object","required":["results","quota"],"title":"AgentPagesRefreshResponse","uniqueKey":"","typeLabel":"AgentPagesRefreshResponse · object"},"example":{"results":[{"path":"/pricing","outcome":"queued","retry_after":null},{"path":"/blog/launch","outcome":"cooldown","retry_after":"2026-10-07T18:42:10Z"},{"path":"/careers","outcome":"not_found","retry_after":null}],"quota":{"hourly":{"limit":500,"remaining":499,"resets_at":"2026-10-07T19:02:41Z"},"daily":{"limit":5000,"remaining":4987,"resets_at":"2026-10-08T09:15:03Z"}}},"examples":{"Example":{"title":"Example","value":{"results":[{"path":"/pricing","outcome":"queued","retry_after":null},{"path":"/blog/launch","outcome":"cooldown","retry_after":"2026-10-07T18:42:10Z"},{"path":"/careers","outcome":"not_found","retry_after":null}],"quota":{"hourly":{"limit":500,"remaining":499,"resets_at":"2026-10-07T19:02:41Z"},"daily":{"limit":5000,"remaining":4987,"resets_at":"2026-10-08T09:15:03Z"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"50de41b4-9f66-4a01-a1cc-e929d21315e0":{"description":"The site doesn't belong to the brand, or Agent Pages aren't enabled for the brand.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"4d0e1e10-1494-4bed-9cbf-741599319bca":{"description":"Agent Pages aren't active on this site (or the site isn't serving through its CDN). Nothing was queued and no quota was used.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"df00df05-3032-4e2e-8e2a-b033363a557e":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"7a7768be-936b-4a87-a517-3e23166a99f9":{"description":"The brand's hourly or daily refresh quota is used up and nothing could be queued, or another refresh request for the same brand is still being processed.","headers":{"Retry-After":{"description":"Seconds to wait: until every exhausted quota window has a free slot, or 1 when another request for the brand is in progress.","schema":{"type":"integer"}}},"content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fe9f5cb2-69a7-4a31-8f7d-57ba35593194":{"description":"The refresh couldn't be queued right now. Nothing was queued and no quota was used; retry shortly.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"cbb51711-9f67-4c7a-b47a-2101543daf78":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":["optimize"],"schemeName":"HTTPBearer"}}},"servers":{"1d10363d-9b3c-4d3c-8a9a-ee6bdfb031bb":{"url":"https://api.scrunchai.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":["optimize"],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"scrunchai","siteName":"Scrunch API Docs","title":"Force Refresh - Scrunch API Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T17:18:56.092Z","originalFileLocation":"api-reference/agent-pages/force-refresh.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=\"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check. Only pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day. Limits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours. Force Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scrunch API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_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/scrunchai/5P4kJEQP4z45O-k1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Force Refresh - Scrunch API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check. Only pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day. Limits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours. Force Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scrunch API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scrunchai.mintlify.site/_mintlify/api/og/v2?division=Agent+Pages\u0026amp;title=Force+Refresh\u0026amp;description=Refetch+existing+Agent+Pages+from+your+live+site+now%2C+then+re-optimize+and+republish+them%2C+whether+or+not+they+changed.+Use+it+after+updating+pages+on+your+site\u0026amp;theme=93ec30fdb3256642634f8dc2\u0026amp;signature=71258b44bc2eb52c22fcac715697ba7fa070cc4ebdc32907ed9dc1161b40a61e\">\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=\"Force Refresh - Scrunch API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check. Only pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day. Limits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours. Force Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scrunchai.mintlify.site/_mintlify/api/og/v2?division=Agent+Pages\u0026amp;title=Force+Refresh\u0026amp;description=Refetch+existing+Agent+Pages+from+your+live+site+now%2C+then+re-optimize+and+republish+them%2C+whether+or+not+they+changed.+Use+it+after+updating+pages+on+your+site\u0026amp;theme=93ec30fdb3256642634f8dc2\u0026amp;signature=71258b44bc2eb52c22fcac715697ba7fa070cc4ebdc32907ed9dc1161b40a61e\">\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/scrunchai/5P4kJEQP4z45O-k1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scrunch API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#84A027\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agent-pages/force-refresh.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.scrunch.com/#organization\",\"name\":\"Scrunch API Docs\",\"url\":\"https://developers.scrunch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scrunchai/wmS3vnEYkMiks-uo/logo/scrunch-dark.svg?fit=max\u0026auto=format\u0026n=wmS3vnEYkMiks-uo\u0026q=85\u0026s=1ea209cf21e43eae27a79f766cb2cd31\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.scrunch.com#website\",\"name\":\"Scrunch API Docs\",\"url\":\"https://developers.scrunch.com\",\"publisher\":{\"@id\":\"https://developers.scrunch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh#webpage\",\"url\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh\",\"name\":\"Force Refresh\",\"description\":\"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check. Only pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day. Limits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours. Force Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.\",\"dateModified\":\"2026-11-05T17:18:56.092Z\",\"isPartOf\":{\"@id\":\"https://developers.scrunch.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Deliver\",\"item\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agent Pages\",\"item\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Force Refresh\",\"item\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh#apireference\",\"headline\":\"Force Refresh\",\"name\":\"Force Refresh\",\"description\":\"Refetch existing Agent Pages from your live site now, then re-optimize and republish them, whether or not they changed. Use it after updating pages on your site so AI agents see the new version without waiting for the next scheduled check. Only pages that already have an active Agent Page can be refreshed. The endpoint returns one outcome per requested path, and queued refreshes run in the background. A page whose origin now redirects to another path is not republished: the redirect is recorded, and the page retires at the next scheduled check, within about a day. Limits: 100 paths per request; each path once every 5 minutes; per brand, 500 refreshes per rolling hour and 5,000 per rolling 24 hours. Force Refresh does not add or remove pages, and does not change curated (Adaptive) content at the same path. To take an Agent Page down, use Agent Pages Unpublish. To add one, use Agent Pages Publish.\",\"url\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh\",\"mainEntityOfPage\":{\"@id\":\"https://developers.scrunch.com/api-reference/agent-pages/force-refresh#webpage\"},\"dateModified\":\"2026-11-05T17:18:56.092Z\",\"publisher\":{\"@id\":\"https://developers.scrunch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.scrunch.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Scrunch API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Scrunch API Docs","nav":{"global":{"anchors":[{"anchor":"Status","icon":"flag","href":"https://status.scrunchai.com"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","pages":[{"title":"Scrunch REST API Directory and Authentication","sidebarTitle":"Introduction","icon":"light-switch-off","href":"/api-reference/introduction"},{"group":"Measure","icon":"chart-mixed","pages":[{"group":"Query API","public":true,"pages":[{"title":"Query API: Aggregated AI Visibility Metrics","sidebarTitle":"Overview","href":"/api-reference/query/overview"},{"title":"Query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/query","href":"/api-reference/query"},{"title":"Structured Query API: Multi-Metric JSON Endpoint","sidebarTitle":"Structured Query","href":"/api-reference/query/structured-query"}]},{"group":"Responses API","public":true,"pages":[{"title":"Responses API: Raw AI Answers and Citations","sidebarTitle":"Overview","href":"/api-reference/responses/overview"},{"title":"List Responses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/responses","href":"/api-reference/list-responses"}]},{"group":"Signals API","public":true,"pages":[{"title":"Signals API: Detected changes in AI visibility","sidebarTitle":"Overview","href":"/api-reference/signals/overview"},{"title":"List Signals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals","href":"/api-reference/signals/list-signals"},{"title":"Get Signal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals/{signal_id}","href":"/api-reference/signals/get-signal"},{"title":"List Signal Anchor Dates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals/anchors","href":"/api-reference/signals/list-signal-anchor-dates"},{"title":"List Signal Reactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/signals/reactions","href":"/api-reference/signals/list-signal-reactions"},{"title":"Set Signal Reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /{brand_id}/signals/{signal_id}/reaction","href":"/api-reference/signals/set-signal-reaction"},{"title":"Clear Signal Reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /{brand_id}/signals/{signal_id}/reaction","href":"/api-reference/signals/clear-signal-reaction"}]},{"group":"Agent Traffic API","public":true,"pages":[{"title":"Agent Traffic API: Monitor AI Bot Crawls","sidebarTitle":"Overview","href":"/api-reference/agent-traffic/overview"},{"title":"Get Agent Traffic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sites/{site_id}/agent-traffic","href":"/api-reference/agent-traffic/get-agent-traffic"},{"title":"Send Custom Agent Traffic Events","api":"POST https://webhooks.scrunchai.com/v1/sites/{site_id}/platforms/custom/web-traffic","href":"/api-reference/agent-traffic/post-custom-web-traffic"}]},{"group":"AI Referrals API","public":true,"pages":[{"title":"AI Referrals API: Send traffic from any analytics tool","sidebarTitle":"Overview","href":"/api-reference/ai-referrals/overview"},{"title":"Register AI Referrals Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/ai-referrals/connections","href":"/api-reference/ai-referrals/register-ai-referrals-connection"},{"title":"List AI Referrals Connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/ai-referrals/connections","href":"/api-reference/ai-referrals/list-ai-referrals-connections"},{"title":"Disable AI Referrals Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /{brand_id}/ai-referrals/connections/{connection_id}","href":"/api-reference/ai-referrals/disable-ai-referrals-connection"},{"title":"Push AI Referrals Events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/ai-referrals/connections/{connection_id}/events","href":"/api-reference/ai-referrals/push-ai-referrals-events"}]},{"group":"Collection API","pages":[{"title":"Create Collection Request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/collections","href":"/api-reference/create-collection-request"}]}]},{"group":"Optimize","icon":"wand-magic-sparkles","pages":[{"group":"Site Optimization API","pages":[{"title":"Site Optimization API: Recommendations, by type and by page","sidebarTitle":"Overview","href":"/api-reference/site-optimization/overview"},{"title":"List Recommendation Types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/recommendations/by-type","href":"/api-reference/site-optimization/list-recommendation-types"},{"title":"Get Recommendation Type Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/recommendations/by-type/{best_practice_id}","href":"/api-reference/site-optimization/get-recommendation-type-detail"},{"title":"List Page Recommendations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/recommendations/by-page","href":"/api-reference/site-optimization/list-page-recommendations"},{"title":"Get Page Optimization Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/site-optimization/optimization","href":"/api-reference/site-optimization/get-page-optimization-detail"},{"title":"Apply Page Optimization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/site-optimization/optimization/apply","href":"/api-reference/site-optimization/apply-page-optimization"}]},{"group":"Audit Scores API","pages":[{"title":"Audit Scores API: Retrievability and citability by page","sidebarTitle":"Overview","href":"/api-reference/audit-scores/overview"},{"title":"Get Site Audit Score","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/audit-scores/site","href":"/api-reference/audit-scores/get-site-audit-score"},{"title":"List Page Audit Scores","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/audit-scores/pages","href":"/api-reference/audit-scores/list-page-audit-scores"}]},{"group":"Crawl Readiness API","public":true,"pages":[{"title":"Crawl Readiness API: Check AI Crawler Access to a Site","sidebarTitle":"Overview","href":"/api-reference/crawl-readiness/overview"},{"title":"Get AI Crawl Readiness","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/crawl-readiness","href":"/api-reference/crawl-readiness/get-ai-crawl-readiness"}]}]},{"group":"Deliver","icon":"paper-plane","pages":[{"group":"Agent Pages","pages":[{"title":"Agent Pages Force Refresh: Update Pages on Demand","description":"Refetch Agent Pages from your live site now and republish them without waiting for the next scheduled check.","sidebarTitle":"Force Refresh overview","href":"/api-reference/agent-pages/force-refresh-overview"},{"title":"Force Refresh","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/refresh","href":"/api-reference/agent-pages/force-refresh"},{"title":"Agent Pages Unpublish: Stop Serving Pages on Demand","description":"Take Agent Pages off the edge now and keep them off, without waiting for the next scheduled check.","sidebarTitle":"Unpublish overview","href":"/api-reference/agent-pages/unpublish-overview"},{"title":"Unpublish","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/unpublish","href":"/api-reference/agent-pages/unpublish"},{"title":"Agent Pages Publish: Add Pages on Demand","sidebarTitle":"Publish overview","href":"/api-reference/agent-pages/publish-overview"},{"title":"Publish","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/sites/{site_id}/agent-pages/publish","href":"/api-reference/agent-pages/publish"}]},{"group":"Curated Pages (AXP)","pages":[{"title":"AXP Unpublish API: Take Optimized Pages Off the Edge","sidebarTitle":"Unpublish overview","href":"/api-reference/axp/unpublish"},{"title":"Unpublish Optimized Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /orchestration/unpublish/{brand_id}/sites/{site_id}","href":"/api-reference/axp-render/unpublish-optimized-pages"}]}]},{"group":"Configure","icon":"gear","pages":[{"group":"Configuration API","public":true,"pages":[{"title":"Configuration API: Manage Brands and Prompts","sidebarTitle":"Overview","href":"/api-reference/configuration/overview"},{"title":"List Brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands","href":"/api-reference/list-brands"},{"title":"List Sites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sites","href":"/api-reference/agent-pages/list-sites"},{"title":"Create Brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands","href":"/api-reference/create-brand"},{"title":"Update Brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /brands/{brand_id}","href":"/api-reference/update-brand"},{"title":"List Competitors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/competitors","href":"/api-reference/list-competitors"},{"title":"Get Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/competitors/{competitor_id}","href":"/api-reference/get-competitor"},{"title":"Create Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands/{brand_id}/competitors","href":"/api-reference/create-competitor"},{"title":"Update Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /brands/{brand_id}/competitors/{competitor_id}","href":"/api-reference/update-competitor"},{"title":"Archive Competitor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands/{brand_id}/competitors/{competitor_id}","href":"/api-reference/archive-competitor"},{"title":"List Personas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/personas","href":"/api-reference/list-personas"},{"title":"Get Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{brand_id}/personas/{persona_id}","href":"/api-reference/get-persona"},{"title":"Create Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands/{brand_id}/personas","href":"/api-reference/create-persona"},{"title":"Update Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /brands/{brand_id}/personas/{persona_id}","href":"/api-reference/update-persona"},{"title":"Archive Persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands/{brand_id}/personas/{persona_id}","href":"/api-reference/archive-persona"},{"title":"List Prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/prompts","href":"/api-reference/list-prompts"},{"title":"Create Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/prompts","href":"/api-reference/create-prompt"},{"title":"Update Prompt Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /{brand_id}/prompts/{prompt_id}","href":"/api-reference/update-prompt-status"},{"title":"Archive Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /{brand_id}/prompts/{prompt_id}","href":"/api-reference/archive-prompt"}]},{"group":"Account API","public":true,"pages":[{"title":"Account API: Read the Subscription State of an API Key","sidebarTitle":"Overview","href":"/api-reference/account/overview"},{"title":"Get Account Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /account","href":"/api-reference/account/get-account-status"}]},{"group":"Webhooks","public":true,"pages":[{"title":"Webhooks: Pipeline Stage Completion Callbacks","sidebarTitle":"Overview","href":"/api-reference/webhooks/overview"}]}]},{"group":"Deprecated","icon":"box-archive","pages":[{"group":"Site Audit API","public":true,"tag":"Deprecated","pages":[{"title":"Site Audit API: Score pages for AI search readiness","sidebarTitle":"Overview","href":"/api-reference/site-audit/overview"},{"title":"Create Page Audits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /{brand_id}/page-audits","href":"/api-reference/create-page-audits"},{"title":"List Page Audits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/page-audits","href":"/api-reference/list-page-audits"},{"title":"Get Page Audit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/page-audits/{page_audit_id}","href":"/api-reference/get-page-audit"}]},{"group":"Sitemap API","public":true,"tag":"Deprecated","pages":[{"title":"Sitemap API: Pages, Audit Scores, AI Metrics","sidebarTitle":"Overview","href":"/api-reference/sitemap/overview"},{"title":"List Sitemap Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/pages","href":"/api-reference/sitemap/list-sitemap-pages"},{"title":"Get Sitemap Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/pages/{page_id}","href":"/api-reference/sitemap/get-sitemap-page"},{"title":"Get Sitemap Page Metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/pages/{page_id}/metrics","href":"/api-reference/sitemap/get-sitemap-page-metrics"},{"title":"Export Sitemap Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /{brand_id}/sitemap/export","href":"/api-reference/sitemap/export-sitemap-pages"}]},{"group":"AXP Render API","public":true,"tag":"Deprecated","pages":[{"title":"AXP Render API: Queue Optimized Page Renders","sidebarTitle":"Overview","href":"/api-reference/axp/overview"},{"title":"Bulk Render Optimized Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /orchestration/render-bulk/{brand_id}/sites/{site_id}","href":"/api-reference/axp-render/bulk-render-optimized-pages"}]},{"group":"Optimize \u0026 Deploy API","public":true,"tag":"Deprecated","pages":[{"title":"Optimize and Deploy Pipeline API Overview","sidebarTitle":"Overview","href":"/api-reference/orchestration/overview"},{"title":"Create Optimize And Deploy Pipeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /orchestration/optimize-and-deploy/{brand_id}","href":"/api-reference/orchestration/create-optimize-and-deploy-pipeline"},{"title":"Get Pipeline Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /orchestration/optimize-and-deploy/{brand_id}/{token}","href":"/api-reference/orchestration/get-pipeline-status"}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Force Refresh - Scrunch API Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}