> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperbolic.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/openapi.json
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.
security: []
tags:
  - name: openapi
    description: OpenAPI specification
    x-group: OpenAPI
  - name: rentals
    description: Manage rentals
    x-group: Rentals
  - name: bare-metal-rentals
    description: Manage bare metal rentals
    x-group: Bare Metal Rentals
  - name: virtual-machine-rentals
    description: Manage virtual machine rentals
    x-group: Virtual Machine Rentals
  - name: storage-volumes
    description: Manage storage volumes
    x-group: Storage Volumes
  - name: billing
    description: Manage billing
    x-group: Billing
  - name: users
    description: Manage users
    x-group: Users
  - name: balances
    description: Manage balances
    x-group: Balances
  - name: api-keys
    description: Manage API keys
    x-group: API Keys
  - name: ssh-keys
    description: Manage SSH public keys
    x-group: SSH Keys
paths:
  /v2/openapi.json:
    get:
      tags:
        - openapi
      summary: Get the public API specification
      description: >-
        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.
      operationId: openApiJson
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  openapi:
                    type: string
                  info:
                    type: object
                    properties:
                      title:
                        type: string
                      description:
                        type: string
                      version:
                        type: string
                      contact:
                        type: object
                        properties:
                          name:
                            type: string
                          url:
                            type: string
                        additionalProperties: {}
                    required:
                      - title
                      - version
                    additionalProperties: {}
                  servers:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        description:
                          type: string
                      required:
                        - url
                      additionalProperties: {}
                  tags:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        description:
                          type: string
                      required:
                        - name
                      additionalProperties: {}
                  paths:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type: object
                      propertyNames:
                        type: string
                      additionalProperties:
                        type: object
                        properties:
                          operationId:
                            type: string
                          summary:
                            type: string
                          description:
                            type: string
                          tags:
                            type: array
                            items:
                              type: string
                          deprecated:
                            type: boolean
                          security:
                            type: array
                            items:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties:
                                type: array
                                items:
                                  type: string
                          parameters:
                            type: array
                            items:
                              type: object
                              properties: {}
                              additionalProperties: {}
                          requestBody:
                            type: object
                            properties: {}
                            additionalProperties: {}
                          responses:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: object
                              properties: {}
                              additionalProperties: {}
                        required:
                          - responses
                        additionalProperties: {}
                  components:
                    type: object
                    properties: {}
                    additionalProperties: {}
                required:
                  - openapi
                  - info
                  - servers
                  - paths
                additionalProperties: {}
                title: OpenAPI document
                description: >-
                  The OpenAPI 3.1 document describing the public API as the
                  environment serving it actually runs. The example is abridged
                  — the real response lists every public operation and the
                  schemas they reference.
                example:
                  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
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.