API referenceWaterfalls
Create a waterfall
Create a draft waterfall (one capability, ordered vendor steps, speed profile, stop rules, per-field merge) or a multi-stage pipeline. Start from a definition, a template or a routing preset.
Authorization
bearer AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/waterfalls" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "title": "string" }'{ "object": "waterfall", "id": "string", "name": "string", "title": "string", "description": "string", "status": "draft", "draft": { "kind": "waterfall", "id": "main", "capability": "string", "steps": [ { "type": "endpoint", "endpoint_id": "string", "id": "string", "timeout_ms": 100, "retries": 0, "retry_backoff_ms": 250, "max_cost_micro": 0, "required_fields": [], "min_confidence": 0, "confidence_field": "confidence", "prefer_verified": false, "continue_on_hit": false, "credential": "auto", "on_client_error": "continue", "when": { "field": "string", "op": "eq", "value": "string" } } ], "speed": { "profile": "balanced" }, "stop": [ { "rule": "first_hit" } ], "stop_mode": "any", "merge": {}, "input_map": {}, "when": { "field": "string", "op": "eq", "value": "string" }, "fields": [ "string" ], "max_cost_micro": 0, "deadline_ms": 500 }, "published_version": "string", "latest_version": "string", "versions": [ { "version": "string", "created_at": "2019-08-24T14:15:22Z" } ], "template": "string", "endpoint": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}