Run a native enrichment
Runs one native tool against an explicit list of the organization's own Company ids. Every tool runs against a Company and reads its Core — name, country, primary Domain, Activity, Identifier — from the target, so a request states only the tool's own settings and, in `context`, the Catalog fields to resolve for each target. A repeated id is one target. A Company this organization does not hold is refused as not found. A target whose Company lacks a Core input the selected tool requires is refused at admission: it appears in `refused` with the slots it could not supply, gets no Run, and costs nothing, while the rest of the launch proceeds. When every target is refused the whole request is refused with `missing_input`. The quote is `runs + unlocks` — research is the door that pays for the Legal entity behind a verified target, one credit, once, forever — and it is refused whole against `maxCredits`. Set `dryRun` for a quote that commits nothing. Variable price, quoted per request.
Runs one native tool against an explicit list of the organization's own Company ids. Every tool runs against a Company and reads its Core — name, country, primary Domain, Activity, Identifier — from the target, so a request states only the tool's own settings and, in context, the Catalog fields to resolve for each target. A repeated id is one target. A Company this organization does not hold is refused as not found. A target whose Company lacks a Core input the selected tool requires is refused at admission: it appears in refused with the slots it could not supply, gets no Run, and costs nothing, while the rest of the launch proceeds. When every target is refused the whole request is refused with missing_input. The quote is runs + unlocks — research is the door that pays for the Legal entity behind a verified target, one credit, once, forever — and it is refused whole against maxCredits. Set dryRun for a quote that commits nothing.
Variable price, quoted per request.
Authorization
bearerAuth In: header
Header Parameters
Required for writes. Reusing this key with the same input replays the original response.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/enrich" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "tool": "domain-finder", "intent": "Find domains for the Estonian mobility shortlist", "input": {}, "target": { "companyIds": [ "00000000-0000-4000-8000-000000000001", "00000000-0000-4000-8000-000000000002" ] }, "maxCredits": 50, "priority": "normal" }'{ "dryRun": true, "tool": "string", "targeted": 0, "quote": { "runs": 0, "unlocks": 0, "total": 0 }, "refused": [ { "companyId": "string", "reason": "missing_input", "missing": [ "name" ] } ]}Measure requested fields over a set of Companies POST
Reports current, stale, explicitly checked-none, and never-observed counts for only the requested Catalog fields, over either an explicit list of Companies or a Segment's live members. A `registry.*` reference is answered in `commons` instead: coverage of Legal entity data is per Commons Namespace from each Legal entity's Inventory, not per field, and it costs no Unlock, because reading an Inventory never triggers one. This read uses POST because an explicit target may carry up to 10,000 Company ids; its read posture means it takes no Idempotency-Key. Free.
Poll an enrichment GET
Returns lifecycle and per-item outcome separately for one enrichment or launch. Another organization's resource is a 404. Free.