Skip to content

List Enrichment Providers

GET
/enrichment/providers

List enrichment providers with their credential mode + credit cost.

For each provider: whether graph8 funds it with a system key (system_funded

  • usable with no setup but charges credits), whether the org has its own key (byok_configured), what credential_mode='auto' resolves to for this org right now (default_credential_source), and the per-action credit costs.

This is the programmatic equivalent of the UI’s provider picker - call it before building a pipeline so you know which providers run on graph8’s system credentials by default and which require your own API key.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Catalog of enrichment providers: which are graph8-funded (system) by default vs require the org’s own key (BYOK), plus the credit cost per action.

object
count
integer
providers
Array<object>

One enrichment provider in the catalog: its credential mode + credit cost.

Lets a caller see which providers graph8 funds (usable with no setup, charges credits) vs which require the org’s own API key (BYOK), before building a pipeline — the programmatic equivalent of the UI’s provider picker.

object
actions

Action identifiers available for this provider.

Array<string>
byok_configured
required

True if the org has an active BYOK key configured for this provider.

boolean
byok_connectable

True when the org can save its own key for this provider (it is in the BYO credential catalog) or graph8 funds it. False means a step for it can only run for orgs that already hold a key.

boolean
credits_per_row

Per-action credit cost when run on graph8 system credentials (action -> credits/row).

object
key
additional properties
number
default_credential_source
required

What credential_mode=‘auto’ resolves to for this provider for this org right now.

string
Allowed values: system byok
default_for_fields

Subset of supported_fields where the provider is in the recipe’s default order.

Array<string>
field_actions

Per supported field: the action and output path the recipe uses for this provider.

object
key
additional properties

How a field’s recipe uses one provider (additive catalog detail).

object
action
required
string
optional

True when the step is an opt-in choice, not part of the recipe’s default order.

boolean
output_field
Any of:
string
optional_for_fields

Subset of supported_fields where the provider is an opt-in choice: it only runs when you list it in providers, never in the default order.

Array<string>
provider
required
string
supported_fields

Built-in fields (e.g. CONTACT_WORK_EMAIL) this provider can fill: it has a step in that field’s recipe, so field + providers=[...] accepts it. Same set as GET /enrichment/waterfall/templates.

Array<string>
system_funded
required

True if graph8 holds a system-managed key for this provider (usable without BYOK; charges credits).

boolean
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