API reference
Every served operation, generated from the contract on each release.
The pages in this section are generated from the OpenAPI document the API serves at /v1/openapi.json. Parameters, schemas, examples, and the agent notes on each operation come from the route definitions the server validates against, and CI fails when the committed document and those definitions disagree. That is the mechanism that keeps this reference honest; if you ever find it describing something the API does not do, report it as a bug.
| Group | Operations |
|---|---|
| Account | Validate the key, Usage this period |
| Stores | Store profile by domain, Enrich a batch of domains |
| Technologies | Technology vocabulary, One technology |
| Service | Service health |
Each operation page states its scope (x-scope), the billing unit it consumes (x-billing-unit), and notes for agents (x-agent-notes). The data dictionary explains the fields that need care: observation scope, install states, confidence, and match outcomes.
Download the contract: v1.json.
Billing units and plans
What consumes a unit, what never does, and the limits each plan enforces.
Validate the key and discover capabilities GET
Returns the workspace, the key used for this request, the plan limits in force, and the current billing period. Make this the first call of any integration: it tells you which scopes you hold and how much allowance remains before you spend any of it.