Skip to content

List Ai Configs

GET
/enrichment/ai/configs

List active AI enrichment configs runnable on a list.

Returns configs where list_id matches OR is_global=true. Each summary includes a group_id the caller passes back to POST /enrichment/ai/enrich. Empty list means the org has no AI configs and must create one in the UI before AI enrichment is usable.

Authorizations

Parameters

Query Parameters

list_id
required

List ID whose saved AI configs to return

integer

List ID whose saved AI configs to return

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Paginated (by list_id filter) collection of AI enrichment configs.

object
configs
Array<object>

One saved AI enrichment config attached to (or global for) a list.

group_id is the handle the worker uses to load the prompt, model and output mapping. usecase lets the client predict credit cost via enrichment.constants.AI_USECASE_CREDITS (e.g. web-research = 3 credits/record).

object
group_id
required
string
is_active
boolean
default: true
is_global
boolean
list_id
Any of:
integer
name
required
string
usecase
Any of:
string
count
integer
list_id
Any of:
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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