---
title: "Enrich Record"
method: POST
path: "/v2/enrich"
tags: ["ai"]
---

# Enrich Record

`POST /v2/enrich`

## Query parameters

- `workspace_id` string, nullable

## Headers

- `X-Workspace-Code` string

## Request body

- EnrichRequest
  - `object_type` string, required
  - `record_id` string, uuid, nullable
  - `seed` EnrichCompanySeed
    - `name` string, nullable
    - `url` string, nullable
    - `external_id` string, nullable
  - `custom_field_map` object
  - `dry_run` boolean
  - `force_refresh` boolean

## Response `200`

Successful Response

- EnrichRecordApiV2EnrichPost200Envelope
  - `success` true, required
  - `data` EnrichData, required
    - `company_id` string, nullable
    - `seed_external_id` string, nullable
    - `run_id` string, required
    - `pipeline_version` string, required
    - `request_hash` string, required
    - `updated_builtin_fields` object
    - `updated_custom_fields` object
    - `proposed_fields` object
    - `field_evidence` object
    - `skipped_fields` object
    - `provider_meta` object
  - `meta` EnvelopeMeta, required
    - `ctx_id` string, required
    - `pagination` PaginationMeta
      - `page` integer, required
      - `page_size` integer, required
      - `total` integer, required
      - `next_cursor` string, nullable
    - `toast` ToastMessage
      - `variant` 'success' | 'error' | 'info' | 'warning', required
      - `code` string, required
      - `message` string, required
      - `i18n` ToastMessageI18n, required
        - `en` string, required
        - `ja` string, required

## Other responses

- `401` — Error response
- `422` — Error response

---

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