HYhyperbolic
rentals

Get a rental

Changed on

Look up one rental by its ID, whether it is still running or has ended. Returns null when no rental with that ID belongs to the caller.

get/v2/on-demand/rental

Request

  • Base URL
    https://api.hyperbolic.ai
  • Auth
    HTTP bearer

Query parameters

rentalIdstring required

The rental's rentalId.

Response

Successful response

OR

Example response

{
  "rental": {
    "currentTerm": {
      "effectiveAt": "2025-01-31T12:00:00.000Z"
    },
    "createdAt": "2025-01-31T12:00:00.000Z",
    "updatedAt": "2025-01-31T12:00:00.000Z",
    "startedAt": "2025-01-31T12:00:00.000Z",
    "terminatedAt": "2025-01-31T12:00:00.000Z"
  }
}

Changes

  • 194666d30bfcRevision changes
    • warning

      added the new jp-east-2 enum value to the ////// response property for the response status

    • warning

      added the new jp-east-2 enum value to the ////// response property for the response status

  • dbf29b4ec8eaRevision changes
    • info

      added the required property ////// to the response with the status