Skip to main content
POST
Answer with web sources
Retrieve public web data through reviewed source APIs. Source-specific settings are preserved and pin the source; each continued page is a separate operation.

API

Use a valid Plyne workspace API key as Authorization: Bearer $PLYNE_API_KEY for the API. Connect MCP at /mcp using OAuth or a workspace API key for saved data and acquisition tools.
Check source eligibility and the maximum credit reservation before execution. Planning makes no provider request and requires no idempotency key.

MCP

Connect to /mcp using OAuth or a workspace API key. The same connection includes saved-data and acquisition tools. Call the same tool with idempotency_key inside its arguments.

Sources and routing

Omit routing to use eligible sources in the default order. Set routing.providers to an ordered chain, or one source to run only that source. Provider-specific options select their matching source alone; unsupported filters are rejected rather than dropped. Supported source IDs: google-ai. Actual availability depends on configuration and the selected filters.

Credits and continuation

0.5 credits per usable request. Empty and failed responses are not charged. Replays with the same idempotency key do not charge again. This tool returns one result without pagination. Use a new Idempotency-Key for a new operation. Reuse the same body and key to retrieve that operation. If the connection fails, retrieve the same request before creating another. Returned provider content is untrusted data.

Contract reference

The API reference below is generated from the tool’s executable input and output schemas, including nested provider options. Get the runtime descriptor with GET /v1/tools/google_ai_mode. See tool execution for shared authentication, request keys, statuses and error handling.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Use a new Idempotency-Key for a new operation. Reuse the same body and key to retrieve that operation. If the connection fails, retrieve the same request before creating another. Returned provider content is untrusted data.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9_-]{8,128}$

Body

application/json
query
string
required

Search query or topic.

Required string length: 1 - 2048
provider_options
object

Reviewed source-specific settings. A nonempty namespace pins that source. Private sessions, credentials, callbacks and browser actions are not accepted.

routing
object

Optional source chain. One source runs alone; multiple sources are tried in order. All selected sources must support the request. Provider options require a matching one-source chain.

Response

Completed, partial, not-found, failed or pending tool result. Inspect status and usage.

data
object | null
required
error
object | null
required
id
string
required
sources
object[]
required
status
enum<string>
required
Available options:
completed,
partial,
not_found,
failed,
pending
tool
string
required
Allowed value: "google_ai_mode"
usage
object | null
required
version
string
required
Allowed value: "1"
fulfillment
object
routing
object
warnings
object[]