This endpoint performs a Google web search and optionally scrapes the content of the top search results, returning both search results and scraped content.
{ "query": "string", // Required. The search query. "country": "string", // Optional. Country code for location bias (e.g., "US" for United States). "location": "string", // Optional. Specific location to focus the search (e.g., "New York, NY"). "language": "string", // Optional. Language code for the search results (e.g., "en" for English). "dateRange": "string", // Optional. Can be "anyTime", "pastHour", "pastDay", "pastWeek", "pastMonth", or "pastYear". "page": "number", // Optional. Page number for paginated results. "scrapeResults": "boolean", // Optional. Whether to scrape top search results. Default: false. "numResultsToScrape": "number", // Optional. Number of top results to scrape. Default: 3. Max: 10. "scrapeOptions": { // Optional. Options for scraping, if scrapeResults is true. "format": "string", // Optional. The format of the output. Valid values: "markdown", "html", "screenshot". Default: "markdown". "cleaned": "boolean" // Optional. Whether the output should be cleaned. Default: true. }}
The maximum number of results that can be scraped is 10.
If numResultsToScrape is set higher than 10, it will be capped at 10.
If numResultsToScrape is not provided, the default value is 3.
Credit usage:
Base cost for search: 30 credits per page of results
Additional credits for scraping are charged normally on the /scrape endpoint.
If scrapeResults is false, no URLs will be scraped and the scrapeOutput field will not be present in the organic results.
The scrapeOptions field allows customization of the scraping process:
format can be “markdown”, “html”, or “screenshot”. If not specified, “markdown” is used.
cleaned determines whether the output should be cleaned. If not specified, it defaults to true.
The dateRange parameter can be used to filter results by date. Valid values are “anyTime”, “pastHour”, “pastDay”, “pastWeek”, “pastMonth”, or “pastYear”.
The country parameter should be a two-letter country code (e.g., “US” for United States).
The location parameter can be used to focus the search on a specific area. You can find a list of supported locations at GET: /api/v1/google-locations
The language parameter can be used to specify the desired language for the search results.
Usage is recorded with detailed parameters for each request.
Events may be logged for analytics purposes if enabled.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DumplingAI Docs","colors":{"primary":"#000","light":"#fdfdfd","dark":"#000"},"logo":"https://mintcdn.com/dumplingai/ovQfojsBnkaBEyWP/dumplingai-logo.svg?fit=max\u0026auto=format\u0026n=ovQfojsBnkaBEyWP\u0026q=85\u0026s=46740c45e1bef65a42e4a799407a5d32","favicon":"https://mintcdn.com/dumplingai/ovQfojsBnkaBEyWP/dumplingai-logo.svg?fit=max\u0026auto=format\u0026n=ovQfojsBnkaBEyWP\u0026q=85\u0026s=46740c45e1bef65a42e4a799407a5d32","navbar":{"links":[{"href":"mailto:help@dumplingai.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.dumplingai.com"}},"footer":{"socials":{"twitter":"https://twitter.com/dumplingai","linkedin":"https://www.linkedin.com/company/dumplingai"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dumplingai","hasAudioNarration":false,"actualSubdomain":"dumplingai","customDomains":["docs.dumplingai.com"],"gitSource":{"type":"github","owner":"dumplingai","repo":"dumplingai","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9205ae285e7410aaf970d:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":52},{"language":"default","tag":"Data APIs","count":23},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Document Processing","count":10},{"language":"default","tag":"Core Features","count":7},{"language":"default","tag":"Start Here","count":6},{"language":"default","tag":"Overview","count":5},{"language":"default","tag":"Web Scraping","count":4},{"language":"default","tag":"Usage APIs","count":3},{"language":"default","tag":"AI","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/search","slug":"/api-reference/endpoint/search","pageMetadata":{"title":"Search","openapi":"POST /api/v1/search","description":"Perform a federated web search returning organic results, snippets, and metadata.","href":"/api-reference/endpoint/search"},"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: \"Perform a federated web search returning organic results, snippets, and metadata.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`description`,children:`Description`}),`\n`,_jsx(_components.p,{children:`This endpoint performs a Google web search and optionally scrapes the content of the top search results, returning both search results and scraped content.`}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint`,children:`Endpoint`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST https://app.dumplingai.com/api/v1/search`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`headers`,children:`Headers`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Content-Type:`}),` `,_jsx(_components.code,{children:`application/json`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Authorization:`}),` Bearer `,_jsx(_components.code,{children:`\u003cAPI_KEY>`}),` (required)`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request Body`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"query\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Required. The search query.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Country code for location bias (e.g., \"US\" for United States).`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"location\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Specific location to focus the search (e.g., \"New York, NY\").`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"language\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Language code for the search results (e.g., \"en\" for English).`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dateRange\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Can be \"anyTime\", \"pastHour\", \"pastDay\", \"pastWeek\", \"pastMonth\", or \"pastYear\".`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"page\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Page number for paginated results.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scrapeResults\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Whether to scrape top search results. Default: false.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"numResultsToScrape\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Number of top results to scrape. Default: 3. Max: 10.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scrapeOptions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Optional. Options for scraping, if scrapeResults is true.`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"format\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. The format of the output. Valid values: \"markdown\", \"html\", \"screenshot\". Default: \"markdown\".`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cleaned\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Optional. Whether the output should be cleaned. Default: true.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`responses`,children:`Responses`}),`\n`,_jsx(Heading,{level:`3`,id:`success-200`,children:`Success (200)`}),`\n`,_jsx(_components.p,{children:`Returns the search results and optionally scraped content.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`53`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`53`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"searchParameters\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"q\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// The search query`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// e.g., \"search\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"engine\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// e.g., \"google\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"gl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Google country code`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"hl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Optional. Host language`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"organic\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"link\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"snippet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"position\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sitelinks\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"link\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional. Publication date if available`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scrapeOutput\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // Optional. Present only if scraping was requested`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"format\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// \"markdown\", \"html\", or \"screenshot\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cleaned\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"content\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"featuredSnippet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"link\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"snippet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"position\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"relatedSearches\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"query\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"peopleAlsoAsk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"question\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"snippet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"link\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Content-Type:`}),` application/json`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`X-RateLimit-Limit:`}),` The rate limit for the user.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`X-RateLimit-Remaining:`}),` The remaining number of requests for the user.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`bad-request-400`,children:`Bad Request (400)`}),`\n`,_jsx(_components.p,{children:`Returned if the request is invalid.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Error message describing the issue\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`unauthorized-401`,children:`Unauthorized (401)`}),`\n`,_jsx(_components.p,{children:`Returned if the API key is invalid or missing.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Invalid or missing Authorization header\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`internal-server-error-500`,children:`Internal Server Error (500)`}),`\n`,_jsx(_components.p,{children:`Returned if there’s an error during the search or scraping process.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Failed to perform search: [error message]\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`example-request`,children:`Example Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`15`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://app.dumplingai.com/api/v1/search`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization: Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"query\": \"DumplingAI\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"country\": \"US\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"language\": \"en\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"dateRange\": \"pastMonth\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"scrapeResults\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"numResultsToScrape\": 3,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"scrapeOptions\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"format\": \"html\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"cleaned\": false`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`notes`,children:`Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The maximum number of results that can be scraped is 10.`}),`\n`,_jsxs(_components.li,{children:[`If `,_jsx(_components.code,{children:`numResultsToScrape`}),` is set higher than 10, it will be capped at 10.`]}),`\n`,_jsxs(_components.li,{children:[`If `,_jsx(_components.code,{children:`numResultsToScrape`}),` is not provided, the default value is 3.`]}),`\n`,_jsxs(_components.li,{children:[`Credit usage:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Base cost for search: 30 credits per page of results`}),`\n`,_jsx(_components.li,{children:`Additional credits for scraping are charged normally on the /scrape endpoint.`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`If `,_jsx(_components.code,{children:`scrapeResults`}),` is false, no URLs will be scraped and the `,_jsx(_components.code,{children:`scrapeOutput`}),` field will not be present in the organic results.`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`scrapeOptions`}),` field allows customization of the scraping process:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`format`}),` can be “markdown”, “html”, or “screenshot”. If not specified, “markdown” is used.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`cleaned`}),` determines whether the output should be cleaned. If not specified, it defaults to true.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`dateRange`}),` parameter can be used to filter results by date. Valid values are “anyTime”, “pastHour”, “pastDay”, “pastWeek”, “pastMonth”, or “pastYear”.`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`country`}),` parameter should be a two-letter country code (e.g., “US” for United States).`]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`location`}),` parameter can be used to focus the search on a specific area. You can find a list of supported locations at GET: `,_jsx(_components.code,{children:`/api/v1/google-locations`})]}),`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`language`}),` parameter can be used to specify the desired language for the search results.`]}),`\n`,_jsx(_components.li,{children:`Usage is recorded with detailed parameters for each request.`}),`\n`,_jsx(_components.li,{children:`Events may be logged for analytics purposes if enabled.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limiting`,children:`Rate Limiting`}),`\n`,_jsxs(_components.p,{children:[`Rate limit headers (`,_jsx(_components.code,{children:`X-RateLimit-Limit`}),` and `,_jsx(_components.code,{children:`X-RateLimit-Remaining`}),`) are included in the response to indicate the user’s current rate limit status.`]})]})}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":{"config":{},"pageMetadata":{"title":"Search","openapi":"POST /api/v1/search","description":"Perform a federated web search returning organic results, snippets, and metadata.","href":"/api-reference/endpoint/search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Description","slug":"description","depth":2,"children":[]},{"title":"Endpoint","slug":"endpoint","depth":2,"children":[]},{"title":"Headers","slug":"headers","depth":2,"children":[]},{"title":"Request Body","slug":"request-body","depth":2,"children":[]},{"title":"Responses","slug":"responses","depth":2,"children":[{"title":"Success (200)","slug":"success-200","depth":3,"children":[]},{"title":"Bad Request (400)","slug":"bad-request-400","depth":3,"children":[]},{"title":"Unauthorized (401)","slug":"unauthorized-401","depth":3,"children":[]},{"title":"Internal Server Error (500)","slug":"internal-server-error-500","depth":3,"children":[]}]},{"title":"Example Request","slug":"example-request","depth":2,"children":[]},{"title":"Notes","slug":"notes","depth":2,"children":[]},{"title":"Rate Limiting","slug":"rate-limiting","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dumplingai/88b5ebac9e923e56/featurebase-messenger.js"],"openApiReferenceData":{"operation":{"tags":["Search"],"summary":"Search web content","operationId":"searchWeb","description":"Perform a federated web search returning organic results, snippets, and metadata.","requestBody":"32b892f2-51e1-4204-a2a0-272332a9a9fb","responses":{"200":"57fd6409-6f0b-4429-95a1-a964c94f4777","400":"3ff2bd13-6ee9-443d-997f-5c1ea31f7301","401":"6a419223-cdad-4bd0-bbe8-93444f917279","500":"7b23afba-84ef-4c48-b369-27a2b84bd328"},"method":"post","type":"path","servers":["d723038e-161a-49c3-97eb-5fe7a380caa9"],"security":["5e873bfd-9277-42d8-b67f-596c2b666f90"],"path":"/api/v1/search","baseUrlOptions":["https://app.dumplingai.com"],"title":"Search web content","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"country":{"type":"string","description":"2-letter country code forwarded as `gl`.","uniqueKey":"country","typeLabel":"string"},"location":{"type":"string","description":"Free-form location context forwarded to the provider.","uniqueKey":"location","typeLabel":"string"},"language":{"type":"string","description":"Interface language forwarded as `hl`.","uniqueKey":"language","typeLabel":"string"},"dateRange":{"type":"string","description":"Temporal filter applied to the search results.","enum":["pastHour","pastDay","pastWeek","pastMonth","pastYear","anyTime"],"uniqueKey":"dateRange","typeLabel":"enum\u003cstring>"},"page":{"type":"integer","minimum":1,"uniqueKey":"page","typeLabel":"integer"},"scrapeResults":{"type":"boolean","default":false,"description":"When true, the service will scrape top organic results for rich content.","uniqueKey":"scrapeResults","typeLabel":"boolean"},"numResultsToScrape":{"type":"integer","minimum":1,"maximum":10,"default":3,"uniqueKey":"numResultsToScrape","typeLabel":"integer"},"scrapeOptions":{"type":"object","properties":{"format":{"type":"string","enum":["markdown","html","screenshot"],"uniqueKey":"scrapeOptions.format","typeLabel":"enum\u003cstring>"},"cleaned":{"type":"boolean","uniqueKey":"scrapeOptions.cleaned","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"scrapeOptions","typeLabel":"object"},"requestSource":{"type":"string","description":"Optional identifier describing where the API request originated.","enum":["API","WEB","MAKE_DOT_COM","ZAPIER","N8N","PLAYGROUND","DEFAULT_AUTOMATION","AGENT_PREVIEW","AGENT_LIVE","AUTOPILOT","STUDIO"],"uniqueKey":"requestSource","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"query":"best running shoes","scrapeResults":true}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"57fd6409-6f0b-4429-95a1-a964c94f4777":{"description":"Search results returned.","content":{"application/json":{"schema":{"type":"object","properties":{"searchParameters":{"type":"object","properties":{"q":{"type":"string","isRequired":true,"uniqueKey":"searchParameters.q","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"searchParameters.type","typeLabel":"string"},"engine":{"type":"string","isRequired":true,"uniqueKey":"searchParameters.engine","typeLabel":"string"},"gl":{"oneOf":[{"type":"string","uniqueKey":"searchParameters.gl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"searchParameters.gl.oneOf.1","typeLabel":"null"}],"uniqueKey":"searchParameters.gl","typeLabel":"string | null"},"hl":{"oneOf":[{"type":"string","uniqueKey":"searchParameters.hl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"searchParameters.hl.oneOf.1","typeLabel":"null"}],"uniqueKey":"searchParameters.hl","typeLabel":"string | null"}},"required":["q","type","engine"],"additionalProperties":true,"isRequired":true,"uniqueKey":"searchParameters","typeLabel":"object"},"organic":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"organic.items.[INDEX].title","typeLabel":"string"},"link":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"organic.items.[INDEX].link","typeLabel":"string\u003curi>"},"snippet":{"type":"string","isRequired":true,"uniqueKey":"organic.items.[INDEX].snippet","typeLabel":"string"},"position":{"type":"integer","isRequired":true,"uniqueKey":"organic.items.[INDEX].position","typeLabel":"integer"},"sitelinks":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"organic.items.[INDEX].sitelinks.items.[INDEX].title","typeLabel":"string"},"link":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"organic.items.[INDEX].sitelinks.items.[INDEX].link","typeLabel":"string\u003curi>"}},"required":["title","link"],"additionalProperties":false,"uniqueKey":"organic.items.[INDEX].sitelinks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"organic.items.[INDEX].sitelinks","typeLabel":"object[]"},"date":{"oneOf":[{"type":"string","uniqueKey":"organic.items.[INDEX].date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"organic.items.[INDEX].date.oneOf.1","typeLabel":"null"}],"uniqueKey":"organic.items.[INDEX].date","typeLabel":"string | null"},"scrapeOutput":{"type":"object","properties":{"title":{"type":"string","uniqueKey":"organic.items.[INDEX].scrapeOutput.title","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"organic.items.[INDEX].scrapeOutput.metadata","typeLabel":"object"},"url":{"type":"string","format":"uri","uniqueKey":"organic.items.[INDEX].scrapeOutput.url","typeLabel":"string\u003curi>"},"format":{"type":"string","uniqueKey":"organic.items.[INDEX].scrapeOutput.format","typeLabel":"string"},"cleaned":{"type":"boolean","uniqueKey":"organic.items.[INDEX].scrapeOutput.cleaned","typeLabel":"boolean"},"content":{"type":"string","uniqueKey":"organic.items.[INDEX].scrapeOutput.content","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"organic.items.[INDEX].scrapeOutput","typeLabel":"object"}},"required":["title","link","snippet","position"],"additionalProperties":true,"uniqueKey":"organic.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"organic","typeLabel":"object[]"},"featuredSnippet":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"featuredSnippet.title","typeLabel":"string"},"link":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"featuredSnippet.link","typeLabel":"string\u003curi>"},"snippet":{"type":"string","isRequired":true,"uniqueKey":"featuredSnippet.snippet","typeLabel":"string"},"position":{"type":"integer","isRequired":true,"uniqueKey":"featuredSnippet.position","typeLabel":"integer"},"type":{"type":"string","isRequired":true,"uniqueKey":"featuredSnippet.type","typeLabel":"string"}},"required":["title","link","snippet","position","type"],"additionalProperties":true,"uniqueKey":"featuredSnippet","typeLabel":"object"},"relatedSearches":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string","isRequired":true,"uniqueKey":"relatedSearches.items.[INDEX].query","typeLabel":"string"}},"required":["query"],"additionalProperties":false,"uniqueKey":"relatedSearches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"relatedSearches","typeLabel":"object[]"},"peopleAlsoAsk":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","isRequired":true,"uniqueKey":"peopleAlsoAsk.items.[INDEX].question","typeLabel":"string"},"snippet":{"type":"string","isRequired":true,"uniqueKey":"peopleAlsoAsk.items.[INDEX].snippet","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"peopleAlsoAsk.items.[INDEX].title","typeLabel":"string"},"link":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"peopleAlsoAsk.items.[INDEX].link","typeLabel":"string\u003curi>"}},"required":["question","snippet","title","link"],"additionalProperties":true,"uniqueKey":"peopleAlsoAsk.items.[INDEX]","typeLabel":"object"},"uniqueKey":"peopleAlsoAsk","typeLabel":"object[]"}},"required":["searchParameters","organic"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"searchParameters":{"q":"\u003cstring>","type":"\u003cstring>","engine":"\u003cstring>","gl":"\u003cstring>","hl":"\u003cstring>"},"organic":[{"title":"\u003cstring>","link":"\u003cstring>","snippet":"\u003cstring>","position":123,"sitelinks":[{"title":"\u003cstring>","link":"\u003cstring>"}],"date":"\u003cstring>","scrapeOutput":{"title":"\u003cstring>","metadata":{},"url":"\u003cstring>","format":"\u003cstring>","cleaned":true,"content":"\u003cstring>"}}],"featuredSnippet":{"title":"\u003cstring>","link":"\u003cstring>","snippet":"\u003cstring>","position":123,"type":"\u003cstring>"},"relatedSearches":[{"query":"\u003cstring>"}],"peopleAlsoAsk":[{"question":"\u003cstring>","snippet":"\u003cstring>","title":"\u003cstring>","link":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3ff2bd13-6ee9-443d-997f-5c1ea31f7301":{"description":"Invalid request payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6a419223-cdad-4bd0-bbe8-93444f917279":{"description":"Missing or invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7b23afba-84ef-4c48-b369-27a2b84bd328":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5e873bfd-9277-42d8-b67f-596c2b666f90":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[]}}},"servers":{"d723038e-161a-49c3-97eb-5fe7a380caa9":{"url":"https://app.dumplingai.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-v1.yaml"},"subdomain":"dumplingai","siteName":"DumplingAI Docs","title":"Search - DumplingAI Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/catalog/search","matchLevel":1},"v1":{"href":"/api-reference/endpoint/search","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-11-21T00:07:12.509Z","originalFileLocation":"api-reference/endpoint/search.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Perform a federated web search returning organic results, snippets, and metadata.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DumplingAI Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search - DumplingAI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Perform a federated web search returning organic results, snippets, and metadata.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DumplingAI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dumplingai.com/api-reference/endpoint/search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dumplingai.mintlify.site/_mintlify/api/og/v2?division=Data+APIs\u0026amp;title=Search\u0026amp;description=Perform+a+federated+web+search+returning+organic+results%2C+snippets%2C+and+metadata.\u0026amp;theme=f6d65ea4c1e9445145f9cff7\u0026amp;signature=ec907eee969e3944c0c9961ba39dd37945a81b2ee7ba767afe514ba06fed10e7\">\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=\"Search - DumplingAI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Perform a federated web search returning organic results, snippets, and metadata.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dumplingai.mintlify.site/_mintlify/api/og/v2?division=Data+APIs\u0026amp;title=Search\u0026amp;description=Perform+a+federated+web+search+returning+organic+results%2C+snippets%2C+and+metadata.\u0026amp;theme=f6d65ea4c1e9445145f9cff7\u0026amp;signature=ec907eee969e3944c0c9961ba39dd37945a81b2ee7ba767afe514ba06fed10e7\">\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/dumplingai/i_giEhVPqadP-y2_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DumplingAI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dumplingai.com/api-reference/endpoint/search\">\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/search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dumplingai.com/#organization\",\"name\":\"DumplingAI Docs\",\"url\":\"https://docs.dumplingai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dumplingai/ovQfojsBnkaBEyWP/dumplingai-logo.svg?fit=max\u0026auto=format\u0026n=ovQfojsBnkaBEyWP\u0026q=85\u0026s=46740c45e1bef65a42e4a799407a5d32\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dumplingai.com#website\",\"name\":\"DumplingAI Docs\",\"url\":\"https://docs.dumplingai.com\",\"publisher\":{\"@id\":\"https://docs.dumplingai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dumplingai.com/api-reference/endpoint/search#webpage\",\"url\":\"https://docs.dumplingai.com/api-reference/endpoint/search\",\"name\":\"Search\",\"description\":\"Perform a federated web search returning organic results, snippets, and metadata.\",\"dateModified\":\"2025-11-21T00:07:12.509Z\",\"isPartOf\":{\"@id\":\"https://docs.dumplingai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dumplingai.com/api-reference/endpoint/search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dumplingai.com/api-reference/endpoint/search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data APIs\",\"item\":\"https://docs.dumplingai.com/api-reference/endpoint/get-youtube-transcript\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search\",\"item\":\"https://docs.dumplingai.com/api-reference/endpoint/search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dumplingai.com/api-reference/endpoint/search#apireference\",\"headline\":\"Search\",\"name\":\"Search\",\"description\":\"Perform a federated web search returning organic results, snippets, and metadata.\",\"url\":\"https://docs.dumplingai.com/api-reference/endpoint/search\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dumplingai.com/api-reference/endpoint/search#webpage\"},\"dateModified\":\"2025-11-21T00:07:12.509Z\",\"publisher\":{\"@id\":\"https://docs.dumplingai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dumplingai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DumplingAI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"DumplingAI Docs","nav":{"global":null,"versions":[{"version":"v2","pages":[{"title":"v2","href":"/api-reference/catalog/search"}]},{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/v1/get-started"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/v1/introduction"},{"title":"Credit Costs","href":"/api-reference/credit-costs"}]},{"group":"Data APIs","pages":[{"title":"Get YouTube Transcript","openapi":"POST /api/v1/get-youtube-transcript","href":"/api-reference/endpoint/get-youtube-transcript"},{"title":"Get YouTube Video","openapi":"POST /api/v1/youtube/video","href":"/api-reference/endpoint/get-youtube-video"},{"title":"Get YouTube Video Comments","openapi":"POST /api/v1/youtube/video/comments","href":"/api-reference/endpoint/get-youtube-video-comments"},{"title":"Get YouTube Channel","openapi":"POST /api/v1/youtube/channel","href":"/api-reference/endpoint/get-youtube-channel"},{"title":"Get YouTube Channel Videos","openapi":"POST /api/v1/youtube/channel-videos","href":"/api-reference/endpoint/get-youtube-channel-videos"},{"title":"Get YouTube Channel Shorts","openapi":"POST /api/v1/youtube/channel/shorts","href":"/api-reference/endpoint/get-youtube-channel-shorts"},{"title":"YouTube Search","openapi":"POST /api/v1/youtube/search","href":"/api-reference/endpoint/search-youtube"},{"title":"Get TikTok Transcript","openapi":"POST /api/v1/get-tiktok-transcript","href":"/api-reference/endpoint/get-tiktok-transcript"},{"title":"Get TikTok Video","openapi":"POST /api/v1/get-tiktok-video","href":"/api-reference/endpoint/get-tiktok-video"},{"title":"Get TikTok Video Comments","openapi":"POST /api/v1/get-tiktok-video-comments","href":"/api-reference/endpoint/get-tiktok-video-comments"},{"title":"Get TikTok Profile","openapi":"POST /api/v1/get-tiktok-profile","href":"/api-reference/endpoint/get-tiktok-profile"},{"title":"Get TikTok Profile Videos","openapi":"POST /api/v1/get-tiktok-profile-videos","href":"/api-reference/endpoint/get-tiktok-profile-videos"},{"title":"Get TikTok User Followers","openapi":"POST /api/v1/get-tiktok-user-followers","href":"/api-reference/endpoint/get-tiktok-user-followers"},{"title":"Get TikTok User Following","openapi":"POST /api/v1/get-tiktok-user-following","href":"/api-reference/endpoint/get-tiktok-user-following"},{"title":"Search TikTok Users","openapi":"POST /api/v1/search-tiktok-users","href":"/api-reference/endpoint/search-tiktok-users"},{"title":"Get LinkedIn Profile","openapi":"POST /api/v1/linkedin/profile","href":"/api-reference/endpoint/get-linkedin-profile"},{"title":"Get LinkedIn Company","openapi":"POST /api/v1/linkedin/company","description":"Retrieve company profile metadata, size, and industry information from LinkedIn.","href":"/api-reference/endpoint/get-linkedin-company"},{"title":"Search","openapi":"POST /api/v1/search","href":"/api-reference/endpoint/search"},{"title":"Search News","openapi":"POST /api/v1/search-news","description":"Search global news sources and return structured article metadata.","href":"/api-reference/endpoint/search-news"},{"title":"Search Maps","openapi":"POST /api/v1/search-maps","href":"/api-reference/endpoint/search-maps"},{"title":"Search Places","openapi":"POST /api/v1/search-places","href":"/api-reference/endpoint/search-places"},{"title":"Get Autocomplete","openapi":"POST /api/v1/get-autocomplete","href":"/api-reference/endpoint/get-autocomplete"},{"title":"Get Google Reviews","openapi":"POST /api/v1/get-google-reviews","href":"/api-reference/endpoint/get-google-reviews"}]},{"group":"Web Scraping","pages":[{"title":"Scrape","openapi":"POST /api/v1/scrape","href":"/api-reference/endpoint/scrape"},{"title":"Crawl Website","openapi":"POST /api/v1/crawl","href":"/api-reference/endpoint/crawl"},{"title":"Screenshot","openapi":"POST /api/v1/screenshot","href":"/api-reference/endpoint/screenshot"},{"title":"Extract","openapi":"POST /api/v1/extract","href":"/api-reference/endpoint/extract"}]},{"group":"Document Processing","pages":[{"title":"Doc to Text","openapi":"POST /api/v1/doc-to-text","href":"/api-reference/endpoint/doc-to-text"},{"title":"Convert to PDF","openapi":"POST /api/v1/convert-to-pdf","href":"/api-reference/endpoint/convert-to-pdf"},{"title":"Merge PDFs","openapi":"POST /api/v1/merge-pdfs","href":"/api-reference/endpoint/merge-pdfs"},{"title":"Read PDF Metadata","openapi":"POST /api/v1/read-pdf-metadata","href":"/api-reference/endpoint/read-pdf-metadata"},{"title":"Write PDF Metadata","openapi":"POST /api/v1/write-pdf-metadata","href":"/api-reference/endpoint/write-pdf-metadata"},{"title":"Extract Document","openapi":"POST /api/v1/extract-document","href":"/api-reference/endpoint/extract-document"},{"title":"Extract Image","openapi":"POST /api/v1/extract-image","href":"/api-reference/endpoint/extract-image"},{"title":"Extract Audio","openapi":"POST /api/v1/extract-audio","href":"/api-reference/endpoint/extract-audio"},{"title":"Extract Video","openapi":"POST /api/v1/extract-video","href":"/api-reference/endpoint/extract-video"},{"title":"Trim Video","openapi":"POST /api/v1/trim-video","href":"/api-reference/endpoint/trim-video"}]},{"group":"AI","pages":[{"title":"Generate Agent Completion","openapi":"POST /api/v1/agents/generate-completion","href":"/api-reference/endpoint/generate-agent-completion"},{"title":"Generate AI Image","openapi":"POST /api/v1/generate-ai-image","href":"/api-reference/endpoint/generate-ai-image"}]},{"group":"Developer Tools","pages":[{"title":"Run JavaScript Code","openapi":"POST /api/v1/run-js-code","href":"/api-reference/endpoint/run-js-code"},{"title":"Run Python Code","openapi":"POST /api/v1/run-python-code","href":"/api-reference/endpoint/run-python-code"}]}]}]}]},"basePath":"","title":"Search - DumplingAI Docs","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}