Skip to main content
POST
/
v1
/
enrichments
/
{enrichment_id}
/
bulk-run
curl --request POST \
  --url https://api.databar.ai/v1/enrichments/{enrichment_id}/bulk-run \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <x-apikey>' \
  --data '
{
  "params": [
    {
      "param1": "value1",
      "param2": "value2"
    }
  ]
}
'
{
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "processing"
}
{
  "detail": [
    {
      "param1": [
        "This field is required."
      ]
    }
  ]
}
{
  "detail": "Forbidden"
}
{
  "detail": "Check the number of remaining credits or the tariff plan."
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
This runs an enrichment in bulk headless — results are returned inline. To enrich rows stored in a Databar table, see Run table enrichment.
This endpoint is asynchronous. It returns a task_id — poll Get task status to retrieve your results. Task data expires after 24 hours.
Results are aligned to your inputs: the data array has one element per input, in the same order you submitted them, with null for inputs that returned no data. So len(data) equals the number of inputs and data[i] is the result for input i — join results back to inputs by position.

Headers

​
x-apikey
any
required

API Key for authentication

Path Parameters

​
enrichment_id
integer
required

The ID of the enrichment to run

Body

application/json
​
params
Params · object[]
required
​
pagination
PaginationOptions · object | null

Response

Successfully submitted the bulk enrichment run

​
task_id
string
required
​
status
string
required