Skip to content

Run Qualification

POST
/enrichment/ai/qualification/run

Qualify every record on a list against a template. CHARGES per record.

Creates the qualification column if the list does not have one yet. Price it first with POST /enrichment/ai/qualification/estimate. requalify re-runs, and re-charges, records that already have a verdict.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Qualify a list against a template.

object
list_id
required
integer
requalify

Re-run records that already have a verdict.

boolean
template_id
required
string format: uuid
usecase
Any of:
string
Allowed values: web-research create-modify-content

Responses

200

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string