gbox_sdk.types.v1.boxes package

Submodules

gbox_sdk.types.v1.boxes.action_click_params module

class gbox_sdk.types.v1.boxes.action_click_params.Click

Bases: TypedDict

button: Literal['left', 'right', 'middle']

Mouse button to click

double: bool

Whether to perform a double click

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

x: Required[float]

X coordinate of the click

y: Required[float]

Y coordinate of the click

class gbox_sdk.types.v1.boxes.action_click_params.ClickByElement

Bases: TypedDict

button: Literal['left', 'right', 'middle']

Mouse button to click

double: bool

Whether to perform a double click

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

target: Required[DetectedElementParam]

Detected UI element

class gbox_sdk.types.v1.boxes.action_click_params.ClickByNaturalLanguage

Bases: TypedDict

button: Literal['left', 'right', 'middle']

Mouse button to click

double: bool

Whether to perform a double click

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

target: Required[str]

Describe the target to operate using natural language, e.g., ‘login button’ or ‘Chrome’.

gbox_sdk.types.v1.boxes.action_click_response module

gbox_sdk.types.v1.boxes.action_drag_params module

class gbox_sdk.types.v1.boxes.action_drag_params.DragAdvanced

Bases: TypedDict

duration: str

Time interval between points (e.g. “50ms”)

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

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

path: Required[Iterable[DragAdvancedPath]]

Path of the drag action as a series of coordinates

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

class gbox_sdk.types.v1.boxes.action_drag_params.DragAdvancedPath

Bases: TypedDict

x: Required[float]

X coordinate of a point in the drag path

y: Required[float]

Y coordinate of a point in the drag path

class gbox_sdk.types.v1.boxes.action_drag_params.DragSimple

Bases: TypedDict

duration: str

Duration to complete the movement from start to end coordinates

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

end: Required[Union[DragSimpleEndDragPathPoint, str]]

End point of the drag path (coordinates or natural language)

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

start: Required[Union[DragSimpleStartDragPathPoint, str]]

Start point of the drag path (coordinates or natural language)

class gbox_sdk.types.v1.boxes.action_drag_params.DragSimpleEndDragPathPoint

Bases: TypedDict

x: Required[float]

X coordinate of a point in the drag path

y: Required[float]

Y coordinate of a point in the drag path

class gbox_sdk.types.v1.boxes.action_drag_params.DragSimpleStartDragPathPoint

Bases: TypedDict

x: Required[float]

X coordinate of a point in the drag path

y: Required[float]

Y coordinate of a point in the drag path

gbox_sdk.types.v1.boxes.action_drag_response module

gbox_sdk.types.v1.boxes.action_move_params module

class gbox_sdk.types.v1.boxes.action_move_params.ActionMoveParams

Bases: TypedDict

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

x: Required[float]

X coordinate to move to

y: Required[float]

Y coordinate to move to

gbox_sdk.types.v1.boxes.action_move_response module

gbox_sdk.types.v1.boxes.action_press_button_params module

class gbox_sdk.types.v1.boxes.action_press_button_params.ActionPressButtonParams

Bases: TypedDict

buttons: Required[List[Literal['power', 'volumeUp', 'volumeDown', 'volumeMute', 'home', 'back', 'menu', 'appSwitch']]]

Button to press

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_press_button_response module

gbox_sdk.types.v1.boxes.action_press_key_params module

class gbox_sdk.types.v1.boxes.action_press_key_params.ActionPressKeyParams

Bases: TypedDict

combination: bool

Whether to press keys as combination (simultaneously) or sequentially.

When true, all keys are pressed together as a shortcut (e.g., Ctrl+C). When false, keys are pressed one by one in sequence.

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_press_key_response module

gbox_sdk.types.v1.boxes.action_screen_rotation_params module

class gbox_sdk.types.v1.boxes.action_screen_rotation_params.ActionScreenRotationParams

Bases: TypedDict

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

