API referenceWaterfalls
List waterfall runs
Recent runs of one waterfall: outcome, cost, time, attempts and fields filled.
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
Match
^wf_[a-z0-9]{8,40}$Query Parameters
limit?integer
Range
1 <= value <= 100Default
20before?string
Return runs created before this time
Format
date-timeResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/waterfalls/string/runs"{ "items": [ { "object": "waterfall_run", "id": "string", "waterfall_id": "string", "version": "string", "mode": "sync", "status": "queued", "outcome": "hit", "stop_reason": "first_hit", "fields_filled": [ "string" ], "cost_micro": 0, "latency_ms": 0, "batch_id": "string", "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "attempts": 0 } ], "next_cursor": "string"}Run a waterfall POST
Run a waterfall on one input. Sync by default; Prefer: wait=N (or wait) falls back to 202, Prefer: respond-async (or async: true) returns 202 with a run to poll, stream (/events) or receive by webhook. version draft runs the test runner.
Get a waterfall run GET
One run: status, golden record with _provenance per field, every attempt with its timing and error, cost per filled field.