Web and news · Serper

web.search

Runs a Google web search and returns organic results with title, url and snippet, plus any answer box or knowledge graph. Follow up with read on a record to fetch the page as markdown.

Operation: POST /v1/capabilities/web.search/execute
operationId: executeWebSearch
Typical credits: 1
Search deadline: 15 s server-side
Paging: page
Availability: ConfiguredChecked 2026-09-23 21:02 UTC

Cost basis: $0.001 per Serper credit; 1 credit per page of results. Availability is reported per deployment by GET /v1/catalog (available). The timestamped snapshot describes configuration, not provider uptime or your account's enabled choices. Check the catalog with your own key before a call. Credits are explained under credits and limits.

Request

Body of POST /v1/capabilities/web.search/execute, JSON, validated against the WebSearchRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.

Request fields of web.search
Field	Type	Required	Default	Constraints and description
query	string	yes		min length 1, max length 500
num	integer	no	10	min 1, max 20 Results per page (1-20).
country	string	no		min length 2, max length 2 ISO 3166-1 alpha-2, e.g. "gb".
language	string	no		min length 2, max length 5 Interface language, e.g. "en".
time_range	"day" \| "week" \| "month" \| "year"	no

Unknown keys are rejected with 400 invalid_request.

Rules the schema cannot express

Checked after schema validation; violations return 400 invalid_request with a plain message.

read requires the record to carry a url; answer boxes without one are refused.

Examples

Recent news

curl

curl -s -X POST https://api.powerups-ai.store/v1/capabilities/web.search/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"query":"fastify 5 release notes","time_range":"month","num":5}'

Localised

curl

curl -s -X POST https://api.powerups-ai.store/v1/capabilities/web.search/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"query":"best ramen","country":"jp","language":"ja"}'

No recorded response is published for this capability yet. The envelope is the ExecuteResponse component (see sessions and records); the record keys below are what the adapter emits. A first call with the example above returns search_id, the records and the charge.

Result record

Every item in results[] carries record_id and title (contract, always present) and usually url and snippet. The keys below are the documented tier: produced deterministically by this capability, omitted when the source has no value, checked against recorded source fixtures in our test suite, and published as the WebSearchRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. See stability tiers.

Record keys of web.search
Key	Type	Presence	Note
kind	"organic" \| "answer_box" \| "knowledge_graph"	always
position	integer	when the source has it	Organic rank on the provider page.
date	string	when the source has it
type	string	when the source has it	Knowledge graph.
attributes	object	when the source has it	Knowledge graph, provider-shaped.

Caveats

Answer-box and knowledge-graph records carry provider-shaped extra keys.

Follow-ups

Paging: Provider page number; more fetches the next page from the source. Send { "search_id": "…", "action": "more" } while has_more is true; tolerate an empty page and stop after a bounded number of pages.
Update: Re-run with changed parameters (merged into the stored query); page state resets, search_id stays. Params accept any subset of the request fields (WebSearchUpdateParams).
Record actions:
- read: Fetch the result page as markdown.
Detail behaviour: First details call fetches from the provider (billed as stated); repeats are cached and free. read fetches the page through the same scraper as web.read: $0.005 per page.

record action

curl -s -X POST https://api.powerups-ai.store/v1/follow-up \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"record_id":"rec_…","action":"read"}'

Record detail objects of this capability are provider-shaped: documented by observation, not by schema. Full follow-up semantics: follow-up.

Typed client

With types generated from the public document (see types, client and samples) the call is path-keyed and the body is checked at compile time:

TypeScript (openapi-fetch)

const { data, error } = await client.POST("/v1/capabilities/web.search/execute", {
  body: {
    "query": "fastify 5 release notes",
    "time_range": "month",
    "num": 5
  },
});
if (error) throw new Error(`${error.error.code}: ${error.error.message}`);
for (const record of data.results) console.log(record.record_id, record.title);