orientation: Required[Literal['portrait', 'landscapeLeft', 'portraitUpsideDown', 'landscapeRight']]

Target screen orientation

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_screen_rotation_response module

gbox_sdk.types.v1.boxes.action_screenshot_params module

class gbox_sdk.types.v1.boxes.action_screenshot_params.ActionScreenshotParams

Bases: TypedDict

clip: Clip

Clipping region for screenshot capture

output_format: Annotated[Literal['base64', 'storageKey']]

Type of the URI. default is base64.

presigned_expires_in: Annotated[str]

Presigned url expires in. Only takes effect when outputFormat is storageKey.

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

save_to_album: Annotated[bool]

Whether to save the screenshot to the device screenshot album

scroll_capture: Annotated[ScrollCapture]

Scroll capture parameters

class gbox_sdk.types.v1.boxes.action_screenshot_params.Clip

Bases: TypedDict

height: Required[float]

Height of the clip

width: Required[float]

Width of the clip

x: Required[float]

X coordinate of the clip

y: Required[float]

Y coordinate of the clip

class gbox_sdk.types.v1.boxes.action_screenshot_params.ScrollCapture

Bases: TypedDict

max_height: Annotated[float]

Maximum height of the screenshot in pixels.

Limits the maximum height of the automatically scrolled content. Useful for managing memory usage when capturing tall content like long web pages. Default: 4000px

scroll_back: Annotated[bool]

Whether to scroll back to the original position after capturing the screenshot

gbox_sdk.types.v1.boxes.action_screenshot_response module

