🗂️ Context-manager API Reference

May 21, 2026 · View on GitHub

Overview

The Context-manager module provides specialized functionality for the AgentBay cloud platform. It includes various methods and utilities to interact with cloud services and manage resources.

📚 Tutorial

Data Persistence Guide

Learn about context management and data persistence

ContextManager

Constructor

public ContextManager(Session session)

Methods

info

public ContextInfoResult info()

public ContextInfoResult info(String contextId, String path, String taskType)

Get information about context synchronization status.

Parameters:

  • contextId (String): Optional ID of the context to get information for
  • path (String): Optional path where the context is mounted
  • taskType (String): Optional type of task to get information for (e.g., "upload", "download")

Returns:

  • ContextInfoResult: ContextInfoResult Result object containing context status data and request ID

sync

public ContextSyncResult sync()

public ContextSyncResult sync(String contextId, String path, String mode)

public ContextSyncResult sync(Consumer<Boolean> callback)

public ContextSyncResult sync(String contextId, String path, String mode, Consumer<Boolean> callback)

public ContextSyncResult sync(String contextId, String path, String mode, Consumer<Boolean> callback, int maxRetries, int retryInterval)

Sync context data with optional parameters and callback mode (non-blocking). Returns immediately and calls the callback when sync completes.

Parameters:

  • contextId (String): Optional ID of the context to synchronize
  • path (String): Optional path where the context should be mounted
  • mode (String): Optional synchronization mode (e.g., "upload", "download")
  • callback (Consumer): Callback function that receives success status (true if successful, false otherwise)
  • maxRetries (int): Maximum number of retries for polling completion status (default: 150)
  • retryInterval (int): Initial interval in milliseconds for exponential backoff polling (default: 500)

Returns:

  • ContextSyncResult: ContextSyncResult indicating initial sync trigger success/failure

syncAndWait

public ContextSyncResult syncAndWait()

public ContextSyncResult syncAndWait(String contextId, String path, String mode)

public ContextSyncResult syncAndWait(String contextId, String path, String mode, int maxRetries, int retryInterval)

Sync context data with optional parameters and wait for completion

Parameters:

  • contextId (String): Context ID (optional)
  • path (String): Path (optional)
  • mode (String): Sync mode (optional)
  • maxRetries (int): Maximum number of retries for polling completion status (default: 150)
  • retryInterval (int): Initial interval in milliseconds for exponential backoff polling (default: 500)

Returns:

  • ContextSyncResult: ContextSyncResult indicating success/failure after waiting for completion

bind

public ContextBindResult bind(List<ContextSync> contexts, boolean waitForCompletion)

public ContextBindResult bind(ContextSync context)

public ContextBindResult bind(BetaContextMount context)

public ContextBindResult bind(BetaContextMount context, boolean waitForCompletion)

Dynamically binds one or more contexts to the current session.

{@code
ContextSync cs = ContextSync.create(contextId, "/tmp/ctx-data", null);
ContextBindResult result = session.getContext().bind(cs);
System.out.println("Bind success: " + result.isSuccess());
}

Parameters:

  • contexts (List): List of ContextSync objects to bind
  • waitForCompletion (boolean): Whether to wait for bind registration and data download to complete

Returns:

  • ContextBindResult: ContextBindResult with the result of the operation

listBindings

public ContextBindingsResult listBindings()

Lists all context bindings for the current session.

{@code
ContextBindingsResult result = session.getContext().listBindings();
for (ContextBinding b : result.getBindings()) {
    System.out.println("Context " + b.getContextId() + " at " + b.getPath());
}
}

Returns:

  • ContextBindingsResult: ContextBindingsResult with the list of bindings