API referenceWaterfalls

Batch-run a waterfall

Run a waterfall over up to 1,000 inputs (JSON rows or CSV) in the background through gr-rows, paced per vendor. Returns the batch (a list) to poll.

Authorization

bearer

AuthorizationBearer <token>

In: header

application/json

TypeScript Definitions

Use the request body type in TypeScript.

waterfall_id*string

Match^wf_[a-z0-9]{8,40}$

version?|

Default"published"

inputs?array<>

Items1 <= items <= 1000

max_cost_micro_per_run?integer

Range0 <= value

webhook_url?string

Formaturi

fields?array<>

Itemsitems <= 50

csv?string

CSV with a header row, instead of inputs

Lengthlength <= 1000000

curl -X POST "https://example.com/v1/waterfalls/batch-run" \  -H "Content-Type: application/json" \  -d '{    "waterfall_id": "string"  }'

{  "object": "waterfall_batch",  "id": "string",  "waterfall_id": "string",  "total": 0,  "runs": [    "string"  ],  "status_url": "string"}

List webhook event types GET

Every event a webhook endpoint can subscribe to, with when it is sent and the current api_version.

Cancel a waterfall run POST

Stop a queued or running run. In-flight attempts are aborted and released; the partial result is kept.