Class Boxes

constructor

• new Boxes(client: GboxClient): GboxClient.V1.Boxes

  Parameters

  • client: GboxClient

  Returns GboxClient.V1.Boxes

actions

android

browser

fs

media

proxy

snapshot

storage

createAndroid

• createAndroid(
      body: GboxClient.V1.BoxCreateAndroidParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.AndroidBox>

  Provisions a new Android box that you can operate through the GBOX SDK. Use this endpoint when you want to create a fresh Android environment for testing, automation, or agent execution.

  Parameters

  • body: GboxClient.V1.BoxCreateAndroidParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.AndroidBox>

  Example

  const androidBox = await client.v1.boxes.createAndroid();
  Copy

createLinux

• createLinux(
      body: GboxClient.V1.BoxCreateLinuxParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.LinuxBox>

  Provisions a new Linux box that you can operate through the GBOX SDK. Use this endpoint when you want to create a fresh Linux environment for testing, automation, or agent execution.

  Parameters

  • body: GboxClient.V1.BoxCreateLinuxParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.LinuxBox>

  Example

  const linuxBox = await client.v1.boxes.createLinux();
  Copy

display

• display(
      boxID: string,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxDisplayResponse>

  Retrieve the current display properties for a running box. This endpoint provides details about the box's screen resolution, orientation, and other visual properties.

  Parameters

  • boxID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxDisplayResponse>

  Example

  const response = await client.v1.boxes.display(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

executeCommands

• executeCommands(
      boxID: string,
      body: GboxClient.V1.BoxExecuteCommandsParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxExecuteCommandsResponse>

  Execute a command on a running box. This endpoint allows you to send commands to the box and receive the output

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxExecuteCommandsParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxExecuteCommandsResponse>

  Example

  const response = await client.v1.boxes.executeCommands(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    { command: 'ls -l' },
  );
  Copy

list

• list(
      query?: GboxClient.V1.BoxListParams | null | undefined,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxListResponse>

  Returns a paginated list of box instances. Use this endpoint to monitor environments, filter by status or type, or retrieve boxes by labels or device type.

  Parameters

  • query: GboxClient.V1.BoxListParams | null | undefined = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxListResponse>

  Example

  const boxes = await client.v1.boxes.list();
  Copy

liveViewURL

• liveViewURL(
      boxID: string,
      body?: GboxClient.V1.BoxLiveViewURLParams | null | undefined,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxLiveViewURLResponse>

  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.

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxLiveViewURLParams | null | undefined = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxLiveViewURLResponse>

  Example

  const response = await client.v1.boxes.liveViewURL(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

resolutionSet

• resolutionSet(
      boxID: string,
      body: GboxClient.V1.BoxResolutionSetParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxResolutionSetResponse>

  Set the screen resolution

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxResolutionSetParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxResolutionSetResponse>

  Example

  const response = await client.v1.boxes.resolutionSet(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    { height: 1080, width: 1920 },
  );
  Copy

retrieve

• retrieve(
      boxID: string,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxRetrieveResponse>

  This endpoint retrieves information about a box

  Parameters

  • boxID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxRetrieveResponse>

  Example

  const box = await client.v1.boxes.retrieve(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

runCode

• runCode(
      boxID: string,
      body: GboxClient.V1.BoxRunCodeParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxRunCodeResponse>

  Executes code inside the specified box. Supports multiple languages (bash, Python, TypeScript) and allows you to configure environment variables, arguments, working directory, and timeouts.

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxRunCodeParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxRunCodeResponse>

  Example

  const response = await client.v1.boxes.runCode(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    { code: 'print("Hello, World!")' },
  );
  Copy

start

• start(
      boxID: string,
      body?: GboxClient.V1.BoxStartParams | null | undefined,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxStartResponse>

  Start box

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxStartParams | null | undefined = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxStartResponse>

  Example

  const response = await client.v1.boxes.start(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

stop

• stop(
      boxID: string,
      body?: GboxClient.V1.BoxStopParams | null | undefined,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxStopResponse>

  Stop box

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxStopParams | null | undefined = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxStopResponse>

  Example

  const response = await client.v1.boxes.stop(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

terminate

• terminate(
      boxID: string,
      body?: GboxClient.V1.BoxTerminateParams | null | undefined,
      options?: RequestOptions,
  ): APIPromise<void>

  Terminate a running box. This action will stop the box and release its resources.

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxTerminateParams | null | undefined = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<void>

  Example

  await client.v1.boxes.terminate(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

websocketURL

• websocketURL(
      boxID: string,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxWebsocketURLResponse>

  Get the websocket url for the box. This endpoint provides the WebSocket URLs for executing shell commands and running code snippets in the box environment. These URLs allow real-time communication and data exchange with the box, enabling interactive terminal sessions and code execution.

  Parameters

  • boxID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxWebsocketURLResponse>

  Example

  const response = await client.v1.boxes.websocketURL(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

webTerminalURL

• webTerminalURL(
      boxID: string,
      body?: GboxClient.V1.BoxWebTerminalURLParams | null | undefined,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxWebTerminalURLResponse>

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

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxWebTerminalURLParams | null | undefined = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxWebTerminalURLResponse>

  Example

  const response = await client.v1.boxes.webTerminalURL(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy