Returns a site’s brand assets under data.brand. Parameters are camelCase, like screenshotColors.10 credits. Failed requests are never charged.
Guide: Brand
Every color option, design tokens, the response fields and examples.
Authorizations
X-API-Key
string
header
required
Your Prefetch API key. Obtain one from the dashboard.
Query Parameters
url
string
required
The website URL to process. https:// is prepended automatically if no protocol is provided.
Example:
"https://stripe.com"
screenshotColors
integer
Extract N dominant colors from the page screenshot. Range: 2–12. Omit to skip screenshot color extraction.
Required range: 2 <= x <= 12
css
boolean
default:false
Extract colors from linked CSS files. Pass true to enable.
html
boolean
default:false
Extract colors from inline HTML. Pass true to enable.
javascript
boolean
default:false
Extract colors from linked JS files. Pass true to enable.
screenshotWidth
integer
default:1440
Viewport width in pixels. Range: 320–3000. Default: 1440.
Required range: 320 <= x <= 3000
screenshotHeight
integer
default:900
Viewport height in pixels. Range: 320–3000. Default: 900.
Required range: 320 <= x <= 3000
screenshotFormat
enum<string>
default:jpeg
Screenshot format. Default: jpeg.
Available options:
jpeg,
png,
pdf
screenshotFullPage
boolean
default:false
Capture the full scrollable page. Pass true to enable.
disableAdblocker
boolean
default:false
Disable the built-in adblocker. Pass true to enable (useful for sites that detect ad blockers).
filterAchromatic
boolean
default:false
Exclude near-white, near-black, and greyscale colors from results. Pass true to enable.
designTokens
boolean
default:false
Add brand.design_tokens: the site's colors by role (primary, background, text, heading, link), its heading and body type, and its button and input styles, read from the rendered page. Pass true to enable. Requests with this set are never answered from curated data.
Response
Brand extraction result.
success
enum<boolean>
required
Available options:
true
data
object
required
Show child attributes
meta
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Prefetch API","colors":{"primary":"#8A5A00","light":"#F7B00A","dark":"#F7B00A"},"logo":{"light":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/light.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=7b9ea0ec7c23b929ff607e56c0de9713","dark":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/dark.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=e97e8b6432d524163f934bd09b638763"},"favicon":"https://mintcdn.com/prefetch/qKlLmXxc4XUEOZI9/images/favicon.svg?fit=max\u0026auto=format\u0026n=qKlLmXxc4XUEOZI9\u0026q=85\u0026s=68c45014cec0f875b327e5b42e450b3c","appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FCFBF6","dark":"#1A0618"}},"navbar":{"links":[{"href":"https://prefetch.io/#pricing-section","label":"Pricing"},{"href":"https://prefetch.betteruptime.com/","label":"Status"},{"href":"mailto:[email protected]","label":"Support"},{"href":"https://prefetch.io/dashboard","label":"Dashboard"}],"primary":{"type":"button","label":"Get API key","href":"https://prefetch.io/account"}},"footer":{"links":[{"header":"Product","items":[{"label":"Website","href":"https://prefetch.io"},{"label":"Brand catalog","href":"https://prefetch.io/brands"},{"label":"Pricing","href":"https://prefetch.io/"},{"label":"Status","href":"https://prefetch.betteruptime.com/"},{"label":"Dashboard","href":"https://prefetch.io/dashboard"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"Recipes","href":"/recipes/overview"},{"label":"Compare","href":"/compare/overview"},{"label":"API reference","href":"/api-reference/introduction"},{"label":"MCP server","href":"/mcp/overview"},{"label":"Changelog","href":"/changelog"}]},{"header":"Company","items":[{"label":"Book a demo","href":"https://cal.com/nestoras.design"},{"label":"Contact","href":"mailto:[email protected]"},{"label":"Security","href":"/concepts/security"},{"label":"Privacy","href":"https://prefetch.io/privacy"},{"label":"Terms","href":"https://prefetch.io/terms"}]}]},"fonts":{"heading":{"family":"Space Grotesk"},"body":{"family":"Inter"}},"styling":{"codeblocks":{"theme":"css-variables"},"latex":true},"integrations":{"ga4":{"measurementId":"G-GVKTFNYJ7B"}},"contextual":{"options":["copy","view","claude","chatgpt","perplexity","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/images/og-background.png?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=cff58baad899de3384c86485eb291dad","fonts":{"family":"Space Grotesk"}},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"prefetch","hasAudioNarration":false,"actualSubdomain":"prefetch","customDomains":["docs.prefetch.io"],"gitSource":{"type":"github","owner":"trelobarbouni18","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aebd7f575e8c030b49a1953","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API reference","count":38},{"language":"default","tag":"Docs","count":37},{"language":"default","tag":"Monitors","count":17},{"language":"default","tag":"Recipes","count":14},{"language":"default","tag":"Company data","count":13},{"language":"default","tag":"Integrations","count":12},{"language":"default","tag":"Web data","count":10},{"language":"default","tag":"Batches","count":8},{"language":"default","tag":"Jobs and monitoring","count":8},{"language":"default","tag":"Platform","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","href":"/_mintlify/custom/prefetch/d2542fa30758caf7/custom.css"}],"page":{"pagePath":"api-reference/endpoint/brand","slug":"/api-reference/endpoint/brand","pageMetadata":{"title":"GET /brand","sidebarTitle":"Brand","description":"Colors, logos, fonts, images and social links for any website. 10 credits.","openapi":"GET /brand","href":"/api-reference/endpoint/brand"},"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: \"Colors, logos, fonts, images and social links for any website. 10 credits.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns a site’s brand assets under `,_jsx(_components.code,{children:`data.brand`}),`. Parameters are camelCase, like `,_jsx(_components.code,{children:`screenshotColors`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`10 credits.`}),` Failed requests are never charged.`]}),`\n`,_jsx(Card,{title:`Guide: Brand`,icon:`https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=83997c50bbffa6f63d021644f36e0d2f`,href:`/company-data/brand`,\"data-og-width\":`24`,width:`24`,\"data-og-height\":`24`,height:`24`,\"data-path\":`icons/book-open.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=280\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=571e9341106e7a820dfbdc82f1fa7848 280w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=560\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=89b208a6ebed2801c21d3b334602f655 560w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=840\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=cad73ea82dc28ca477d6c58a9dba2701 840w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=a756acb5854c82807bee8e5b6fdf40a4 1100w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=5c188516dd5cf7d2e4e7d1b0f4fd00a6 1650w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=58b15848f6396e16701ae55f8da4103c 2500w`,children:_jsx(_components.p,{children:`Every color option, design tokens, the response fields and examples.`})})]})}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":{"theme":"css-variables"},"config":{},"pageMetadata":{"title":"GET /brand","sidebarTitle":"Brand","description":"Colors, logos, fonts, images and social links for any website. 10 credits.","openapi":"GET /brand","href":"/api-reference/endpoint/brand"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getBrand","summary":"Extract brand assets","description":"Colors, logos, fonts, images and social links for any website. 10 credits.","tags":["Endpoints"],"parameters":["e2e6c258-9f66-4284-8c6c-7b55c7eabbd3","50853fbd-6302-4549-ab46-58f00c70d249","3a05926a-89cc-4bed-9049-f03c4a7232d2","516cce10-4192-4373-bd53-6e30d781e77b","be30f132-e13d-4f6b-baf5-0d7c9630b743","3434a8d4-b423-434c-a9db-03f8928711e9","7a7cb451-62c7-4cbf-a95e-cd283ebe2085","8ef5325c-5a9b-48d7-bc51-2fef7fef4409","2b4a1b64-7186-493b-9b02-c44c821cbf68","6e3a4867-beb6-4b24-b407-d1e564965244","bc16882a-a345-4773-881c-adcd84f2f53e","cd76ca19-b600-4b07-a3bb-2df279305028"],"responses":{"200":"4732f853-f9b1-4c08-a46f-26a8e6df7e28","400":"4dd34fe8-2071-438f-938c-4aa7d93ce9f0","401":"2aebcb1f-554e-4017-8584-5196b1c9d10d","403":"12827a58-eeab-451c-bda1-2edfae33be9a","422":"cd41e64c-bd6a-48b4-9f29-b1b43ea5126a","429":"c059d70e-6e03-42ed-a5cb-773356609aec","503":"a542b146-3fc7-42b8-bd54-a4cffd2789fd","504":"69e4918a-56bb-4e2c-9f12-c3587ed7d1c4"},"method":"get","type":"path","servers":["a72447d6-010c-4889-ae7b-b9e4d80db41a"],"security":["a1fe7f7c-62a7-42f3-b340-a37bf2940fc6"],"path":"/brand","baseUrlOptions":["https://api.prefetch.io"],"title":"Extract brand assets","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e2e6c258-9f66-4284-8c6c-7b55c7eabbd3":{"name":"url","in":"query","required":true,"description":"The website URL to process. `https://` is prepended automatically if no protocol is provided.","schema":{"type":"string","example":"https://stripe.com","isRequired":true,"description":"The website URL to process. `https://` is prepended automatically if no protocol is provided.","uniqueKey":"","typeLabel":"string"}},"50853fbd-6302-4549-ab46-58f00c70d249":{"name":"screenshotColors","in":"query","required":false,"description":"Extract N dominant colors from the page screenshot. Range: 2–12. Omit to skip screenshot color extraction.","schema":{"type":"integer","minimum":2,"maximum":12,"isRequired":false,"description":"Extract N dominant colors from the page screenshot. Range: 2–12. Omit to skip screenshot color extraction.","uniqueKey":"","typeLabel":"integer"}},"3a05926a-89cc-4bed-9049-f03c4a7232d2":{"name":"css","in":"query","required":false,"description":"Extract colors from linked CSS files. Pass `true` to enable.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Extract colors from linked CSS files. Pass `true` to enable.","uniqueKey":"","typeLabel":"boolean"}},"516cce10-4192-4373-bd53-6e30d781e77b":{"name":"html","in":"query","required":false,"description":"Extract colors from inline HTML. Pass `true` to enable.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Extract colors from inline HTML. Pass `true` to enable.","uniqueKey":"","typeLabel":"boolean"}},"be30f132-e13d-4f6b-baf5-0d7c9630b743":{"name":"javascript","in":"query","required":false,"description":"Extract colors from linked JS files. Pass `true` to enable.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Extract colors from linked JS files. Pass `true` to enable.","uniqueKey":"","typeLabel":"boolean"}},"3434a8d4-b423-434c-a9db-03f8928711e9":{"name":"screenshotWidth","in":"query","required":false,"description":"Viewport width in pixels. Range: 320–3000. Default: 1440.","schema":{"type":"integer","minimum":320,"maximum":3000,"default":1440,"isRequired":false,"description":"Viewport width in pixels. Range: 320–3000. Default: 1440.","uniqueKey":"","typeLabel":"integer"}},"7a7cb451-62c7-4cbf-a95e-cd283ebe2085":{"name":"screenshotHeight","in":"query","required":false,"description":"Viewport height in pixels. Range: 320–3000. Default: 900.","schema":{"type":"integer","minimum":320,"maximum":3000,"default":900,"isRequired":false,"description":"Viewport height in pixels. Range: 320–3000. Default: 900.","uniqueKey":"","typeLabel":"integer"}},"8ef5325c-5a9b-48d7-bc51-2fef7fef4409":{"name":"screenshotFormat","in":"query","required":false,"description":"Screenshot format. Default: `jpeg`.","schema":{"type":"string","enum":["jpeg","png","pdf"],"default":"jpeg","isRequired":false,"description":"Screenshot format. Default: `jpeg`.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"2b4a1b64-7186-493b-9b02-c44c821cbf68":{"name":"screenshotFullPage","in":"query","required":false,"description":"Capture the full scrollable page. Pass `true` to enable.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Capture the full scrollable page. Pass `true` to enable.","uniqueKey":"","typeLabel":"boolean"}},"6e3a4867-beb6-4b24-b407-d1e564965244":{"name":"disableAdblocker","in":"query","required":false,"description":"Disable the built-in adblocker. Pass `true` to enable (useful for sites that detect ad blockers).","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Disable the built-in adblocker. Pass `true` to enable (useful for sites that detect ad blockers).","uniqueKey":"","typeLabel":"boolean"}},"bc16882a-a345-4773-881c-adcd84f2f53e":{"name":"filterAchromatic","in":"query","required":false,"description":"Exclude near-white, near-black, and greyscale colors from results. Pass `true` to enable.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Exclude near-white, near-black, and greyscale colors from results. Pass `true` to enable.","uniqueKey":"","typeLabel":"boolean"}},"cd76ca19-b600-4b07-a3bb-2df279305028":{"name":"designTokens","in":"query","required":false,"description":"Add `brand.design_tokens`: the site's colors by role (primary, background, text, heading, link), its heading and body type, and its button and input styles, read from the rendered page. Pass `true` to enable. Requests with this set are never answered from curated data.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Add `brand.design_tokens`: the site's colors by role (primary, background, text, heading, link), its heading and body type, and its button and input styles, read from the rendered page. Pass `true` to enable. Requests with this set are never answered from curated data.","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"4732f853-f9b1-4c08-a46f-26a8e6df7e28":{"description":"Brand extraction result.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL that was scraped.","example":"https://stripe.com","isRequired":true,"uniqueKey":"data.url","typeLabel":"string\u003curi>"},"domain":{"type":"string","description":"Normalized domain extracted from the URL.","example":"stripe.com","isRequired":true,"uniqueKey":"data.domain","typeLabel":"string"},"brand":{"type":"object","description":"Brand identity extracted from the page.","properties":{"colors":{"type":"object","properties":{"brand_colors":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string","description":"The color in `rgb()` form.","example":"rgb(99, 91, 255)","isRequired":true,"uniqueKey":"data.brand.colors.brand_colors.items.[INDEX].color","typeLabel":"string"},"hex":{"type":"string","description":"The color as a hex triplet.","example":"#635BFF","isRequired":true,"uniqueKey":"data.brand.colors.brand_colors.items.[INDEX].hex","typeLabel":"string"},"name":{"type":"string","description":"A human-readable name for the color, such as `Medium Slate Blue` or `midnightblue`.","example":"Medium Slate Blue","isRequired":true,"uniqueKey":"data.brand.colors.brand_colors.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"How the brand uses the color, when known: `accent`, `brand`, `dark`, `light` or `background`.","example":"accent","uniqueKey":"data.brand.colors.brand_colors.items.[INDEX].type","typeLabel":"string"},"source":{"type":"string","description":"Where the color came from. Present on `screenshot_colors` entries only.","example":"screenshot","uniqueKey":"data.brand.colors.brand_colors.items.[INDEX].source","typeLabel":"string"}},"required":["color","hex","name"],"uniqueKey":"data.brand.colors.brand_colors.items.[INDEX]","typeLabel":"object"},"description":"The brand palette, built from the logo and brand assets. Always present.","isRequired":true,"uniqueKey":"data.brand.colors.brand_colors","typeLabel":"object[]"},"code_colors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","description":"One color scraped from the page's CSS, HTML, or JavaScript.","properties":{"color":{"type":"string","description":"The raw value as written on the page.","example":"#635bff","isRequired":true,"uniqueKey":"data.brand.colors.code_colors.additionalProperties.items.[INDEX].color","typeLabel":"string"},"group":{"type":"string","description":"Nearest named color, used as the group key.","example":"blueviolet","isRequired":true,"uniqueKey":"data.brand.colors.code_colors.additionalProperties.items.[INDEX].group","typeLabel":"string"},"distance":{"type":"number","description":"Distance to that named color. 0 is an exact match.","example":0,"isRequired":true,"uniqueKey":"data.brand.colors.code_colors.additionalProperties.items.[INDEX].distance","typeLabel":"number"},"name":{"type":"string","description":"Tint label within the group, ordered nearest-first.","example":"blueviolet-100","isRequired":true,"uniqueKey":"data.brand.colors.code_colors.additionalProperties.items.[INDEX].name","typeLabel":"string"}},"required":["color","group","distance","name"],"uniqueKey":"data.brand.colors.code_colors.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.brand.colors.code_colors.additionalProperties","typeLabel":"object[]"},"description":"Colors scraped from the page's code, keyed by nearest named color. Present only when `css=true`, `html=true`, or `javascript=true`. Sources are merged into one map, not split per source.","example":{"blueviolet":[{"color":"#635bff","group":"blueviolet","distance":0,"name":"blueviolet-100"}]},"uniqueKey":"data.brand.colors.code_colors","typeLabel":"object"},"screenshot_colors":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string","description":"The color in `rgb()` form.","example":"rgb(99, 91, 255)","isRequired":true,"uniqueKey":"data.brand.colors.screenshot_colors.items.[INDEX].color","typeLabel":"string"},"hex":{"type":"string","description":"The color as a hex triplet.","example":"#635BFF","isRequired":true,"uniqueKey":"data.brand.colors.screenshot_colors.items.[INDEX].hex","typeLabel":"string"},"name":{"type":"string","description":"A human-readable name for the color, such as `Medium Slate Blue` or `midnightblue`.","example":"Medium Slate Blue","isRequired":true,"uniqueKey":"data.brand.colors.screenshot_colors.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"How the brand uses the color, when known: `accent`, `brand`, `dark`, `light` or `background`.","example":"accent","uniqueKey":"data.brand.colors.screenshot_colors.items.[INDEX].type","typeLabel":"string"},"source":{"type":"string","description":"Where the color came from. Present on `screenshot_colors` entries only.","example":"screenshot","uniqueKey":"data.brand.colors.screenshot_colors.items.[INDEX].source","typeLabel":"string"}},"required":["color","hex","name"],"uniqueKey":"data.brand.colors.screenshot_colors.items.[INDEX]","typeLabel":"object"},"description":"Dominant colors sampled from the screenshot. Present only when `screenshotColors=N` is passed.","uniqueKey":"data.brand.colors.screenshot_colors","typeLabel":"object[]"},"roles":{"type":"object","properties":{"primary":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.brand.colors.roles.primary.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.brand.colors.roles.primary.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.colors.roles.primary","typeLabel":"string | null"},"secondary":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.brand.colors.roles.secondary.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.brand.colors.roles.secondary.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.colors.roles.secondary","typeLabel":"string | null"},"background":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.brand.colors.roles.background.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.brand.colors.roles.background.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.colors.roles.background","typeLabel":"string | null"},"text":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.brand.colors.roles.text.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.brand.colors.roles.text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.colors.roles.text","typeLabel":"string | null"},"link":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.brand.colors.roles.link.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.brand.colors.roles.link.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.colors.roles.link","typeLabel":"string | null"}},"required":["primary","secondary","background","text","link"],"description":"The role each color plays on the page, read from its rendered styles: the primary and secondary button fills, the page background, body text and links. Hex, or null where the page gives no clear answer.","example":{"primary":"#635BFF","secondary":"#0A2540","background":"#FFFFFF","text":"#425466","link":"#635BFF"},"uniqueKey":"data.brand.colors.roles","typeLabel":"object"}},"required":["brand_colors"],"isRequired":true,"uniqueKey":"data.brand.colors","typeLabel":"object"},"fonts":{"type":"object","properties":{"families":{"type":"array","items":{"type":"string","uniqueKey":"data.brand.fonts.families.items.[INDEX]","typeLabel":"string"},"description":"Font family names detected on the page.","example":["Inter","Roboto"],"isRequired":true,"uniqueKey":"data.brand.fonts.families","typeLabel":"string[]"}},"required":["families"],"isRequired":true,"uniqueKey":"data.brand.fonts","typeLabel":"object"},"logos":{"type":"object","properties":{"primary":{"oneOf":[{"type":"object","properties":{"url":{"oneOf":[{"type":"string","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg","isRequired":true,"uniqueKey":"data.brand.logos.primary.oneOf.0.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg","isRequired":true,"uniqueKey":"data.brand.logos.primary.oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.logos.primary.oneOf.0.url","typeLabel":"string\u003curi> | null"},"width":{"oneOf":[{"type":"number","description":"Intrinsic width of the logo in pixels.","uniqueKey":"data.brand.logos.primary.oneOf.0.width.oneOf.0","typeLabel":"number"},{"type":"null","description":"Intrinsic width of the logo in pixels.","uniqueKey":"data.brand.logos.primary.oneOf.0.width.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.logos.primary.oneOf.0.width","typeLabel":"number | null"},"height":{"oneOf":[{"type":"number","description":"Intrinsic height of the logo in pixels.","uniqueKey":"data.brand.logos.primary.oneOf.0.height.oneOf.0","typeLabel":"number"},{"type":"null","description":"Intrinsic height of the logo in pixels.","uniqueKey":"data.brand.logos.primary.oneOf.0.height.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.logos.primary.oneOf.0.height","typeLabel":"number | null"},"type":{"type":"string","description":"What the image is, when known, such as `logo`.","example":"logo","uniqueKey":"data.brand.logos.primary.oneOf.0.type","typeLabel":"string"},"format":{"type":"string","description":"The image format, when known, such as `svg` or `png`.","example":"svg","uniqueKey":"data.brand.logos.primary.oneOf.0.format","typeLabel":"string"},"background":{"type":"string","description":"The logo's background, when known, such as `transparent`.","example":"transparent","uniqueKey":"data.brand.logos.primary.oneOf.0.background","typeLabel":"string"}},"required":["url"],"description":"Best candidate for the primary logo.","isRequired":true,"uniqueKey":"data.brand.logos.primary.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"oneOf":[{"type":"string","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg"},{"type":"null","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg"}]},"width":{"oneOf":[{"type":"number","description":"Intrinsic width of the logo in pixels."},{"type":"null","description":"Intrinsic width of the logo in pixels."}]},"height":{"oneOf":[{"type":"number","description":"Intrinsic height of the logo in pixels."},{"type":"null","description":"Intrinsic height of the logo in pixels."}]},"type":{"type":"string","description":"What the image is, when known, such as `logo`.","example":"logo"},"format":{"type":"string","description":"The image format, when known, such as `svg` or `png`.","example":"svg"},"background":{"type":"string","description":"The logo's background, when known, such as `transparent`.","example":"transparent"}},"required":["url"],"description":"Best candidate for the primary logo.","isRequired":true,"uniqueKey":"data.brand.logos.primary.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.logos.primary","typeLabel":"object | null"},"secondary":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"url":{"oneOf":[{"type":"string","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg","isRequired":true,"uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg","isRequired":true,"uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.url","typeLabel":"string\u003curi> | null"},"width":{"oneOf":[{"type":"number","description":"Intrinsic width of the logo in pixels.","uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.width.oneOf.0","typeLabel":"number"},{"type":"null","description":"Intrinsic width of the logo in pixels.","uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.width.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.width","typeLabel":"number | null"},"height":{"oneOf":[{"type":"number","description":"Intrinsic height of the logo in pixels.","uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.height.oneOf.0","typeLabel":"number"},{"type":"null","description":"Intrinsic height of the logo in pixels.","uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.height.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.height","typeLabel":"number | null"},"type":{"type":"string","description":"What the image is, when known, such as `logo`.","example":"logo","uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.type","typeLabel":"string"},"format":{"type":"string","description":"The image format, when known, such as `svg` or `png`.","example":"svg","uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.format","typeLabel":"string"},"background":{"type":"string","description":"The logo's background, when known, such as `transparent`.","example":"transparent","uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0.background","typeLabel":"string"}},"required":["url"],"uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"oneOf":[{"type":"string","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg"},{"type":"null","format":"uri","description":"Public URL to the logo asset.","example":"https://cdn.example.com/logo.svg"}]},"width":{"oneOf":[{"type":"number","description":"Intrinsic width of the logo in pixels."},{"type":"null","description":"Intrinsic width of the logo in pixels."}]},"height":{"oneOf":[{"type":"number","description":"Intrinsic height of the logo in pixels."},{"type":"null","description":"Intrinsic height of the logo in pixels."}]},"type":{"type":"string","description":"What the image is, when known, such as `logo`.","example":"logo"},"format":{"type":"string","description":"The image format, when known, such as `svg` or `png`.","example":"svg"},"background":{"type":"string","description":"The logo's background, when known, such as `transparent`.","example":"transparent"}},"required":["url"],"uniqueKey":"data.brand.logos.secondary.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.logos.secondary.items.[INDEX]","typeLabel":"object | null"},"description":"Other logo candidates found on the page.","isRequired":true,"uniqueKey":"data.brand.logos.secondary","typeLabel":"(object | null)[]"},"favicon_url":{"oneOf":[{"type":"string","format":"uri","description":"URL to the site favicon.","example":"https://stripe.com/favicon.ico","isRequired":true,"uniqueKey":"data.brand.logos.favicon_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to the site favicon.","example":"https://stripe.com/favicon.ico","isRequired":true,"uniqueKey":"data.brand.logos.favicon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.logos.favicon_url","typeLabel":"string\u003curi> | null"},"icon_url":{"oneOf":[{"type":"string","format":"uri","description":"URL to the site icon.","isRequired":true,"uniqueKey":"data.brand.logos.icon_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to the site icon.","isRequired":true,"uniqueKey":"data.brand.logos.icon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.logos.icon_url","typeLabel":"string\u003curi> | null"},"apple_touch_icon":{"oneOf":[{"type":"string","format":"uri","description":"URL to the Apple Touch Icon.","isRequired":true,"uniqueKey":"data.brand.logos.apple_touch_icon.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to the Apple Touch Icon.","isRequired":true,"uniqueKey":"data.brand.logos.apple_touch_icon.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.logos.apple_touch_icon","typeLabel":"string\u003curi> | null"}},"required":["primary","secondary","favicon_url","icon_url","apple_touch_icon"],"isRequired":true,"uniqueKey":"data.brand.logos","typeLabel":"object"},"images":{"type":"object","properties":{"og_image":{"oneOf":[{"type":"string","format":"uri","description":"OpenGraph image URL.","isRequired":true,"uniqueKey":"data.brand.images.og_image.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"OpenGraph image URL.","isRequired":true,"uniqueKey":"data.brand.images.og_image.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.images.og_image","typeLabel":"string\u003curi> | null"},"twitter_image":{"oneOf":[{"type":"string","format":"uri","description":"Twitter card image URL.","isRequired":true,"uniqueKey":"data.brand.images.twitter_image.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Twitter card image URL.","isRequired":true,"uniqueKey":"data.brand.images.twitter_image.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.images.twitter_image","typeLabel":"string\u003curi> | null"},"screenshot_url":{"oneOf":[{"type":"string","format":"uri","description":"URL to the page screenshot stored in cloud storage.","isRequired":true,"uniqueKey":"data.brand.images.screenshot_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to the page screenshot stored in cloud storage.","isRequired":true,"uniqueKey":"data.brand.images.screenshot_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brand.images.screenshot_url","typeLabel":"string\u003curi> | null"},"assets":{"type":"array","items":{"type":"object","description":"An image harvested from the site or its social profiles, such as a Twitter banner.","properties":{"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.brand.images.assets.items.[INDEX].url","typeLabel":"string\u003curi>"},"alt":{"oneOf":[{"type":"string","uniqueKey":"data.brand.images.assets.items.[INDEX].alt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.brand.images.assets.items.[INDEX].alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.images.assets.items.[INDEX].alt","typeLabel":"string | null"},"width":{"oneOf":[{"type":"number","uniqueKey":"data.brand.images.assets.items.[INDEX].width.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.brand.images.assets.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.images.assets.items.[INDEX].width","typeLabel":"number | null"},"height":{"oneOf":[{"type":"number","uniqueKey":"data.brand.images.assets.items.[INDEX].height.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.brand.images.assets.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.images.assets.items.[INDEX].height","typeLabel":"number | null"}},"required":["url"],"uniqueKey":"data.brand.images.assets.items.[INDEX]","typeLabel":"object"},"description":"Additional brand imagery found on the site and its social profiles.","uniqueKey":"data.brand.images.assets","typeLabel":"object[]"}},"required":["og_image","twitter_image","screenshot_url"],"isRequired":true,"uniqueKey":"data.brand.images","typeLabel":"object"},"social_links":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.brand.social_links.additionalProperties","typeLabel":"string"},"description":"Social media profile URLs keyed by platform name.","example":{"twitter":"https://twitter.com/stripe","linkedin":"https://linkedin.com/company/stripe"},"isRequired":true,"uniqueKey":"data.brand.social_links","typeLabel":"object"},"design_tokens":{"type":"object","description":"The site's design system by role, read from the rendered page. Present only when the request sets `designTokens=true`. Best effort: a field the page gives no reliable answer for is `null`.","properties":{"color_scheme":{"oneOf":[{"type":"string","enum":["light","dark"],"description":"Whether the page background is light or dark.","example":"light","uniqueKey":"data.brand.design_tokens.color_scheme.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["light","dark"],"description":"Whether the page background is light or dark.","example":"light","uniqueKey":"data.brand.design_tokens.color_scheme.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.color_scheme","typeLabel":"enum\u003cstring> | null"},"colors":{"type":"object","properties":{"primary":{"oneOf":[{"type":"string","description":"The main action color: the fill of the most prominent button, or a colored link when no button is filled.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.colors.primary.oneOf.0","typeLabel":"string"},{"type":"null","description":"The main action color: the fill of the most prominent button, or a colored link when no button is filled.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.colors.primary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.colors.primary","typeLabel":"string | null"},"secondary":{"oneOf":[{"type":"string","description":"The fill of the next most prominent button, when it is a distinct color.","uniqueKey":"data.brand.design_tokens.colors.secondary.oneOf.0","typeLabel":"string"},{"type":"null","description":"The fill of the next most prominent button, when it is a distinct color.","uniqueKey":"data.brand.design_tokens.colors.secondary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.colors.secondary","typeLabel":"string | null"},"background":{"oneOf":[{"type":"string","description":"The page background.","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.colors.background.oneOf.0","typeLabel":"string"},{"type":"null","description":"The page background.","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.colors.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.colors.background","typeLabel":"string | null"},"text":{"oneOf":[{"type":"string","description":"Body text.","example":"#50617A","uniqueKey":"data.brand.design_tokens.colors.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Body text.","example":"#50617A","uniqueKey":"data.brand.design_tokens.colors.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.colors.text","typeLabel":"string | null"},"heading":{"oneOf":[{"type":"string","description":"The color most headings share.","example":"#061B31","uniqueKey":"data.brand.design_tokens.colors.heading.oneOf.0","typeLabel":"string"},{"type":"null","description":"The color most headings share.","example":"#061B31","uniqueKey":"data.brand.design_tokens.colors.heading.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.colors.heading","typeLabel":"string | null"},"link":{"oneOf":[{"type":"string","description":"The most common color of in-content links.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.colors.link.oneOf.0","typeLabel":"string"},{"type":"null","description":"The most common color of in-content links.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.colors.link.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.colors.link","typeLabel":"string | null"}},"uniqueKey":"data.brand.design_tokens.colors","typeLabel":"object"},"typography":{"type":"object","properties":{"body":{"type":"object","properties":{"font_family":{"oneOf":[{"type":"string","description":"The first family in the stack.","example":"sohne-var","uniqueKey":"data.brand.design_tokens.typography.body.font_family.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first family in the stack.","example":"sohne-var","uniqueKey":"data.brand.design_tokens.typography.body.font_family.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.body.font_family","typeLabel":"string | null"},"font_stack":{"type":"array","items":{"type":"string","uniqueKey":"data.brand.design_tokens.typography.body.font_stack.items.[INDEX]","typeLabel":"string"},"description":"The full `font-family` list, in order.","example":["sohne-var","Helvetica Neue","Arial","sans-serif"],"uniqueKey":"data.brand.design_tokens.typography.body.font_stack","typeLabel":"string[]"},"font_size":{"oneOf":[{"type":"string","example":"16px","uniqueKey":"data.brand.design_tokens.typography.body.font_size.oneOf.0","typeLabel":"string"},{"type":"null","example":"16px","uniqueKey":"data.brand.design_tokens.typography.body.font_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.body.font_size","typeLabel":"string | null"},"font_weight":{"oneOf":[{"type":"number","example":400,"uniqueKey":"data.brand.design_tokens.typography.body.font_weight.oneOf.0","typeLabel":"number"},{"type":"null","example":400,"uniqueKey":"data.brand.design_tokens.typography.body.font_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.body.font_weight","typeLabel":"number | null"},"line_height":{"oneOf":[{"type":"string","description":"`null` when the site leaves it at `normal`.","example":"24px","uniqueKey":"data.brand.design_tokens.typography.body.line_height.oneOf.0","typeLabel":"string"},{"type":"null","description":"`null` when the site leaves it at `normal`.","example":"24px","uniqueKey":"data.brand.design_tokens.typography.body.line_height.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.body.line_height","typeLabel":"string | null"}},"uniqueKey":"data.brand.design_tokens.typography.body","typeLabel":"object"},"heading":{"type":"object","properties":{"font_family":{"oneOf":[{"type":"string","description":"The lead heading's first family.","example":"sohne-var","uniqueKey":"data.brand.design_tokens.typography.heading.font_family.oneOf.0","typeLabel":"string"},{"type":"null","description":"The lead heading's first family.","example":"sohne-var","uniqueKey":"data.brand.design_tokens.typography.heading.font_family.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.heading.font_family","typeLabel":"string | null"},"font_stack":{"type":"array","items":{"type":"string","uniqueKey":"data.brand.design_tokens.typography.heading.font_stack.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.brand.design_tokens.typography.heading.font_stack","typeLabel":"string[]"},"font_weight":{"oneOf":[{"type":"number","example":500,"uniqueKey":"data.brand.design_tokens.typography.heading.font_weight.oneOf.0","typeLabel":"number"},{"type":"null","example":500,"uniqueKey":"data.brand.design_tokens.typography.heading.font_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.heading.font_weight","typeLabel":"number | null"}},"uniqueKey":"data.brand.design_tokens.typography.heading","typeLabel":"object"},"sizes":{"type":"object","description":"Font size of the first visible heading at each level, and of body text.","properties":{"h1":{"oneOf":[{"type":"string","example":"48px","uniqueKey":"data.brand.design_tokens.typography.sizes.h1.oneOf.0","typeLabel":"string"},{"type":"null","example":"48px","uniqueKey":"data.brand.design_tokens.typography.sizes.h1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.sizes.h1","typeLabel":"string | null"},"h2":{"oneOf":[{"type":"string","example":"32px","uniqueKey":"data.brand.design_tokens.typography.sizes.h2.oneOf.0","typeLabel":"string"},{"type":"null","example":"32px","uniqueKey":"data.brand.design_tokens.typography.sizes.h2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.sizes.h2","typeLabel":"string | null"},"h3":{"oneOf":[{"type":"string","example":"26px","uniqueKey":"data.brand.design_tokens.typography.sizes.h3.oneOf.0","typeLabel":"string"},{"type":"null","example":"26px","uniqueKey":"data.brand.design_tokens.typography.sizes.h3.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.sizes.h3","typeLabel":"string | null"},"body":{"oneOf":[{"type":"string","example":"16px","uniqueKey":"data.brand.design_tokens.typography.sizes.body.oneOf.0","typeLabel":"string"},{"type":"null","example":"16px","uniqueKey":"data.brand.design_tokens.typography.sizes.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.typography.sizes.body","typeLabel":"string | null"}},"uniqueKey":"data.brand.design_tokens.typography.sizes","typeLabel":"object"}},"uniqueKey":"data.brand.design_tokens.typography","typeLabel":"object"},"components":{"type":"object","properties":{"button_primary":{"oneOf":[{"type":"object","properties":{"background":{"oneOf":[{"type":"string","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.background.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.background","typeLabel":"string | null"},"text_color":{"oneOf":[{"type":"string","description":"Label color.","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.text_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label color.","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.text_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.text_color","typeLabel":"string | null"},"border_color":{"oneOf":[{"type":"string","description":"Border color, when the button has a visible border.","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.border_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Border color, when the button has a visible border.","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.border_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.border_color","typeLabel":"string | null"},"border_radius":{"oneOf":[{"type":"string","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.border_radius.oneOf.0","typeLabel":"string"},{"type":"null","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px","uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.border_radius.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.border_radius","typeLabel":"string | null"},"font_weight":{"oneOf":[{"type":"number","description":"Label weight.","example":400,"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.font_weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"Label weight.","example":400,"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.font_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0.font_weight","typeLabel":"number | null"}},"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"background":{"oneOf":[{"type":"string","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD"},{"type":"null","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD"}]},"text_color":{"oneOf":[{"type":"string","description":"Label color.","example":"#FFFFFF"},{"type":"null","description":"Label color.","example":"#FFFFFF"}]},"border_color":{"oneOf":[{"type":"string","description":"Border color, when the button has a visible border."},{"type":"null","description":"Border color, when the button has a visible border."}]},"border_radius":{"oneOf":[{"type":"string","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px"},{"type":"null","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px"}]},"font_weight":{"oneOf":[{"type":"number","description":"Label weight.","example":400},{"type":"null","description":"Label weight.","example":400}]}},"uniqueKey":"data.brand.design_tokens.components.button_primary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_primary","typeLabel":"object | null"},"button_secondary":{"oneOf":[{"type":"object","properties":{"background":{"oneOf":[{"type":"string","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.background.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.background","typeLabel":"string | null"},"text_color":{"oneOf":[{"type":"string","description":"Label color.","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.text_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label color.","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.text_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.text_color","typeLabel":"string | null"},"border_color":{"oneOf":[{"type":"string","description":"Border color, when the button has a visible border.","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.border_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Border color, when the button has a visible border.","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.border_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.border_color","typeLabel":"string | null"},"border_radius":{"oneOf":[{"type":"string","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.border_radius.oneOf.0","typeLabel":"string"},{"type":"null","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px","uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.border_radius.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.border_radius","typeLabel":"string | null"},"font_weight":{"oneOf":[{"type":"number","description":"Label weight.","example":400,"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.font_weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"Label weight.","example":400,"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.font_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0.font_weight","typeLabel":"number | null"}},"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"background":{"oneOf":[{"type":"string","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD"},{"type":"null","description":"Fill color. `null` for an outlined or text-only button.","example":"#533AFD"}]},"text_color":{"oneOf":[{"type":"string","description":"Label color.","example":"#FFFFFF"},{"type":"null","description":"Label color.","example":"#FFFFFF"}]},"border_color":{"oneOf":[{"type":"string","description":"Border color, when the button has a visible border."},{"type":"null","description":"Border color, when the button has a visible border."}]},"border_radius":{"oneOf":[{"type":"string","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px"},{"type":"null","description":"Corner radius. `9999px` means fully rounded (a pill).","example":"4px"}]},"font_weight":{"oneOf":[{"type":"number","description":"Label weight.","example":400},{"type":"null","description":"Label weight.","example":400}]}},"uniqueKey":"data.brand.design_tokens.components.button_secondary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.button_secondary","typeLabel":"object | null"},"input":{"oneOf":[{"type":"object","description":"The first visible text field.","properties":{"background":{"oneOf":[{"type":"string","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.background.oneOf.0","typeLabel":"string"},{"type":"null","example":"#FFFFFF","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.background","typeLabel":"string | null"},"text_color":{"oneOf":[{"type":"string","example":"#061B31","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.text_color.oneOf.0","typeLabel":"string"},{"type":"null","example":"#061B31","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.text_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.text_color","typeLabel":"string | null"},"border_color":{"oneOf":[{"type":"string","example":"#E5EDF5","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.border_color.oneOf.0","typeLabel":"string"},{"type":"null","example":"#E5EDF5","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.border_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.border_color","typeLabel":"string | null"},"border_radius":{"oneOf":[{"type":"string","example":"4px","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.border_radius.oneOf.0","typeLabel":"string"},{"type":"null","example":"4px","uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.border_radius.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.input.oneOf.0.border_radius","typeLabel":"string | null"}},"uniqueKey":"data.brand.design_tokens.components.input.oneOf.0","typeLabel":"object"},{"type":"null","description":"The first visible text field.","properties":{"background":{"oneOf":[{"type":"string","example":"#FFFFFF"},{"type":"null","example":"#FFFFFF"}]},"text_color":{"oneOf":[{"type":"string","example":"#061B31"},{"type":"null","example":"#061B31"}]},"border_color":{"oneOf":[{"type":"string","example":"#E5EDF5"},{"type":"null","example":"#E5EDF5"}]},"border_radius":{"oneOf":[{"type":"string","example":"4px"},{"type":"null","example":"4px"}]}},"uniqueKey":"data.brand.design_tokens.components.input.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.components.input","typeLabel":"object | null"}},"uniqueKey":"data.brand.design_tokens.components","typeLabel":"object"},"border_radius":{"oneOf":[{"type":"string","description":"The primary button's corner radius, a good proxy for the site's rounding.","example":"4px","uniqueKey":"data.brand.design_tokens.border_radius.oneOf.0","typeLabel":"string"},{"type":"null","description":"The primary button's corner radius, a good proxy for the site's rounding.","example":"4px","uniqueKey":"data.brand.design_tokens.border_radius.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand.design_tokens.border_radius","typeLabel":"string | null"}},"uniqueKey":"data.brand.design_tokens","typeLabel":"object"}},"required":["colors","fonts","logos","images","social_links"],"isRequired":true,"uniqueKey":"data.brand","typeLabel":"object"}},"required":["url","domain","brand"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","data","meta"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"url":"https://stripe.com","domain":"stripe.com","brand":{"colors":{"brand_colors":[{"color":"rgb(99, 91, 255)","hex":"#635BFF","name":"Medium Slate Blue","type":"accent","source":"screenshot"}],"code_colors":{"blueviolet":[{"color":"#635bff","group":"blueviolet","distance":0,"name":"blueviolet-100"}]},"screenshot_colors":[{"color":"rgb(99, 91, 255)","hex":"#635BFF","name":"Medium Slate Blue","type":"accent","source":"screenshot"}],"roles":{"primary":"#635BFF","secondary":"#0A2540","background":"#FFFFFF","text":"#425466","link":"#635BFF"}},"fonts":{"families":["Inter","Roboto"]},"logos":{"primary":{"url":"https://cdn.example.com/logo.svg","width":123,"height":123,"type":"logo","format":"svg","background":"transparent"},"secondary":[{"url":"https://cdn.example.com/logo.svg","width":123,"height":123,"type":"logo","format":"svg","background":"transparent"}],"favicon_url":"https://stripe.com/favicon.ico","icon_url":"\u003cstring>","apple_touch_icon":"\u003cstring>"},"images":{"og_image":"\u003cstring>","twitter_image":"\u003cstring>","screenshot_url":"\u003cstring>","assets":[{"url":"\u003cstring>","alt":"\u003cstring>","width":123,"height":123}]},"social_links":{"twitter":"https://twitter.com/stripe","linkedin":"https://linkedin.com/company/stripe"},"design_tokens":{"color_scheme":"light","colors":{"primary":"#533AFD","secondary":"\u003cstring>","background":"#FFFFFF","text":"#50617A","heading":"#061B31","link":"#533AFD"},"typography":{"body":{"font_family":"sohne-var","font_stack":["sohne-var","Helvetica Neue","Arial","sans-serif"],"font_size":"16px","font_weight":400,"line_height":"24px"},"heading":{"font_family":"sohne-var","font_stack":["\u003cstring>"],"font_weight":500},"sizes":{"h1":"48px","h2":"32px","h3":"26px","body":"16px"}},"components":{"button_primary":{"background":"#533AFD","text_color":"#FFFFFF","border_color":"\u003cstring>","border_radius":"4px","font_weight":400},"button_secondary":{"background":"#533AFD","text_color":"#FFFFFF","border_color":"\u003cstring>","border_radius":"4px","font_weight":400},"input":{"background":"#FFFFFF","text_color":"#061B31","border_color":"#E5EDF5","border_radius":"4px"}},"border_radius":"4px"}}},"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"4dd34fe8-2071-438f-938c-4aa7d93ce9f0":{"description":"Invalid URL or parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"2aebcb1f-554e-4017-8584-5196b1c9d10d":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"12827a58-eeab-451c-bda1-2edfae33be9a":{"description":"Revoked key, expired key, credit limit, or blocklisted URL.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"cd41e64c-bd6a-48b4-9f29-b1b43ea5126a":{"description":"URL hostname could not be resolved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"c059d70e-6e03-42ed-a5cb-773356609aec":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"a542b146-3fc7-42b8-bd54-a4cffd2789fd":{"description":"Service temporarily busy — retry shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"69e4918a-56bb-4e2c-9f12-c3587ed7d1c4":{"description":"Request timed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a1fe7f7c-62a7-42f3-b340-a37bf2940fc6":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your Prefetch API key. Obtain one from the dashboard.","scopes":[],"schemeName":"apiKey"}}},"servers":{"a72447d6-010c-4889-ae7b-b9e4d80db41a":{"url":"https://api.prefetch.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your Prefetch API key. Obtain one from the dashboard.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","description":"Your Prefetch API key. Obtain one from the dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"prefetch","siteName":"Prefetch API","title":"GET /brand - Prefetch API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T00:20:50.158Z","originalFileLocation":"api-reference/endpoint/brand.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=\"dark\"}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=\"Colors, logos, fonts, images and social links for any website. 10 credits.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Prefetch API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_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/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_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/prefetch/LfH_u0wIgIMJj9SU/_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/prefetch/LfH_u0wIgIMJj9SU/_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/prefetch/LfH_u0wIgIMJj9SU/_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/prefetch/LfH_u0wIgIMJj9SU/_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/prefetch/LfH_u0wIgIMJj9SU/_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/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"GET /brand - Prefetch API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Colors, logos, fonts, images and social links for any website. 10 credits.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Prefetch API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.prefetch.io/api-reference/endpoint/brand\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://prefetch.mintlify.site/_mintlify/api/og/v2?division=Company+data\u0026amp;title=GET+%2Fbrand\u0026amp;description=Colors%2C+logos%2C+fonts%2C+images+and+social+links+for+any+website.+10+credits.\u0026amp;theme=53a3f409698e98a035ca36d8\u0026amp;signature=4f337349d7b9408de540abcebe3aa4bb4203528a50e4854b4f6d402d025b8690\">\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=\"GET /brand - Prefetch API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Colors, logos, fonts, images and social links for any website. 10 credits.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://prefetch.mintlify.site/_mintlify/api/og/v2?division=Company+data\u0026amp;title=GET+%2Fbrand\u0026amp;description=Colors%2C+logos%2C+fonts%2C+images+and+social+links+for+any+website.+10+credits.\u0026amp;theme=53a3f409698e98a035ca36d8\u0026amp;signature=4f337349d7b9408de540abcebe3aa4bb4203528a50e4854b4f6d402d025b8690\">\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/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Prefetch API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8A5A00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.prefetch.io/api-reference/endpoint/brand\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/brand.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.prefetch.io/#organization\",\"name\":\"Prefetch API\",\"url\":\"https://docs.prefetch.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/light.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=7b9ea0ec7c23b929ff607e56c0de9713\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.prefetch.io#website\",\"name\":\"Prefetch API\",\"url\":\"https://docs.prefetch.io\",\"publisher\":{\"@id\":\"https://docs.prefetch.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/brand#webpage\",\"url\":\"https://docs.prefetch.io/api-reference/endpoint/brand\",\"name\":\"GET /brand\",\"description\":\"Colors, logos, fonts, images and social links for any website. 10 credits.\",\"dateModified\":\"2026-11-05T00:20:50.158Z\",\"isPartOf\":{\"@id\":\"https://docs.prefetch.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/brand#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/brand#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Company data\",\"item\":\"https://docs.prefetch.io/api-reference/endpoint/enrich\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GET /brand\",\"item\":\"https://docs.prefetch.io/api-reference/endpoint/brand\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/brand#apireference\",\"headline\":\"GET /brand\",\"name\":\"GET /brand\",\"description\":\"Colors, logos, fonts, images and social links for any website. 10 credits.\",\"url\":\"https://docs.prefetch.io/api-reference/endpoint/brand\",\"mainEntityOfPage\":{\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/brand#webpage\"},\"dateModified\":\"2026-11-05T00:20:50.158Z\",\"publisher\":{\"@id\":\"https://docs.prefetch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.prefetch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Prefetch API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Prefetch API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/brand.md","siteName":"Prefetch API","nav":{"global":{},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"}]},{"group":"Find a company","pages":[{"title":"GET /resolve","sidebarTitle":"Resolve a name","openapi":"GET /resolve","href":"/api-reference/endpoint/resolve"},{"title":"GET /transaction","sidebarTitle":"Card transaction","openapi":"GET /transaction","href":"/api-reference/endpoint/transaction"}]},{"group":"Company data","pages":[{"title":"GET /enrich","sidebarTitle":"Enrich","description":"Brand, company and IAB classification for a domain in one request. 12 credits.","openapi":"GET /enrich","href":"/api-reference/endpoint/enrich"},{"title":"GET /brand","sidebarTitle":"Brand","openapi":"GET /brand","href":"/api-reference/endpoint/brand"},{"title":"GET /company","sidebarTitle":"Company","description":"Legal name, contact emails, addresses and key pages for the company behind a website. 5 credits.","openapi":"GET /company","href":"/api-reference/endpoint/company"},{"title":"GET /classify","sidebarTitle":"Classify","openapi":"GET /classify","href":"/api-reference/endpoint/classify"},{"title":"GET /styleguide","sidebarTitle":"Styleguide","openapi":"GET /styleguide","href":"/api-reference/endpoint/styleguide"}]},{"group":"Web data","pages":[{"title":"GET /scrape","sidebarTitle":"Scrape","openapi":"GET /scrape","href":"/api-reference/endpoint/scrape"},{"title":"GET /search","sidebarTitle":"Search","openapi":"GET /search","href":"/api-reference/endpoint/search"},{"title":"GET /map","sidebarTitle":"Map","openapi":"GET /map","href":"/api-reference/endpoint/map"},{"title":"GET /screenshot","sidebarTitle":"Screenshot","openapi":"GET /screenshot","href":"/api-reference/endpoint/screenshot"}]},{"group":"Crawls","pages":[{"title":"POST /crawl","sidebarTitle":"Start a crawl","openapi":"POST /crawl","href":"/api-reference/endpoint/crawl"},{"title":"GET /crawl/{id}","sidebarTitle":"Get crawl status","openapi":"GET /crawl/{id}","href":"/api-reference/endpoint/crawl-status"},{"title":"GET /crawl/{id}/errors","sidebarTitle":"Get crawl errors","openapi":"GET /crawl/{id}/errors","href":"/api-reference/endpoint/crawl-errors"},{"title":"DELETE /crawl/{id}","sidebarTitle":"Cancel a crawl","openapi":"DELETE /crawl/{id}","href":"/api-reference/endpoint/crawl-cancel"}]},{"group":"Batches","pages":[{"title":"POST /batch/scrape","sidebarTitle":"Start a batch scrape","openapi":"POST /batch/scrape","href":"/api-reference/endpoint/batch-scrape"},{"title":"GET /batch/scrape/{id}","sidebarTitle":"Get batch scrape status","openapi":"GET /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-status"},{"title":"GET /batch/scrape/{id}/errors","sidebarTitle":"Get batch scrape errors","openapi":"GET /batch/scrape/{id}/errors","href":"/api-reference/endpoint/batch-scrape-errors"},{"title":"DELETE /batch/scrape/{id}","sidebarTitle":"Cancel a batch scrape","openapi":"DELETE /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-cancel"},{"title":"POST /batch/{endpoint}","sidebarTitle":"Start a batch","openapi":"POST /batch/{endpoint}","href":"/api-reference/endpoint/batch"},{"title":"GET /batch/{endpoint}/{id}","sidebarTitle":"Get batch status","openapi":"GET /batch/{endpoint}/{id}","href":"/api-reference/endpoint/batch-status"},{"title":"GET /batch/{endpoint}/{id}/errors","sidebarTitle":"Get batch errors","openapi":"GET /batch/{endpoint}/{id}/errors","href":"/api-reference/endpoint/batch-errors"},{"title":"DELETE /batch/{endpoint}/{id}","sidebarTitle":"Cancel a batch","openapi":"DELETE /batch/{endpoint}/{id}","href":"/api-reference/endpoint/batch-cancel"}]},{"group":"Monitors","pages":[{"title":"POST /monitor","sidebarTitle":"Create a monitor","openapi":"POST /monitor","href":"/api-reference/endpoint/monitor"},{"title":"GET /monitor","sidebarTitle":"List monitors","openapi":"GET /monitor","href":"/api-reference/endpoint/monitor-list"},{"title":"GET /monitor/{id}","sidebarTitle":"Get a monitor","openapi":"GET /monitor/{id}","href":"/api-reference/endpoint/monitor-get"},{"title":"PATCH /monitor/{id}","sidebarTitle":"Update a monitor","openapi":"PATCH /monitor/{id}","href":"/api-reference/endpoint/monitor-update"},{"title":"DELETE /monitor/{id}","sidebarTitle":"Delete a monitor","openapi":"DELETE /monitor/{id}","href":"/api-reference/endpoint/monitor-delete"},{"title":"POST /monitor/{id}/run","sidebarTitle":"Run a check now","openapi":"POST /monitor/{id}/run","href":"/api-reference/endpoint/monitor-run"},{"title":"GET /monitor/{id}/checks","sidebarTitle":"List checks","openapi":"GET /monitor/{id}/checks","href":"/api-reference/endpoint/monitor-checks"},{"title":"GET /monitor/{id}/checks/{checkId}","sidebarTitle":"Get a check","openapi":"GET /monitor/{id}/checks/{checkId}","href":"/api-reference/endpoint/monitor-check"},{"group":"Webhooks","pages":[{"title":"monitor.page webhook","sidebarTitle":"monitor.page event","openapi":"WEBHOOK monitor.page","href":"/api-reference/endpoint/monitor-webhook-page"},{"title":"monitor.check.completed webhook","sidebarTitle":"monitor.check.completed event","openapi":"WEBHOOK monitor.check.completed","href":"/api-reference/endpoint/monitor-webhook-check"}]}]},{"group":"Logo CDN","pages":[{"title":"GET /logo/token","sidebarTitle":"Get logo token","openapi":"GET /logo/token","href":"/api-reference/endpoint/logo-token"},{"title":"POST /logo/token/rotate","sidebarTitle":"Rotate logo token","openapi":"POST /logo/token/rotate","href":"/api-reference/endpoint/logo-token-rotate"}]},{"group":"Service","pages":[{"title":"GET /health","sidebarTitle":"Health","openapi":"GET /health","href":"/api-reference/endpoint/health"},{"title":"GET /ready","sidebarTitle":"Readiness","openapi":"GET /ready","href":"/api-reference/endpoint/ready"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"GET /brand - Prefetch API","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","Page-DDHbuAIY.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","clsx-B2t_mZQG.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CUljsAY7.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Cf70306N.js"]}