class gbox_sdk.types.v1.boxes.action_screenshot_response.ActionScreenshotResponse(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

presigned_url: Optional[str]

Presigned url of the screenshot

uri: str

URL of the screenshot

gbox_sdk.types.v1.boxes.action_scroll_params module

class gbox_sdk.types.v1.boxes.action_scroll_params.ScrollAdvanced

Bases: TypedDict

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

scroll_x: Required[Annotated[float]]

Horizontal scroll amount.

Positive values scroll content rightward (reveals content on the right), negative values scroll content leftward (reveals content on the left).

scroll_y: Required[Annotated[float]]

Vertical scroll amount.

Positive values scroll content downward (reveals content below), negative values scroll content upward (reveals content above).

x: Required[float]

X coordinate of the scroll position

y: Required[float]

Y coordinate of the scroll position

class gbox_sdk.types.v1.boxes.action_scroll_params.ScrollSimple

Bases: TypedDict

direction: Required[Literal['up', 'down', 'left', 'right']]

Direction to scroll.

The scroll will be performed from the center of the screen towards this direction. ‘up’ scrolls content upward (reveals content below), ‘down’ scrolls content downward (reveals content above), ‘left’ scrolls content leftward (reveals content on the right), ‘right’ scrolls content rightward (reveals content on the left).

distance: Union[float, Literal['tiny', 'short', 'medium', 'long']]

Distance of the scroll.

Can be either a number (in pixels) or a predefined enum value (tiny, short, medium, long). If not provided, the scroll will be performed from the center of the screen to the screen edge

duration: str

Duration of the scroll

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

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

location: str

Natural language description of the location where the scroll should originate.

If not provided, the scroll will be performed from the center of the screen.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_scroll_response module

gbox_sdk.types.v1.boxes.action_swipe_params module

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeAdvanced

Bases: TypedDict

duration: str

Duration of the swipe

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

end: Required[Union[SwipeAdvancedEndSwipePath, str]]

End point of the swipe path (coordinates or natural language)

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

start: Required[Union[SwipeAdvancedStartSwipePath, str]]

Start point of the swipe path (coordinates or natural language)

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeAdvancedEndSwipePath

Bases: TypedDict

x: Required[float]

Start/end x coordinate of the swipe path

y: Required[float]

Start/end y coordinate of the swipe path

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeAdvancedStartSwipePath

Bases: TypedDict

x: Required[float]

Start/end x coordinate of the swipe path

y: Required[float]

Start/end y coordinate of the swipe path

class gbox_sdk.types.v1.boxes.action_swipe_params.SwipeSimple

Bases: TypedDict

direction: Required[Literal['up', 'down', 'left', 'right', 'upLeft', 'upRight', 'downLeft', 'downRight']]

Direction to swipe.

The gesture will be performed from the center of the screen towards this direction.

distance: Union[float, Literal['tiny', 'short', 'medium', 'long']]

Distance of the swipe.

Can be either a number (in pixels) or a predefined enum value (tiny, short, medium, long). If not provided, the swipe will be performed from the center of the screen to the screen edge

duration: str

Duration of the swipe

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

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

location: str

Natural language description of the location where the swipe should originate.

If not provided, the swipe will be performed from the center of the screen.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

gbox_sdk.types.v1.boxes.action_swipe_response module

gbox_sdk.types.v1.boxes.action_touch_params module

class gbox_sdk.types.v1.boxes.action_touch_params.ActionTouchParams

Bases: TypedDict

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

points: Required[Iterable[Point]]

Array of touch points and their actions

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

class gbox_sdk.types.v1.boxes.action_touch_params.Point

Bases: TypedDict

actions: Iterable[Union[PointActionTouchPointMoveAction, PointActionTouchPointWaitAction]]

Sequence of actions to perform after initial touch

start: Required[PointStart]

Initial touch point position

class gbox_sdk.types.v1.boxes.action_touch_params.PointActionTouchPointMoveAction

Bases: TypedDict

duration: Required[str]

Duration of the movement (e.g. “200ms”)

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

type: Required[str]

Type of the action

x: Required[float]

Target X coordinate

y: Required[float]

Target Y coordinate

class gbox_sdk.types.v1.boxes.action_touch_params.PointActionTouchPointWaitAction

Bases: TypedDict

duration: Required[str]

Duration to wait (e.g. “500ms”)

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

type: Required[str]

Type of the action

class gbox_sdk.types.v1.boxes.action_touch_params.PointStart

Bases: TypedDict

x: Required[float]

Starting X coordinate

y: Required[float]

Starting Y coordinate

gbox_sdk.types.v1.boxes.action_touch_response module

gbox_sdk.types.v1.boxes.action_type_params module

class gbox_sdk.types.v1.boxes.action_type_params.ActionTypeParams

Bases: TypedDict

include_screenshot: Annotated[bool]

⚠️ DEPRECATED: Use options.screenshot.phases instead.

This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

mode: Literal['append', 'replace']

Text input mode: ‘append’ to add text to existing content, ‘replace’ to replace all existing text

options: ActionCommonOptionsParam

Action common options

output_format: Annotated[Literal['base64', 'storageKey']]

⚠️ DEPRECATED: Use options.screenshot.outputFormat instead.

Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

presigned_expires_in: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead.

Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

press_enter: Annotated[bool]

Whether to press Enter after typing the text

screenshot_delay: Annotated[str]

⚠️ DEPRECATED: Use options.screenshot.delay instead.

This field will be ignored when options.screenshot is provided.

Delay after performing the action, before taking the final screenshot.

Execution flow:

  1. Take screenshot before action

  2. Perform the action

  3. Wait for screenshotDelay (this parameter)

  4. Take screenshot after action

Example: ‘500ms’ means wait 500ms after the action before capturing the final screenshot.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 500ms Maximum allowed: 30s

text: Required[str]

Text to type

gbox_sdk.types.v1.boxes.action_type_response module

gbox_sdk.types.v1.boxes.android_app module

class gbox_sdk.types.v1.boxes.android_app.AndroidApp(**data)

Bases: BaseModel

activity_class_name: str

Activity class name

activity_name: str

Activity name

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

package_name: str

App package name

gbox_sdk.types.v1.boxes.android_get_connect_address_response module

class gbox_sdk.types.v1.boxes.android_get_connect_address_response.AndroidGetConnectAddressResponse(**data)

Bases: BaseModel

adb: str

Android adb connect address.

use adb connect <adbConnectAddress> to connect to the Android device

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.android_get_response module

gbox_sdk.types.v1.boxes.android_install_params module

class gbox_sdk.types.v1.boxes.android_install_params.InstallAndroidPkgByFile

Bases: TypedDict

apk: Required[Union[IO[bytes], bytes, PathLike, Tuple[Optional[str], Union[IO[bytes], bytes, PathLike]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str], Mapping[str, str]]]]

