Run a waterfall task

POST

waterfalls

{waterfall_identifier}

run

curl --request POST \
  --url https://api.databar.ai/v1/waterfalls/{waterfall_identifier}/run \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <x-apikey>' \
  --data '
{
  "params": {
    "first_name": "John",
    "last_name": "Doe",
    "company": "example.com"
  },
  "enrichments": [
    833,
    966
  ],
  "email_verifier": 10
}
'

{
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "created"
}

{
  "error": "INVALID_PARAMS",
  "detail": "Row 1: param1: This field is required.",
  "rows": [
    {
      "position": 1,
      "fields": {
        "param1": [
          "This field is required."
        ]
      }
    }
  ]
}

{
  "detail": "Forbidden"
}

{
  "detail": "Check the number of remaining credits or the tariff plan."
}

{
  "error": "<string>",
  "detail": "<string>",
  "fields": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>"
    }
  ]
}

This endpoint is asynchronous. It returns a task_id — poll Get task status to retrieve your results. Task data expires after 24 hours.

Headers

x-apikey

any

required

API Key for authentication

Path Parameters

waterfall_identifier

string

required

The identifier of the waterfall to run

Body

application/json

params

Params · object

required

enrichments

integer[]

Provider IDs to run, in order. Omit or pass [] to run the waterfall's default cascade (providers with enabled_by_default=true).

email_verifier

integer | null

Response

Successful Response

task_id

string

required

status

string

required

Getting Started

Overview

SDKs

Workspace

Workbooks

Tables

Headless

User

Headers

Path Parameters

Body

Response