API Reference

Every endpoint below is served from a single base URL:

https://api-v3.rebase.energy/platform/v3

Requests carry an API key in the Authorization header using the ApiKey scheme (not Bearer). The key is bound to one workspace, so there is no workspace parameter anywhere in the API. See Authentication for how to create a key and verify it.

Authorization: ApiKey rbk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

All request and response bodies are JSON. Timestamps are ISO 8601; send an explicit UTC offset and expect UTC back. List endpoints are cursor paginated: pass next_cursor back as ?cursor= until it is null. Responses over a kilobyte are gzip-compressed when the request accepts it.

Endpoint groups

• Object types: the catalog of record kinds in your workspace. sites and assets are built in; define your own with POST /objects.
• Records: the generic create, read, update, and delete surface shared by every object type, plus whole-type totals and a streaming export. {object_name} is the name of an entry in the catalog.
• Links: the records one attribute holds, linking and unlinking one record, and the connections that run through a record.
• Timeseries: upload, read, and retract points on one record's series, or upload a standalone series.
• Timeseries batch: write, read, catalogue, and summarise many series on many records in one call.
• Dashboards: store a declarative dashboard document, resolve it into the cards and lines a renderer draws, and replace or delete it.

Each page has an interactive playground. Paste your key into the Authorization field as ApiKey <token> to run requests against your workspace.