Quick search
quick_searchRun a synchronous web search and return structured results in the response, with optional date-range filters to narrow findings.
Instructions
quick search
Run a web search and get structured results back synchronously — the response is the run with the results already in output (no polling, no webhook). Optionally filter to a date range with date_start / date_end (format YYYY-MM-DD); if only date_start is given, date_end defaults to today.
The result is also stored on the run, so it stays re-fetchable at GET /runs/{id}/result.
For bulk searches — up to 100,000 per request, async with webhook_url support — use the legacy POST /v1/web_search endpoint.
Quick example
curl -X POST https://api.riveterhq.com/v1/quick_search \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "latest OpenAI news"}'Credit costs
0.04 credits per search.
Example — A simple search: { "query": "latest OpenAI news" }
Example — A search filtered to a date range: { "query": "OpenAI GPT-4o mini", "date_start": "2024-07-01", "date_end": "2024-07-31" }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The search query (simpler is better) | |
| run_key | No | Optional idempotency key (becomes the run id "run_<run_key>") | |
| date_end | No | Optional end date filter, format YYYY-MM-DD. Defaults to today if date_start is set | |
| date_start | No | Optional start date filter, format YYYY-MM-DD | |
| max_credits | No | Credit ceiling. Refused with 422 credit_cap_exceeded (nothing charged) when the estimate's maximum exceeds it. | |
| estimate_cost | No | Validate and price the request without running or charging anything; the 200 response is the credit estimate (EstimateCostResult). |