Current API version
Production base URL:https://api.hivecompute.ai/v1
Staging base URL:
https://staging-api.hivecompute.ai/v1
The current release contains eight public endpoints. The endpoint reference shows the current request and response details.
Latest changes
API surface finalized for release
Changed- Production base URL is now
https://api.hivecompute.ai/v1. - Staging is available at
https://staging-api.hivecompute.ai/v1. - Region values are
UAE,FR, andUS. - Instance logs are returned newest first.
entries[0]is the most recent line. - Start, stop, and terminate can return
409 Conflictwith error codeCONFLICTwhen the requested action conflicts with the current lifecycle state. 500responses use the generic messageAn internal error occurred.Clients should useerror.code, noterror.message, for program logic.429responses includeRetry-Afterand use the standard error envelope.
POST /ssh-keysGET /ssh-keys/{id}
Public API documentation prepared
Initial documentation covered instance lifecycle operations, logs, regions, presets, and planned SSH-key operations. The release surface was subsequently narrowed and finalized in the August update above.Current endpoints
GET /instancesGET /instances/{id}GET /instances/{id}/logsPOST /instances/{id}/startPOST /instances/{id}/stopPOST /instances/{id}/terminateGET /regionsGET /presets
What counts as a breaking change
A breaking change may require you to update code that already works. Examples include removing an endpoint or field, changing a field type, changing authentication behavior, or making an existing request parameter required.Don’t rely on undocumented fields or behavior. Build integrations against the published API reference.
How to stay compatible
- Use the versioned base URL shown in the docs.
- Build logic around documented fields and
error.codevalues. - Treat cursors as opaque.
- Respect
Retry-Afteron429responses. - Check instance state before retrying lifecycle actions.
- Review this changelog when integration behavior changes unexpectedly.