RIriveterhq
Tools

quick search

Changed on

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.

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.
post/quick_search

Request

Request body

querystring required

The search query (simpler is better)

date_startstring

Optional start date filter, format YYYY-MM-DD

date_endstring

Optional end date filter, format YYYY-MM-DD. Defaults to today if date_start is set

run_keystring

Optional idempotency key (becomes the run id "run_<run_key>")

estimate_costboolean

Validate and price the request without running or charging anything; the 200 response is the credit estimate (EstimateCostResult).

max_creditsnumber

Credit ceiling. Refused with 422 credit_cap_exceeded (nothing charged) when the estimate's maximum exceeds it.

Response

Search completed — the run with the results in output (or, with estimate_cost, the credit estimate only)

OR

Example response

{
  "id": "run_018f6a70-1234-7abc-89ab-0123456789ab",
  "type": "enrichment",
  "status": "processing",
  "progress": {
    "percent_complete": 40,
    "estimated_seconds_remaining": 90,
    "elapsed_seconds": 60,
    "completed_cells": 4,
    "total_cells_expected": 10,
    "not_found_cells": 0
  },
  "credits_used": 2.5,
  "credit_detail": {
    "estimate": {
      "minimum": 0,
      "maximum": 10,
      "charged_upfront": false
    },
    "credits_used": 2.5
  },
  "app_url": "https://app.riveterhq.com/runs/run_018f6a70-1234-7abc-89ab-0123456789ab",
  "result_url": "https://api.riveterhq.com/v1/runs/run_018f6a70-1234-7abc-89ab-0123456789ab/result",
  "started_at": "2026-01-15T12:00:00Z",
  "finished_at": null,
  "error": null,
  "enrichment_id": "enr_018f5b60-1234-7abc-89ab-0123456789ab",
  "enrichment_name": "My Enrichment"
}

Changes

  • fac56b649559Revision changes
    • warning

      removed the optional property ///// from the response with the status

  • dcb4d45ade1aRevision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status