Catalog

List enabled enrichments

List available enrichments and their IDs. No authentication is required. Choose an ID, then read its schema to see the inputs and settings it accepts.

get/v1/enrichments

Response

200403

Enabled enrichment catalog

200 · application/json

enrichmentsobject[]required

Show child attributes

@idstringrequired

@typestringrequired

const: "Enrichment"

namestringrequired

descriptionstringrequired

schemaVersionstringrequired

creditsPerInputstring | nullrequired

Fixed credit amount when known; null for variable-price actions. Actual usage is returned with task results.

coststring | null

Human-readable pricing description. Null when unavailable; actual credit usage is returned with task results.

inputSchemaobjectrequired

Fields to send in each input's data object. required lists fields always needed. requiredWhenEnabled makes a field required when its enableOnSetting rule matches your settings. Known fields you send are checked even when inactive.

Show child attributes

object

Fields to send in each input's data object. required lists fields always needed. requiredWhenEnabled makes a field required when its enableOnSetting rule matches your settings. Known fields you send are checked even when inactive.

Additional properties are supported.

settingsSchemaobjectrequired

Fields accepted in settings. enableOnSetting explains when to show a field in a settings form; it does not change validation. Extra settings are accepted.

Show child attributes

object

Fields accepted in settings. enableOnSetting explains when to show a field in a settings form; it does not change validation. Extra settings are accepted.

Additional properties are supported.

outputSchemaobjectrequired

Known output fields. enableOnSetting explains which settings use a field. Results can include extra fields; these rules never remove returned data.

Show child attributes

object

Known output fields. enableOnSetting explains which settings use a field. Results can include extra fields; these rules never remove returned data.

Additional properties are supported.

limitsobjectrequired

Show child attributes

object

Additional properties are supported.

List enabled enrichments

PythoncURLJavaScriptPHPGo

import requests

url = "https://api.datablist.com/v1/enrichments"

headers = {
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.text)

Response · illustrative example

200403

{
  "enrichments": [
    {
      "@id": "string",
      "@type": "Enrichment",
      "name": "string",
      "description": "string",
      "schemaVersion": "string",
      "creditsPerInput": "string",
      "cost": "string",
      "inputSchema": {},
      "settingsSchema": {},
      "outputSchema": {},
      "limits": {}
    }
  ]
}