---
title: "Validate Ai Enrichment Credits"
method: POST
path: "/enrichment/ai/validate-credits"
tags: ["Enrichment"]
---

# Validate Ai Enrichment Credits

`POST /enrichment/ai/validate-credits`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/enrichment/ai/validate-credits`
- Auth: HTTP bearer

Price an AI enrichment before running it. CHARGES NOTHING.

Resolves how many records the scope covers, what the group's usecase costs
per record, and whether the balance covers it. Call it first: this is the
only way to learn the price without paying it.

The scope fields mirror the run's exactly, so the same body prices what the
run would then do. A body that names no scope prices the whole list.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ValidateCreditsRequest: Price an AI enrichment before running it. Charges nothing.
  - `record_count` integer, nullable: Direct record count.
  - `mode` string, nullable: 'bulk' or 'column'.
  - `list_id` integer, nullable
  - `enrichment_mode` string, nullable: 'first_10', 'all' or 'error_only'.
  - `filter_model` object, nullable
  - `sort_model` object[], nullable
  - `record_ids` union[], nullable
    - union
      - integer
      - string
      - string, uuid
  - `visible_record_ids` union[], nullable
    - union
      - integer
      - string
      - string, uuid
  - `context_record_ids` union[], nullable
    - union
      - integer
      - string
      - string, uuid
  - `max_records` integer, nullable
  - `credits_per_record` integer, nullable: Deprecated. Pricing is computed server-side and this is ignored.
  - `group_id` string, nullable: AI enrichment group id.

## Response `200`

Successful Response

- ApiResponseEnrichmentPayload
  - `data` EnrichmentPayload, required: One enrichment object, open-shaped. Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)