Response Models API Reference

June 3, 2026 · View on GitHub

API response models for AgentBay SDK.

ApiResponse

class ApiResponse()

Base class for all API responses, containing RequestID

init

def __init__(self, request_id: str = "")

Initialize an ApiResponse with a request_id.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".

get_request_id

def get_request_id() -> str

Returns the unique identifier for the API request.

BaseResult

@dataclass
class BaseResult(ApiResponse)

Base result model for new typed APIs.

This is a lightweight dataclass wrapper around ApiResponse for APIs that prefer returning structured results instead of generic OperationResult.

SessionPauseResult

class SessionPauseResult(ApiResponse)

Result of session pause operations.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             error_message: str = "",
             code: str = "",
             message: str = "",
             http_status_code: int = 0,
             status: Optional[str] = None)

Initialize a SessionPauseResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
success bool, optional - Whether the pause operation was successful. Defaults to False.
error_message str, optional - Error message if the operation failed. Defaults to "".
code str, optional - API error code. Defaults to "".
message str, optional - Detailed error message from API. Defaults to "".
http_status_code int, optional - HTTP status code. Defaults to 0.
status Optional[str], optional - Current status of the session. Possible values: "RUNNING", "PAUSED", "PAUSING". Defaults to None.

SessionResumeResult

class SessionResumeResult(ApiResponse)

Result of session resume operations.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             error_message: str = "",
             code: str = "",
             message: str = "",
             http_status_code: int = 0,
             status: Optional[str] = None)

Initialize a SessionResumeResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
success bool, optional - Whether the resume operation was successful. Defaults to False.
error_message str, optional - Error message if the operation failed. Defaults to "".
code str, optional - API error code. Defaults to "".
message str, optional - Detailed error message from API. Defaults to "".
http_status_code int, optional - HTTP status code. Defaults to 0.
status Optional[str], optional - Current status of the session. Possible values: "RUNNING", "PAUSED", "RESUMING". Defaults to None.

SessionResult

class SessionResult(ApiResponse)

Result of operations returning a single Session.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             error_message: str = "",
             session: Optional["Session"] = None,
             code: str = "")

Initialize a SessionResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
session Optional[Session], optional - The session object. Defaults to None.
success bool, optional - Whether the operation was successful. Defaults to False.
error_message str, optional - Error message if the operation failed. Defaults to "".
code str, optional - API error code. Defaults to "".

SessionListResult

class SessionListResult(ApiResponse)

Result of operations returning a list of Session IDs.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             error_message: str = "",
             session_ids: List[str] = None,
             next_token: str = "",
             max_results: int = 0,
             total_count: int = 0)

Initialize a SessionListResult.

Arguments:

request_id str - The request ID.
success bool - Whether the operation was successful.
error_message str - Error message if the operation failed.
session_ids List[str] - List of session IDs.
next_token str - Token for the next page of results.
max_results int - Number of results per page.
total_count int - Total number of results available.

DeleteResult

class DeleteResult(ApiResponse)

Result of delete operations.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             error_message: str = "",
             code: str = "",
             message: str = "",
             http_status_code: int = 0)

Initialize a DeleteResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
success bool, optional - Whether the delete operation was successful. Defaults to False.
error_message str, optional - Error message if the operation failed. Defaults to "".
code str, optional - API error code. Defaults to "".
message str, optional - Detailed error message from API. Defaults to "".
http_status_code int, optional - HTTP status code. Defaults to 0.

GetSessionData

class GetSessionData()

Data returned by GetSession API.

init

def __init__(self, app_instance_id: str = "",
             resource_id: str = "",
             session_id: str = "",
             success: bool = False,
             http_port: str = "",
             network_interface_ip: str = "",
             token: str = "",
             link_url: str = "",
             ws_url: str = "",
             vpc_resource: bool = False,
             vpc_ip: str = "",
             vpc_id: str = "",
             resource_url: str = "",
             status: str = "",
             tool_list: str = "",
             contexts: Optional[List[Dict[str, str]]] = None)

Initialize GetSessionData.

Arguments:

app_instance_id str - Application instance ID.
resource_id str - Resource ID.
session_id str - Session ID.
success bool - Success status.
http_port str - HTTP port for VPC sessions.
network_interface_ip str - Network interface IP for VPC sessions.
token str - Token for VPC sessions.
vpc_resource bool - Whether this session uses VPC resources.
resource_url str - Resource URL for accessing the session.
status str - Session status.
contexts Optional[List[Dict[str, str]]] - List of contexts associated with the session. Each context is a dict with 'name' and 'id' keys.

GetSessionResult

class GetSessionResult(ApiResponse)

Result of GetSession operations.

init

