API Reference

This section provides the complete REST API reference for the Bivariant platform. Every endpoint is documented with request parameters, response schemas, and examples.

Resource groups

Authentication

All API requests require authentication. Include your access token or API key in the Authorization header:

Authorization: Bearer {token}

See Authentication for details on obtaining tokens, and API Keys for programmatic access.

Base URL

https://api.bivariant.com/v1

Common patterns

Pagination

List endpoints return paginated results. Use limit and offset query parameters to navigate:

GET /collections/{collectionId}/records?limit=50&offset=100

Error responses

Errors follow a consistent format:

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found."
  }
}