Skip to content

Get Enrichment Job

GET
/enrichment/jobs/{job_id}

Poll the status of an enrichment job.

Resolution order: 1. Redis job_state_cache (sub-millisecond, written by the waterfall worker pipeline). 2. enrichment_jobs table in the org schema (written by every enrichment handler including AI). DB fallback covers two cases: Redis cache eviction for old waterfall jobs, AND AI jobs whose handler isn’t wired to the cache (see AIEnrichmentHandler).

Returning DB-resolved jobs also populates total / completed counters that Redis-only resolutions leave as None - so callers polling AI jobs see progress without a separate detail call.

Authorizations

Parameters

Path Parameters

job_id
required
string

Query Parameters

include_provider_errors

When true, include per-provider step errors (record_id, provider, error) from the job records, e.g. ’ API key is not configured’. Adds one DB read; off by default.

boolean

When true, include per-provider step errors (record_id, provider, error) from the job records, e.g. ’ API key is not configured’. Adds one DB read; off by default.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
completed
Any of:
integer
failed_enrichments
Any of:
integer
job_id
required
string
provider_errors
Any of:
Array<object>
object
key
additional properties
any
results
Any of:
Array<object>
object
key
additional properties
any
status
required
string
successful_enrichments
Any of:
integer
total
Any of:
integer
total_credits_used
Any of:
integer
warnings
Any of:
Array<string>
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