Enrichment

Start creator enrichment

Start LinkedIn profile enrichment for a creator selection. Requires a user-scoped key.

Selection (provide exactly one): creator_ids (array of UUIDs), result_set_id (string), or result_set_ids (array). creator_ids takes precedence. This endpoint does NOT accept creators: [{ profile_url }].

Synchronous completion: if every requested creator is already enriched, the response is 200 with jobs_created: 0 and all_complete: true — no job IDs are returned. Otherwise the response is 202. Enrichment results are retrieved via POST /v1/enrichments/results using creator_ids (there is no per-job polling for enrichment). Costs 1 credit per profile enriched.

post/v1/creators/enrich

Request

Request body

creator_idsstring[]

Creator UUIDs to operate on. Takes precedence over result_set_id / result_set_ids when provided.

result_set_idstring

A single result_set_id returned by a prior discovery search. Resolved to its ranked creators.

result_set_idsstring[]

Multiple result set IDs to merge (dedupe) into one creator selection.

top_ninteger

When selecting from result set(s), take only the top N ranked creators.

ranksinteger[]

When a single result_set_id is provided, select specific 1-based ranks (e.g. [1,3,5]).

Example request

{
  "creator_ids": [
    "f0e1d2c3-b4a5-4678-9abc-def012345678",
    "a1b2c3d4-e5f6-4789-9abc-0123456789ab"
  ]
}

Response

All requested creators were already enriched — no jobs created. Fetch results via POST /v1/enrichments/results with creator_ids.

successtrue required
dataobject required

Operation payload. See the example for the exact field structure.

Example response

{
  "success": true,
  "data": {
    "creators_requested": 2,
    "selection": {
      "source": "creator_ids",
      "selected_count": 2
    },
    "jobs_created": 0,
    "all_complete": true,
    "already_enriched_count": 2,
    "missing_linkedin_profiles": [],
    "jobs": []
  },
  "meta": {
    "request_id": "req_01HXYZ...",
    "trace_id": "4f1d...c2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.