Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceProvidersReservations

List GPU capacity reserved to this org

Returns the GPU reservations this organization is in the audience of or manages, with node ids, reserved units and terms. Expired and cancelled ones are left out; pending and needs-review reservations are included. With reservations not enabled for the org, the list is empty.

Required permission

Requires the provider.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl reservations list
GET
/v1/orgs/{orgId}/reservations

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string

Response Body

OK

application/json
  1. response
[index: integer]?

Exclusive placement rights for a set of orgs over specific GPU units of one node, for a term. Scoped to units, not GPU counts, because units are the indivisible allocation primitive.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/reservations'
Example Response
[  {    "id": "string",    "nodeId": "string",    "reservedUnitIds": [      "string"    ],    "releasedUnitIds": [      "string"    ],    "allowedOrgIds": [      "string"    ],    "managingOrgIds": [      "string"    ],    "startsAt": "string",    "endsAt": "string",    "status": "pending",    "topologyGen": 0,    "contractRef": "string",    "reason": "string",    "createdAt": "string",    "updatedAt": "string",    "terminated": [      "string"    ],    "skipped": [      "string"    ],    "wouldTerminate": [      "string"    ],    "wouldSkip": [      "string"    ]  }]

Reclaim released GPU units from spot POST

Returns the named units to the reservation's exclusive use and terminates the spot workloads running on them, in one call. Everything evicted was bought at the spot tier, whose terms are exactly that the capacity owner can reclaim without notice. Pass dryRun to see what would be terminated without changing anything. Callable by a platform operator, the org that owns the node, or an org in the reservation's managingOrgIds while the reservation is active and inside its term.

Overview

Generate a model response for a conversation, OpenAI-compatible: the core online inference family, with `orl chat` as its friendly front. Served by the inference endpoint (inference.openrelay.inc).