Skip to main content
POST
/
v1
/
table
/
{table_uuid}
/
run-enrichment
/
{enrichment_id}
Run table enrichment or waterfall
curl --request POST \
  --url https://api.databar.ai/v1/table/{table_uuid}/run-enrichment/{enrichment_id} \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <x-apikey>' \
  --data '
{
  "run_strategy": "run_all",
  "row_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "status": "queued",
  "processing_rows": 150
}

​
enrichment_id

The enrichment_id path parameter is the table-enrichment ID — the id returned by GET /v1/table/{table_uuid}/enrichments. This is not the same as the enrichment catalog ID. You must first add the enrichment to the table via POST /v1/table/{table_uuid}/add-enrichment, then retrieve the table-enrichment ID from GET /v1/table/{table_uuid}/enrichments.

Headers

​
x-apikey
string
required

API Key for authentication

Path Parameters

​
table_uuid
string<uuid>
required

The UUID of the table

​
enrichment_id
string
required

The ID of the table enrichment to run

Body

application/json
​
run_strategy
enum<string>
default:run_all

Which rows to process: 'run_all' runs every row, 'run_empty' skips rows that already have a result, 'run_errors' reruns only rows that ended with an error.

Available options:
run_all,
run_empty,
run_errors
​
row_ids
string<uuid>[] | null

Optional list of specific row UUIDs to process. When omitted, processes all rows (subject to run_strategy).

Response

Enrichment run started successfully

​
status
string
required
​
processing_rows
integer | null