Skip to main content
GET
Get Enrichment Job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Organization-Id
string | null

Path Parameters

job_id
string
required

Query Parameters

page
integer
default:1
page_size
integer
default:1000

Response

Successful Response

Response with enriched data for all items.

total_items
integer
required

Number of items being processed (may be limited by max_rows)

job_id
string | null

Job ID for tracking (always returned). Use this with source_activity_id to trigger full run.

results
EnrichItemResult · object[]

Enrichment results for each item (empty if async_mode=true)

total_rows
integer | null

Total items passed in the request (before max_rows limit)

successful
integer
default:0

Number of successfully enriched items

credits_used
integer
default:0

Number of credits used (1 per successful item)

status
string
default:completed

Job status: 'running' (async) or 'completed' (sync)

service_usage
Service Usage · object | null

Detailed API usage metrics (costs, calls, tokens) - only present when job is complete

pricing_estimates
Pricing Estimates · object | null

Estimated pricing breakdown (for example knowledge-base storage + model runtime costs when available)

knowledge_base_enabled
boolean | null

Whether this enrichment job used a knowledge base vector store

knowledge_base_sources
Knowledge Base Sources · object | null

SOURCE_X -> hosted document URL mapping for knowledge-base files used by the activity

page
integer | null

Current page number (1-indexed)

page_size
integer | null

Number of results per page

total_pages
integer | null

Total number of pages available

completed_items
integer | null

Number of items with results available so far (useful while status=running)