API overview
Planned
Planned. The API is a design and is not available. Snippets are illustrative.
Principles#
- REST, versioned under
/v1, described by an OpenAPI document. - Keys are scoped to a project and a set of permissions.
- Write requests accept an idempotency key so they can be retried safely.
- Responses cite provenance for extracted fields.
Example#
GET /v1/projects/{project_id}/obligations?status=open
Authorization: Bearer <scoped_api_key>Waitlist#
To be told when the API opens, use the contact page.