Skip to main content
POST
Bulk Enrich With Custom Enrichment

Consuming Custom Enrichments with the AgentSource API

After creating your custom enrichment, you can consume it through the AgentSource API. Here’s how:

Endpoint: POST api.explorium.ai/v1/custom_enrichments/<custom_enrichment_id>/bulk_enrich

Description

Consume a custom enrichment by enriching a bulk of businesses.

Parameters

  • data_context: DataFrame DICT - Rows of data that will be used for evaluation. Must include a business_id field and can optionally include other user features.

Request Example

cURL

Response Example

cURL

Authorizations

api_key
string
header
required

Path Parameters

enrichment_id
string
required

Body

application/json
business_ids
string[]
required
Required array length: 1 - 50 elements
Pattern: ^[a-f0-9]{32}$
request_context
Request Context · object | null
Example:

null

parameters
Parameters · object | null

Response

Successful Response

Response model for enriched data from a custom enrichment.

response_context
ResponseContext · object
required
data
CustomEnrichmentResponseRow · object[]
required
total_results
integer
required