def __init__(self, request_id: str = "",
             http_status_code: int = 0,
             code: str = "",
             success: bool = False,
             data: Optional[GetSessionData] = None,
             error_message: str = "")

Initialize a GetSessionResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
http_status_code int, optional - HTTP status code. Defaults to 0.
code str, optional - Response code. Defaults to "".
success bool, optional - Whether the operation was successful. Defaults to False.
data Optional[GetSessionData], optional - Session data. Defaults to None.
error_message str, optional - Error message if the operation failed. Defaults to "".

OperationResult

class OperationResult(ApiResponse)

Result of general operations.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             data: Any = None,
             error_message: str = "",
             code: str = "",
             message: str = "",
             http_status_code: int = 0)

Initialize an OperationResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
success bool, optional - Whether the operation was successful. Defaults to False.
data Any, optional - Data returned by the operation. Defaults to None.
error_message str, optional - Error message if the operation failed. Defaults to "".
code str, optional - API error code. Defaults to "".
message str, optional - Detailed error message from API. Defaults to "".
http_status_code int, optional - HTTP status code. Defaults to 0.

BoolResult

class BoolResult(ApiResponse)

Result of operations returning a boolean value.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             data: Optional[bool] = None,
             error_message: str = "")

Initialize a BoolResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
success bool, optional - Whether the operation was successful. Defaults to False.
data Optional[bool], optional - The boolean result data. Defaults to None.
error_message str, optional - Error message if the operation failed. Defaults to "".

AdbUrlResult

class AdbUrlResult(ApiResponse)

Result of ADB URL retrieval operation.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             error_message: str = "",
             data: Optional[str] = None)

Initialize an AdbUrlResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
success bool, optional - Whether the operation was successful. Defaults to False.
error_message str, optional - Error message if the operation failed. Defaults to "".
data Optional[str], optional - The ADB URL string (e.g., "adb connect IP:Port"). Defaults to None.

extract_request_id

def extract_request_id(response) -> str

Extracts RequestID from API response. This is a helper function used to extract RequestID in all API methods.

Arguments:

response: The response object from the API call.

Returns:

str: The request ID extracted from the response, or an empty string if not

found.

McpToolsResult

class McpToolsResult(ApiResponse)

Result containing MCP tools list and request ID.

init

def __init__(self, request_id: str = "", tools: Optional[List["McpTool"]] = None)

Initialize a McpToolsResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
tools Optional[List[McpTool]], optional - List of MCP tools. Defaults to None.

McpToolResult

class McpToolResult(ApiResponse)

Result of an MCP tool call.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             data: str = "",
             error_message: str = "")

Initialize a McpToolResult.

Arguments:

request_id str, optional - Unique identifier for the API request. Defaults to "".
success bool, optional - Whether the tool call was successful. Defaults to False.
data str, optional - Tool output data (often a string or JSON). Defaults to "".
error_message str, optional - Error message if the call failed. Defaults to "".

SessionMetrics

class SessionMetrics()

Structured metrics for session monitoring.

init

def __init__(self, cpu_count: int = 0,
             cpu_used_pct: float = 0.0,
             disk_total: int = 0,
             disk_used: int = 0,
             mem_total: int = 0,
             mem_used: int = 0,
             rx_rate_kbyte_per_s: float = 0.0,
             tx_rate_kbyte_per_s: float = 0.0,
             rx_used_kbyte: float = 0.0,
             tx_used_kbyte: float = 0.0,
             timestamp: str = "",
             rx_rate_kbps: Optional[float] = None,
             tx_rate_kbps: Optional[float] = None,
             rx_used_kb: Optional[float] = None,
             tx_used_kb: Optional[float] = None)

rx_rate_kbps

@property
def rx_rate_kbps() -> float

tx_rate_kbps

@property
def tx_rate_kbps() -> float

rx_used_kb

@property
def rx_used_kb() -> float

tx_used_kb

@property
def tx_used_kb() -> float

SessionMetricsResult

class SessionMetricsResult(ApiResponse)

Result of session get_metrics() operation.

init

def __init__(self, request_id: str = "",
             success: bool = False,
             metrics: Optional[SessionMetrics] = None,
             error_message: str = "",
             raw: Optional[dict] = None)

EnvResult

class EnvResult(ApiResponse)

Result of environment variable operations (get).

init

def __init__(self, request_id: str = "",
             success: bool = False,
             envs: Optional[Dict[str, str]] = None,
             error_message: str = "")

Initialize an EnvResult.

Arguments:

request_id: Unique identifier for the API request.
success: Whether the operation was successful.
envs: Dictionary of environment variable key-value pairs.
error_message: Error message if the operation failed.

Response

Response = ApiResponse