Skip to content

Response Types & Schemas ​

This section details the response types and schemas used throughout the AGB SDK.

SessionResult ​

Result of operations returning a single Session

API Methods Using This Response Type ​

  • AGB.create()
  • AGB.get()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
sessionAnyThe session object. Defaults to None.
successAnyWhether the operation was successful. Defaults to False.
error_messageAnyError message if the operation failed. Defaults to "".

Session Management APIs

Get a session by its ID or create a new session in the AGB cloud environment


DeleteResult ​

Result of delete operations

API Methods Using This Response Type ​

  • session.delete()
  • AGB.delete()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the delete operation was successful. Defaults to False.
error_messageAnyError message if the operation failed. Defaults to "".

Session and Resource Deletion APIs

Delete sessions and manage resource cleanup operations


OperationResult ​

Result of general operations

API Methods Using This Response Type ​

  • session.set_labels()
  • session.get_labels()
  • session.info()
  • session.get_link()
  • session.keep_alive()
  • agb.context.update()
  • agb.context.delete()
  • agb.context.delete_file()
  • session.computer.screen.capture()
  • session.computer.screen.get_size()
  • session.computer.mouse.get_position()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the operation was successful. Defaults to False.
dataAnyData returned by the operation. Defaults to None.
error_messageAnyError message if the operation failed. Defaults to "".

Context and Session Management APIs

Update context data, delete files, and manage session operations


BoolResult ​

Result of operations returning a boolean value

API Methods Using This Response Type ​

  • session.file.mkdir()
  • session.file.edit()
  • session.file.move()
  • session.file.remove()
  • session.file.write()
  • session.computer.window.activate()
  • session.computer.window.close()
  • session.computer.window.maximize()
  • session.computer.window.minimize()
  • session.computer.window.restore()
  • session.computer.window.resize()
  • session.computer.window.fullscreen()
  • session.computer.window.focus_mode()
  • session.computer.mouse.click()
  • session.computer.mouse.move()
  • session.computer.mouse.drag()
  • session.computer.mouse.scroll()
  • session.computer.keyboard.type()
  • session.computer.keyboard.press()
  • session.computer.keyboard.release()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the operation was successful. Defaults to False.
dataAnyThe boolean result. Defaults to None.
error_messageAnyError message if the operation failed. Defaults to "".

File System Validation APIs

File existence checks and validation operations


SessionListResult ​

Result of operations returning a list of Sessions

API Methods Using This Response Type ​

  • AGB.list()

Properties ​

PropertyTypeDescription
request_idAnyThe request ID.
successAnyWhether the operation was successful.
error_messageAnyError message if the operation failed.
session_idsAnyList of session IDs.
next_tokenAnyToken for the next page of results.
max_resultsAnyNumber of results per page.
total_countAnyTotal number of results available.

Session Listing APIs

Returns paginated list of session IDs filtered by labels


FileInfoResult ​

Result of file info operations

API Methods Using This Response Type ​

  • session.file.info()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the operation was successful. Defaults to False.
file_infoAnyFile information. Defaults to None.
error_messageAnyError message if the operation failed. Defaults to "".

File Information and Metadata APIs

Get file properties, permissions, and metadata information


FileContentResult ​

Result of file read operations

API Methods Using This Response Type ​

  • session.file.read()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the operation was successful. Defaults to False.
contentAnyFile content. Defaults to "".
error_messageAnyError message if the operation failed. Defaults to "".

File Content Access APIs

Read file content and retrieve file data


MultipleFileContentResult ​

Result of multiple file read operations

API Methods Using This Response Type ​

  • session.file.read_batch()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the operation was successful. Defaults to False.
contentsAnyDictionary of file paths to file contents. Defaults to None.
error_messageAnyError message if the operation failed. Defaults to "".

File Content Management APIs

Read multiple files and batch file content operations


DirectoryListResult ​

Result of directory listing operations

API Methods Using This Response Type ​

  • session.file.list()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the operation was successful. Defaults to False.
entriesAnyDirectory entries. Defaults to None.
error_messageAnyError message if the operation failed. Defaults to "".

Directory Management APIs

List directory contents and navigate file system structure


FileSearchResult ​

Result of file search operations

API Methods Using This Response Type ​

  • session.file.search()

Properties ​

PropertyTypeDescription
request_idAnyUnique identifier for the API request. Defaults to "".
successAnyWhether the operation was successful. Defaults to False.
matchesAnyMatching file paths. Defaults to None.
error_messageAnyError message if the operation failed. Defaults to "".

File Search and Discovery APIs

Search files by patterns and locate specific file content


Base Response Type ​

All response types inherit from ApiResponse, which provides the basic request_id property for tracking API requests.


Documentation generated automatically from source code.