APK file or ZIP archive to install (max file size: 512MB).

Single APK mode:

  • Upload a single APK file (e.g., app.apk)

  • System will automatically detect and install as single APK

Multi-APK mode (automatically detected):

  • Upload a ZIP archive containing multiple APK files

  • System will automatically detect ZIP format and install all APKs inside

  • ZIP filename example: com.reddit.frontpage-gplay.zip

  • ZIP contents example:

com.reddit.frontpage-gplay.zip └── com.reddit.frontpage-gplay/ (folder) ├── reddit-base.apk (base APK) ├── reddit-arm64.apk (architecture-specific) ├── reddit-en.apk (language pack) └── reddit-mdpi.apk (density-specific resources)

This is commonly used for split APKs where different components are separated by architecture, language, or screen density.

open: bool

Whether to open the app after installation.

Will find and launch the launcher activity of the installed app. If there are multiple launcher activities, only one will be opened. If the installed APK has no launcher activity, this parameter will have no effect.

class gbox_sdk.types.v1.boxes.android_install_params.InstallAndroidPkgByURL

Bases: TypedDict

apk: Required[str]

HTTP URL to download APK file or ZIP archive (max file size: 512MB).

Single APK mode (automatically detected):

  • Provide URL to a single APK file

  • System will automatically detect .apk extension and install as single APK

  • Example: https://example.com/app.apk

Multi-APK mode (automatically detected):

  • Provide URL to a ZIP archive containing multiple APK files

  • System will automatically detect .zip extension and install all APKs inside

  • ZIP filename example: com.reddit.frontpage-gplay.zip

  • ZIP contents example:

com.reddit.frontpage-gplay.zip └── com.reddit.frontpage-gplay/ (folder) ├── reddit-base.apk (base APK) ├── reddit-arm64.apk (architecture-specific) ├── reddit-en.apk (language pack) └── reddit-mdpi.apk (density-specific resources)

This is commonly used for split APKs where different components are separated by architecture, language, or screen density.

open: bool

Whether to open the app after installation.

Will find and launch the launcher activity of the installed app. If there are multiple launcher activities, only one will be opened. If the installed APK has no launcher activity, this parameter will have no effect.

gbox_sdk.types.v1.boxes.android_install_response module

class gbox_sdk.types.v1.boxes.android_install_response.Activity(**data)

Bases: BaseModel

class_name: str

Activity class name

is_exported: bool

Activity class name

is_launcher: bool

Whether the activity is a launcher activity.

Launcher activities appear in the device’s pkg launcher/home screen and can be directly launched by the user.

is_main: bool

Whether the activity is the main activity.

Main activity is the entry point of the pkg and is typically launched when the pkg is started.

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

Activity name

package_name: str

Activity package name

class gbox_sdk.types.v1.boxes.android_install_response.AndroidInstallResponse(**data)

Bases: BaseModel

activities: List[Activity]

Activity list

apk_path: str

Android apk path

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

package_name: str

Android pkg package name

pkg_type: Literal['system', 'thirdParty']

system or thirdParty

gbox_sdk.types.v1.boxes.android_list_activities_response module

class gbox_sdk.types.v1.boxes.android_list_activities_response.AndroidListActivitiesResponse(**data)

Bases: BaseModel

data: List[Data]

Activity list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.android_list_activities_response.Data(**data)

Bases: BaseModel

