Catalog

Get an enrichment schema

Read the input, settings, and output schemas for one enrichment, along with its limits and available pricing. No authentication is required. Use the returned ID as enrichmentId when creating a task. See the catalog guide for conditional fields.

get/v1/enrichments/{enrichmentId}

Path parameters

enrichmentIdstringrequired

Response

200404

Resolved public schema and limits

200 · application/json

@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.

Get an enrichment schema

PythoncURLJavaScriptPHPGo

import requests

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

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

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

print(response.text)

Response · illustrative example

200404

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