API reference

REST API

22 endpoints across seven resources. Stable v1. Authenticate every request with an organization API key in the X-API-Key header.

Base URL

All API requests are made to:

https://api.mercury.build/api/v1

Conventions

  • Format: All requests and responses are JSON. Send Content-Type: application/json on writes.
  • IDs: Resource IDs are UUID v4 strings. Path parameters use them directly — no prefixes.
  • Pagination: List endpoints accept limit and a cursor parameter (typically before or after). Responses include a next_cursor when more is available.
  • Errors: Standard HTTP status codes. Error bodies are { "detail": "string" }.
  • Versioning: Breaking changes ship behind a new v2 path. v1 will not change shape underneath you.

Resources