Base URL
/v1. Requests and responses are JSON; send Content-Type: application/json on requests with a body.
Authentication
Every request is authenticated with a bearer API key:Endpoints
Conventions
- Identifiers — domains, conversations, and messages are identified by UUIDs.
- Keys — a variable is referenced by its short key, which the API returns on each variable, and a UUID. Domains, activities, conversations, and messages are referenced by UUID. UUIDs are static; keys can change.
- Values carry units — a value is returned as a string with its unit included, for example
"375000 USD"or"30 yr". See Units and precision. - Provenance — each returned variable reports a
sourceand whether it was carried forward. See Provenance. - Timestamps — ISO 8601.
- Published only — the API returns and calculates against published domains.
Errors
Transport-level problems use standard HTTP status codes with a JSON error body; calculation problems are returned in a successful response with a status oferror. See Errors.