class_name: str

Activity class name

is_exported: bool

Activity class name

is_launcher: bool

Whether the activity is a launcher activity.

Launcher activities appear in the device’s pkg launcher/home screen and can be directly launched by the user.

is_main: bool

Whether the activity is the main activity.

Main activity is the entry point of the pkg and is typically launched when the pkg is started.

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

Activity name

package_name: str

Activity package name

gbox_sdk.types.v1.boxes.android_list_app_response module

class gbox_sdk.types.v1.boxes.android_list_app_response.AndroidListAppResponse(**data)

Bases: BaseModel

data: List[AndroidApp]

App list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.android_list_pkg_params module

class gbox_sdk.types.v1.boxes.android_list_pkg_params.AndroidListPkgParams

Bases: TypedDict

pkg_type: Annotated[List[Literal['system', 'thirdParty']]]

system or thirdParty, default is thirdParty

running_filter: Annotated[List[Literal['running', 'notRunning']]]

Filter pkgs by running status: running (show only running pkgs), notRunning (show only non-running pkgs). Default is all

gbox_sdk.types.v1.boxes.android_list_pkg_response module

class gbox_sdk.types.v1.boxes.android_list_pkg_response.AndroidListPkgResponse(**data)

Bases: BaseModel

data: List[AndroidPkg]

Android pkg list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.android_list_pkg_simple_params module

class gbox_sdk.types.v1.boxes.android_list_pkg_simple_params.AndroidListPkgSimpleParams

Bases: TypedDict

pkg_type: Annotated[List[Literal['system', 'thirdParty']]]

system or thirdParty, default is thirdParty

gbox_sdk.types.v1.boxes.android_list_pkg_simple_response module

class gbox_sdk.types.v1.boxes.android_list_pkg_simple_response.AndroidListPkgSimpleResponse(**data)

Bases: BaseModel

data: List[Data]

Android pkg simple list

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gbox_sdk.types.v1.boxes.android_list_pkg_simple_response.Data(**data)

Bases: BaseModel

apk_path: str

Android apk path

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

package_name: str

Android pkg package name

pkg_type: Literal['system', 'thirdParty']

system or thirdParty

gbox_sdk.types.v1.boxes.android_open_params module

class gbox_sdk.types.v1.boxes.android_open_params.AndroidOpenParams

Bases: TypedDict

activity_name: Annotated[str]

Activity name, default is the main activity.

box_id: Required[Annotated[str]]

gbox_sdk.types.v1.boxes.android_restart_params module

class gbox_sdk.types.v1.boxes.android_restart_params.AndroidRestartParams

Bases: TypedDict

activity_name: Annotated[str]

Activity name, default is the main activity.

box_id: Required[Annotated[str]]

gbox_sdk.types.v1.boxes.android_restore_params module

class gbox_sdk.types.v1.boxes.android_restore_params.AndroidRestoreParams

Bases: TypedDict

backup: Required[Union[IO[bytes], bytes, PathLike, Tuple[Optional[str], Union[IO[bytes], bytes, PathLike]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str], Mapping[str, str]]]]

Backup file to restore (max file size: 100MB)

gbox_sdk.types.v1.boxes.android_uninstall_params module

class gbox_sdk.types.v1.boxes.android_uninstall_params.AndroidUninstallParams

Bases: TypedDict

box_id: Required[Annotated[str]]
keep_data: Annotated[bool]

uninstalls the pkg while retaining the data/cache

gbox_sdk.types.v1.boxes.browser_cdp_url_params module

class gbox_sdk.types.v1.boxes.browser_cdp_url_params.BrowserCdpURLParams

Bases: TypedDict

expires_in: Annotated[str]

The CDP url 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: 120m

gbox_sdk.types.v1.boxes.browser_cdp_url_response module

gbox_sdk.types.v1.boxes.browser_cdp_url_response.BrowserCdpURLResponse

alias of str

gbox_sdk.types.v1.boxes.f_exists_params module

