Enrichment Usage
Credits ledger totals per provider and operation for the workspace.
API key access
leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/enrichment/usageAccess token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Query Parameters
Default: start of this UTC month
date-timeExclusive; default: now
date-timeHeader Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/enrichment/usage?since=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z" \ -H "X-Workspace-Id: string"{
"since": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z",
"calls": 0,
"units": "string",
"cost_estimate_usd": "string",
"by_provider": [
{
"provider": "string",
"operation": "string",
"calls": 0,
"found": 0,
"not_found": 0,
"errors": 0,
"units": "string",
"cost_estimate_usd": "string"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Enrich Lead
Run the enrichment waterfall for the lead and its company now. Fills empty fields only; suppressed or opted-out contact data is never added. 404 missing lead, 422 mobile lookups disabled, 503 no provider configured. A workspace's own enrichment provider (Settings -> AI & providers, kind `enrichment`) replaces the server's providers; its request budget answers 429 with `Retry-After` when used up. With `ENRICHMENT_ASYNC=true` (off by default) the same checks run, the enrichment is queued as a background job and the response is 202 with the job. A repeated request for the same lead and options while that job is queued or running, or one with the same `Idempotency-Key`, returns it.
Download Export
The built file, streamed. Authenticated by the signed `token` of the export's `download_url` only (no bearer token): 403 for a wrong or expired token, 404 once the export is gone.