---
title: "Estimate Company Enrichment Job"
method: POST
path: "/v1/companies/enrichment-jobs/estimate"
tags: ["Companies", "Enrichment", "v1"]
---

# Estimate Company Enrichment Job

`POST /v1/companies/enrichment-jobs/estimate`

Estimate the credit cost for enriching companies with AI-generated custom field values. Target the estimate with a specific `list_id`, flat `company_ids`, or a pre-computed `company_count`.
Credit Note: This endpoint does not consume credits.

:::info
Requires the `companies:read` OAuth2 scope.
:::

## Query parameters

- `account_id` string, required

## Request body

- object
  - `data` object, required
    - `type` string
    - `attributes` union, required — Provide a `custom_field_id` plus the target to size the estimate: `list_id`, `company_ids`, or a pre-computed `company_count`.
      - object
        - `company_ids` string[] — Specific company IDs to size the estimate.
        - `list_id` string — The list to size the estimate.
        - `company_count` integer, required — Pre-computed number of companies to enrich, up to the 50,000 per-job maximum. When provided, the estimate uses this value directly and skips resolving the target, so `list_id` / `company_ids` may be omitted.
        - `custom_field_id` string, required — The API name of the custom field to enrich. Must be an AI field type (ai_score, ai_text, ai_number, ai_boolean).
        - `enrichment_strategy` 'missing_values' | 'all' — Which records to enrich
      - object
        - `company_ids` string[], required — Specific company IDs to size the estimate.
        - `list_id` string — The list to size the estimate.
        - `company_count` integer — Pre-computed number of companies to enrich, up to the 50,000 per-job maximum. When provided, the estimate uses this value directly and skips resolving the target, so `list_id` / `company_ids` may be omitted.
        - `custom_field_id` string, required — The API name of the custom field to enrich. Must be an AI field type (ai_score, ai_text, ai_number, ai_boolean).
        - `enrichment_strategy` 'missing_values' | 'all' — Which records to enrich
      - object
        - `company_ids` string[] — Specific company IDs to size the estimate.
        - `list_id` string, required — The list to size the estimate.
        - `company_count` integer — Pre-computed number of companies to enrich, up to the 50,000 per-job maximum. When provided, the estimate uses this value directly and skips resolving the target, so `list_id` / `company_ids` may be omitted.
        - `custom_field_id` string, required — The API name of the custom field to enrich. Must be an AI field type (ai_score, ai_text, ai_number, ai_boolean).
        - `enrichment_strategy` 'missing_values' | 'all' — Which records to enrich

## Response `200`

Estimate calculated successfully

- object
  - `data` object, required
    - `type` string, required
    - `id` string, uuid, required — Unique estimate identifier
    - `attributes` object, required
      - `estimated_total_credits` integer, required — Estimated credits that would be consumed
      - `company_count` integer, required — Number of companies that would be enriched
  - `meta` object, required
    - `request_id` string, required — A unique identifier assigned to each API request for end-to-end traceability.

## Other responses

- `400` — Invalid request body envelope
- `401` — Unauthorized. The request was rejected because the credentials are missing, invalid, expired, or have been revoked. The client must re-authenticate before retrying. Clients can differentiate via the `code` value of the first item in `errors`.
- `403` — Forbidden. The credentials are valid but the caller is not authorized to perform the request — typically because the user lacks the required permission, the OAuth scope is insufficient, the subscription plan does not include the required entitlement, the `account_id` does not belong to the authenticated user, or the target list is read-only and its members cannot be modified. Clients can differentiate via the `code` value of the first item in `errors`.
- `404` — Custom field not found
- `422` — Unprocessable content — request body is well-formed but fails domain validation
- `429` — Too many requests. Either the per-second rate limit or the monthly quota configured for the API key / OAuth application has been exceeded. Clients can differentiate via the `code` value of the first item in `errors`.
- `500` — Internal server error

---

[API](https://skmtc.net/leadfeeder/apis/leadfeeder-public-api.md) · [All operations](https://skmtc.net/leadfeeder/apis/leadfeeder-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leadfeeder/leadfeeder-public-api/revisions/e3b79e3bb5c3/schema)