Skip to main content

Enrichments API

Enrich your own JSON data without creating a Datablist workspace, collection, or items. Send input rows, run an asynchronous task, and retrieve the results to use in your own application.

Building workflows

The Enrichments API is a standalone API for running enrichments and retrieving results. To build workflows that connect several steps, use the Datablist app.

Tasks use the same credits as the Datablist app. Paid enrichments consume your account balance.

The production REST base URL is:

text
https://api.datablist.com

A task runs in the background:

  1. Send your input rows and a uniqueId to create the task.
  2. Check its status every few seconds.
  3. When it is completed, failed, or stopped, read the results.

Results keep your input order and inputId values, so you can match them to your own records.

Start with the quickstart. Before creating a task, use the catalog to discover the IDs, JSON schemas, limits, and pricing details for each enrichment.

Enrichments and sources​

Enrichment tasksSource tasks
RequestSettings and input rows with your inputId valuesSettings only
ResultsOne final result per original input, correlated by inputIdFlat generated JSON objects
Collection requiredNoNo
GuideEnrichment quickstartSources quickstart

Both families share account limits, credit accounting, cancellation, and retention. Use the separate Sources API to generate data from settings instead of enriching rows you already have.

Endpoints​

All paths below are relative to https://api.datablist.com.

OperationEndpoint
DiscoverGET /v1/enrichments
Read schemaGET /v1/enrichments/{enrichmentId}
CreatePOST /v1/enrichments/tasks
HistoryGET /v1/enrichments/tasks
PollGET /v1/enrichments/tasks/{taskId}
InputsGET /v1/enrichments/tasks/{taskId}/inputs
ResultsGET /v1/enrichments/tasks/{taskId}/results
CancelPOST /v1/enrichments/tasks/{taskId}/stop

See API endpoints for authentication and datastore URLs.