REST API reference
The control plane exposes a small JSON HTTP API. Authenticate every request with
the X-API-Key header. The machine-readable OpenAPI document is the source of
truth; this page summarizes the surface.
Endpoints
Section titled “Endpoints”| Method | Path | Purpose |
|---|---|---|
GET |
/prices |
Live EU offers with price and carbon intensity. |
POST |
/jobs |
Submit a job from a YAML spec. |
POST |
/jobs/preview |
Preview placement without provisioning. |
GET |
/jobs |
List jobs. |
GET |
/jobs/{id} |
Get one job’s state. |
POST |
/jobs/{id}/cancel |
Cancel a job. |
GET |
/jobs/{id}/events |
Stream status transitions (text/event-stream). |
GET |
/jobs/{id}/logs |
Stream raw logs (text/event-stream). |
GET |
/jobs/{id}/receipt |
Get a completed job’s receipt. |
GET |
/jobs/{id}/artifacts |
List output artifacts. |
GET |
/jobs/{id}/artifacts/{path} |
Download one artifact. |
GET |
/connections |
List connected provider accounts (BYOC). |
POST |
/connections |
Connect a provider account (credentials encrypted). |
Streaming
Section titled “Streaming”The two streaming endpoints emit text/event-stream. Because the API
authenticates by header, browser clients read the stream with a header-aware
fetch reader rather than EventSource, which cannot set custom headers.