Datasets

generate more rows

Changed on

Ask the list generator for count more rows of an existing dataset. Requires a index_column on the dataset (set one with PATCH /datasets/{id}); the generator is told the existing rows and skips them, and anything it still repeats is dropped on the index column. prompt says what to find; when omitted, the prompt of the dataset's latest build is reused. The generator may find fewer rows than count: when the run finishes, its progress reports requested_rows, generated_rows, added_rows, skipped_duplicate_rows. auto_fill: true fills the new rows' output columns when they land (a second paid run). The response is the dataset plus run (the generation run); poll it with GET /runs/{id} or pass webhook_url.

post/datasets/{id}/rows/build

Request

  • Base URL
    https://api.riveterhq.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

The dataset id (ds_...)

Request body

promptstring

What the rows are. Default: the prompt of the dataset's latest build.

countinteger required

How many rows to generate. Capped per account.

budgetnumber

Most credits the build may spend (default 50 + 1.5 per row). A deposit of the expected spend is charged at kickoff; the rest is charged as it runs, up to this budget. A low budget means fewer rows.

auto_fillboolean

Fill the new rows' output columns when they land (needs an enrichment on the dataset)

webhook_urlstring uri

POSTed the generation run when it finishes

fill_webhook_urlstring uri

With auto_fill — POSTed the fill run when it finishes

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

estimate_cost only — the credit estimate; nothing was started

estimate_costtrue required
type'enrichment' | 'dataset_build' | 'extraction_discovery' | 'extraction' | 'monitor' | 'scrape' | 'quick_search' | 'search_agent' required

What would have been charged for (monitor = one scheduled run of the monitor)

Example response

{
  "estimate_cost": true,
  "type": "enrichment",
  "credit_detail": {
    "estimate": {
      "minimum": 0,
      "maximum": 1920,
      "charged_upfront": false
    },
    "credits_used": 0,
    "credits_remaining": 5000,
    "sufficient_credits": true
  }
}

Changes

    • warning

      removed the optional property // from 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

    • 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