Get Single Session

GET /v0/vm/{session_id}

cURL

curl -H 'Authorization: Bearer <your-api-key>' \
    https://engine.hyperbeam.com/v0/vm/<session_id>

Response Example

{
  "session_id": "c5772689-2255-4e59-8cea-b846cda7ad4e",
  "embed_url": "https://96xljbfypmn3ibra366yqapci.hyperbeam.com/AAEjQFOIRnyeb81XbBsHMw?token=VTWsp1KGn4lLySRkUCmmAhsCcqJrPdhTXNS0Y-KPwHU",
  "admin_token": "DrXWd9QguPRSXwhQn4yJ66sExpoV0BZtAfZsseYECKo",
  "creation_date": "2025-01-02T15:04:05Z07:00",
  "termination_date": null,
  "participant_duration_secs": null,
  "offline_duration_secs": null
}

Parameters

session_id

The ID of the cloud computer session

Response

session_id · string

The ID of the cloud computer session

embed_url · string

A URL you can load into the web client on your website

admin_token · string

A token that grants access to the cloud computer API and an exclusive subset of the client-side web API. Needed for setting permissions and programmatic control.

creation_date · string

The creation date of the cloud computer session. Formatted according to RFC3339 (e.g. 2006-01-02T15:04:05Z07:00).

termination_date · string or null

The termination date of the cloud computer session. Formatted according to RFC3339 (e.g. 2006-01-02T15:04:05Z07:00). null if the session hasn’t terminated yet.

participant_duration_secs · int or null

The sum of participant connection times, expressed in seconds. null if the session hasn’t terminated yet.

offline_duration_secs · int or null

The number of seconds elapsed where the session was online, but no participants were connected. null if the session hasn’t terminated yet.

cURL

curl -H 'Authorization: Bearer <your-api-key>' \
    https://engine.hyperbeam.com/v0/vm/<session_id>

Response Example

{
  "session_id": "c5772689-2255-4e59-8cea-b846cda7ad4e",
  "embed_url": "https://96xljbfypmn3ibra366yqapci.hyperbeam.com/AAEjQFOIRnyeb81XbBsHMw?token=VTWsp1KGn4lLySRkUCmmAhsCcqJrPdhTXNS0Y-KPwHU",
  "admin_token": "DrXWd9QguPRSXwhQn4yJ66sExpoV0BZtAfZsseYECKo",
  "creation_date": "2025-01-02T15:04:05Z07:00",
  "termination_date": null,
  "participant_duration_secs": null,
  "offline_duration_secs": null
}