searchpipe_search
Run an AI-powered web search for a query: multi-engine retrieval → page fetching → LLM reranking → optional AI answer.
Uses the same commercial pipeline and accepts the same parameters as the HTTP POST /search endpoint: authentication → rate limiting → input moderation → credit charge → search → output moderation + AI-generated marker → refund on failure → usage logging. Credits are charged per call.
search_depth: "basic" (default, 1 credit) / "advanced" (2 credits) / "fast" (0.5 credit — skips all
LLM steps: results keep engine order with engine-provided relevance scores, no answer is generated).
include_domains / exclude_domains: restrict or exclude domains ("example.com" matches the domain and
any subdomain; "*.example.com" matches subdomains only; "example.com/docs" also requires the URL path
to start with /docs; exclude wins over include).
time_range: recency window "day" / "week" / "month" / "year"; start_date / end_date: ISO YYYY-MM-DD
bounds (results without a known publish date are not filtered).
topic: "general" (default) or "news" (always adds a dedicated news channel to retrieval).
country: ISO 3166-1 alpha-2 region bias (e.g. "US"); language: upstream market language (e.g. "en",
"zh-CN"); combined into the upstream market locale.
safe_search: 0 off (default) / 1 moderate / 2 strict.
include_images: also run an image search and return an images array alongside results.
output_type: "search_results" (default) / "answer" (same as include_answer=true) / "structured"
(grounded JSON object per output_schema — requires output_schema; on failure output is null).
objective: optional one-line search intent from the calling agent; improves reranking only.
stream is REST-only and not available over MCP.
api_key: an API key starting with sp-. It may also be provided through the SEARCHPIPE_API_KEY
environment variable (the parameter takes precedence).
Returns Tavily-style structured results (query / answer / results[] / images[] / output).
Returns a tool error on authentication failure, insufficient credits, content violation, invalid
parameters (422), or retrieval failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| topic | No | general | |
| api_key | No | ||
| country | No | ||
| end_date | No | ||
| language | No | ||
| objective | No | ||
| start_date | No | ||
| time_range | No | ||
| max_results | No | ||
| output_type | No | ||
| safe_search | No | ||
| search_depth | No | basic | |
| output_schema | No | ||
| include_answer | No | ||
| include_images | No | ||
| exclude_domains | No | ||
| include_domains | No | ||
| include_raw_content | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| usage | No | Billing and cache info for this request | |
| answer | No | LLM-generated answer (optional) | |
| images | No | Image results (present when the request set include_images=true) | |
| output | No | Structured JSON object conforming to output_schema (output_type='structured' only; null when conversion failed) | |
| notices | No | How this response was produced (safe to show to the model) | |
| results | Yes | ||
| warnings | No | Parameter-level issues: a requested feature did not take effect (safe to show the developer; do not feed to the model) | |
| request_id | No | Unique request identifier, also returned as the X-Request-Id response header | |
| ai_generated | No | Whether the response contains LLM-generated content | |
| answer_audit | No | Per-statement audit of the AI answer (advanced depth only) | |
| response_time | No | Server processing time for this request, in seconds |