class gbox_sdk.types.v1.boxes.f_exists_params.FExistsParams

Bases: TypedDict

path: Required[str]

Target path in the box.

If the path does not start with ‘/’, the file/directory will be checked relative to the working directory

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_exists_response module

class gbox_sdk.types.v1.boxes.f_exists_response.ExistsFileResult(**data)

Bases: BaseModel

exists: bool

Exists

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: str

Type

class gbox_sdk.types.v1.boxes.f_exists_response.NotExistsFileResult(**data)

Bases: BaseModel

exists: bool

Exists

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_info_params module

class gbox_sdk.types.v1.boxes.f_info_params.FInfoParams

Bases: TypedDict

path: Required[str]

Target path in the box.

If the path does not start with ‘/’, the file/directory will be checked relative to the working directory

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_info_response module

gbox_sdk.types.v1.boxes.f_list_params module

class gbox_sdk.types.v1.boxes.f_list_params.FListParams

Bases: TypedDict

depth: float

Depth of the directory

path: Required[str]

Target directory path in the box

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_list_response module

class gbox_sdk.types.v1.boxes.f_list_response.FListResponse(**data)

Bases: BaseModel

data: List[Union[File, Dir]]

Array of files and directories

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_read_params module

class gbox_sdk.types.v1.boxes.f_read_params.FReadParams

Bases: TypedDict

path: Required[str]

Target path in the box.

If the path does not start with ‘/’, the file will be read from the working directory.

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_read_response module

class gbox_sdk.types.v1.boxes.f_read_response.FReadResponse(**data)

Bases: BaseModel

content: str

Content of the file

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_remove_params module

class gbox_sdk.types.v1.boxes.f_remove_params.FRemoveParams

Bases: TypedDict

path: Required[str]

Target path in the box.

If the path does not start with ‘/’, the file/directory will be deleted relative to the working directory. If the target path does not exist, the delete will fail.

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_remove_response module

class gbox_sdk.types.v1.boxes.f_remove_response.FRemoveResponse(**data)

Bases: BaseModel

message: str

Success message

model_config: ClassVar[ConfigDict] = {'defer_build': True, 'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

gbox_sdk.types.v1.boxes.f_rename_params module

class gbox_sdk.types.v1.boxes.f_rename_params.FRenameParams

Bases: TypedDict

new_path: Required[Annotated[str]]

New path in the box.

If the path does not start with ‘/’, the file/directory will be renamed relative to the working directory. If the newPath already exists, the rename will fail.

old_path: Required[Annotated[str]]

Old path in the box.

If the path does not start with ‘/’, the file/directory will be renamed relative to the working directory. If the oldPath does not exist, the rename will fail.

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_rename_response module

gbox_sdk.types.v1.boxes.f_write_params module

class gbox_sdk.types.v1.boxes.f_write_params.WriteFile

Bases: TypedDict

content: Required[str]

Content of the file (Max size: 512MB)

path: Required[str]

Target path in the box.

If the path does not start with ‘/’, the file will be written relative to the working directory. Creates necessary directories in the path if they don’t exist. If the target path already exists, the write will fail.

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

class gbox_sdk.types.v1.boxes.f_write_params.WriteFileByBinary

Bases: TypedDict

content: Required[Union[IO[bytes], bytes, PathLike, Tuple[Optional[str], Union[IO[bytes], bytes, PathLike]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str]], Tuple[Optional[str], Union[IO[bytes], bytes, PathLike], Optional[str], Mapping[str, str]]]]

Binary content of the file (Max file size: 512MB)

path: Required[str]

Target path in the box.

If the path does not start with ‘/’, the file will be written relative to the working directory. Creates necessary directories in the path if they don’t exist. If the target path already exists, the write will fail.

working_dir: Annotated[str]

Working directory.

If not provided, the file will be read from the box.config.workingDir directory.

gbox_sdk.types.v1.boxes.f_write_response module

Module contents