Types

GET 
/workstations/types

List all Workstation Types available for request:

Workstation Type	Description
default	A Workstation with maximum hardware and software capabilities.

Workstation Types are the different configurations of Workstations available for request. Each type has a unique set of hardware and software resources available to the agentic application connecting to the Workstation.

Responses

200

Successfully listed a set of all available Workstation Types.

application/json

Schema

Schema

object string

Possible values: [list]

data

object[]

Array [

id WorkstationTypeID (string)

The identification label for a Workstation Type.

Possible values: [default]

description string

A brief description of the Workstation, its capabilities, and intended use.

hardware WorkstationHardwareTypes (string)[]

List of virtual hardware capabilities available within the Workstation.

Possible values: [keyboard, mouse, speaker, microphone, camera, display]

software WorkstationSoftwareTypes (string)[]

List of software applications available within the Workstation.

Possible values: [ssh, terminal, vnc, desktop, chromium]

models WorkstationModelTypes (string)[]

List of AI models available within the Workstation.

Possible values: [speech-to-text, text-to-speech, large-language-model]

]

Example (from schema)

{
  "object": "list",
  "data": {
    "object": "list",
    "data": [
      {
        "id": "default",
        "description": "A Workstation with maximum hardware and software capabilities.",
        "hardware": [
          "keyboard",
          "mouse",
          "speaker",
          "microphone",
          "camera",
          "display"
        ],
        "software": [
          "ssh",
          "terminal",
          "vnc",
          "desktop",
          "chromium"
        ],
        "models": [
          "speech-to-text",
          "text-to-speech",
          "large-language-model"
        ]
      }
    ]
  }
}

400

Invalid Request Format - check API documentation for proper syntax.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

401

Unauthorized - missing or invalid API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

429

Too Many Requests - you have exceeded the rate limit for your account. Please wait before making additional requests.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

500

Internal Server Error - please retry your request.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Loading...