Get the public API specification
Returns the OpenAPI 3.1 document for the public API exactly as this environment serves it, including only the endpoints this environment has enabled. This endpoint is open: it takes no API key, and sending one changes nothing about the response.
Response
Successful response
Example response
{
"openapi": "3.1.0",
"info": {
"title": "Hyperbolic API",
"description": "HTTP API for Hyperbolic's on-demand GPU compute: rent virtual machines and bare-metal instances, manage storage volumes, and track usage and billing. Authenticate with a Bearer API key (`Authorization: Bearer <api-key>`).",
"version": "2.0.0",
"contact": {
"name": "Hyperbolic",
"url": "https://hyperbolic.ai",
"email": "support@hyperbolic.ai"
}
},
"servers": [
{
"url": "https://api.hyperbolic.ai",
"description": "Production"
},
{
"url": "https://api.hyperbolic.xyz",
"description": "Legacy host — the same API on Hyperbolic's original domain, kept for existing integrations."
}
],
"tags": [
{
"name": "virtual-machine-rentals",
"description": "Manage virtual machine rentals",
"x-group": "Virtual Machine Rentals"
}
],
"paths": {
"/v2/on-demand/virtual-machine-rentals": {
"get": {
"operationId": "ondemand-getActiveVirtualMachineRentals",
"summary": "Get a list of active virtual machine rentals",
"description": "Get a list of active virtual machine rentals",
"tags": [
"virtual-machine-rentals"
],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error.UNAUTHORIZED"
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"Authorization": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"error.UNAUTHORIZED": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}Changes
Changed in 2 of the 14 revisions of this API.110
- ▲
the response's body type changed from no type to
objectfor statusresponse-body-type-changed
- ○
the endpoint scheme security
Authorizationwas removed from the APIapi-security-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the required property
to the response with the statusresponse-required-property-added
- ○
added the required property
to the response with the statusresponse-required-property-added
- ○
added the required property
to the response with the statusresponse-required-property-added
- ○
added the required property
to the response with the statusresponse-required-property-added
- ▲
- ○
api tag
openapiaddedapi-tag-added
- ○