Trigger an asynchronous job to enrich companies with AI-generated custom field values. The custom field must exist and be an AI field type (ai_score, ai_text, ai_number, ai_boolean) or a contact_collection field. Create custom fields via the Custom Fields API first.
The job runs in the background; poll the status endpoint to check progress.
A maximum of 50,000 companies are enriched per job, whether targeted via company_ids, list_id, or advanced_search; companies beyond this limit are not processed. Split larger selections across multiple jobs.
Use advanced_search to enrich the companies matching a search query without listing their ids yourself. You control the selection with sort (which matches to prefer), page.size (how many to enrich), and excluded_company_ids (matches to skip). Add a list_id alongside advanced_search to also save the matched companies to that list before they are enriched.
Enrichment settings (prompt, external data usage, contact collection options) come from the custom field's saved configuration. The request may override any of them for a single run; the field's configuration is never modified.
Preview: send enrichment_strategy: "preview" with a prompt and an output_type — no custom_field_id needed — to dry-run the prompt against a sample of up to 100 of the targeted companies. Nothing is written: no custom field values, no list changes. The per-company results are returned on the job resource once it completes. contact_collection fields cannot be previewed.
Credit Note: Credits are consumed as companies are enriched.Requires the companies:read OAuth2 scope.