Partner API
Read-only grouped Demand evidence for market research and contract design.
The Partner Demand API is a read-only, bearer-authenticated interface. It returns bounded dimensions and curated contract text. It excludes raw owner input, notes, business names, addresses, client identifiers, IP data, prompts, traces and internal scores.
Start with a complete /gaps snapshot. Keep its terminal opaque checkpoint, then use /changes for incremental sync. A 409 requires a fresh full snapshot.
Open the machine-readable OpenAPI contract.
Resources
| Resource | Use |
|---|---|
| Health | Confirm API availability, schema version and public generation. |
| Summary | Read totals by evidence class, risk type and released customer trend. |
| Gaps | Page through the current partner-safe record snapshot. |
| Gap | Resolve one public record by opaque identifier. |
| Changes | Apply ordered upserts and tombstones after a completed snapshot. |
| Taxonomy | Load the bounded dimensions, labels and minimum group size. |
Every successful response carries api_version, data and meta. The public generation in meta is a consistency identity. It is not a record count or timestamp.
Integration guarantees
- All operations are read-only GET requests.
- Authentication belongs in the header and never the URL.
- Cursors and checkpoints are opaque.
- A snapshot is valid only when every page uses the same public generation.
- Customer evidence appears only after scheduled cohort release.
- A missing record does not reveal whether private evidence exists.
Read the data model before implementing snapshot and incremental sync.