v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB

Box

Live view url

This endpoint allows you to generate a pre-signed URL for accessing the live view of a running box. The URL is valid for a limited time and can be used to view the box's live stream.

post/boxes/{boxId}/live-view-url

Path parameters

boxIdstring required

Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

expiresInstring

The live view will be alive for the given duration

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 180m

Example request

{
  "expiresIn": "180m"
}

Response

Generate pre-signed live view url

urlstring required

Live view url with Gbox interface and basic information, typically used for real-time observation of box usage status

rawUrlstring required

Raw live view url without additional layout content, typically used for embedding into your own application

Example response

{
  "url": "https://gbox.ai/share/live-view/tmp_xxxxxxx",
  "rawUrl": "https://gbox.ai/share/live-view/tmp_xxxxxxx/raw"
}