Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: CrawlerData Open WebUI API
version: 1.0.0
description: Google Shopping (products, sellers, product details) and Google Search, Images, News, Local and Autocomplete results as JSON. Submit a job to POST /v1/jobs. The live queue returns the result in the same response; fast and regular are asynchronous (poll GET /v1/jobs/{jobId} or receive a webhook). Failed jobs cost 0 credits. Also available as an MCP server at POST /mcp.
contact:
name: CrawlerData
email: contact@crawlerdata.com
url: https://crawlerdata.com
termsOfService: https://crawlerdata.com/legal/terms
x-logo:
url: https://crawlerdata.com/favicon.svg
servers:
- url: https://api.crawlerdata.com
security:
- bearerAuth: []
tags:
- name: Open WebUI
description: Open WebUI "External" web search provider
paths:
/v1/openwebui/search:
post:
tags:
- Open WebUI
operationId: openWebUiSearch
summary: Open WebUI external web search provider
description: 'In Open WebUI: Admin Settings > Web Search, engine "external", URL https://api.crawlerdata.com/v1/openwebui/search, API key = your CrawlerData key. Returns up to count (max 10) Google web results. 1 credit per search; failed searches are free.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- query
properties:
query:
type: string
maxLength: 500
count:
type: integer
minimum: 1
default: 5
description: Maximum results (values above 10 return 10)
example:
query: open source llm benchmarks
count: 5
responses:
'200':
description: Results
content:
application/json:
schema:
type: array
items:
type: object
properties:
link:
type: string
title:
type: string
snippet:
type: string
'400':
$ref: '#/components/responses/SerpApiError'
'401':
$ref: '#/components/responses/SerpApiError'
'402':
$ref: '#/components/responses/SerpApiError'
'429':
$ref: '#/components/responses/SerpApiError'
'502':
$ref: '#/components/responses/SerpApiError'
components:
responses:
SerpApiError:
description: Error, SerpApi style
content:
application/json:
schema:
type: object
properties:
error:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key from the dashboard (sk_...)
apiKeyQuery:
type: apiKey
in: query
name: api_key
description: The same API key as a query parameter (SerpApi style, /search.json only)
cseKeyQuery:
type: apiKey
in: query
name: key
description: The same API key as a query parameter (Custom Search style, /customsearch/v1 only)
externalDocs:
description: Docs
url: https://app.crawlerdata.com/docs