AgentBay:Conceitos principais

# 1. Initialize client
agent_bay = AgentBay()

# 2. Create session (uses linux_latest by default)
session = agent_bay.create().session

# 3. Use session for your tasks
# ... your automation tasks ...

# 4. Clean up resources
agent_bay.delete(session)

# Create a session
session = agent_bay.create().session

# Use the session for your tasks
session.command.execute_command("echo 'Hello World'")

# Always clean up when done
agent_bay.delete(session)

Create Session → Use Session → Delete Session
      ↓             ↓              ↓
  Allocate      Execute         Release
  Resources     Operations      Resources

Liberação manual (recomendada)

# Explicitly delete when done
agent_bay.delete(session)

Liberação automática por tempo limite

Caso você não exclua a sessão manualmente, ela será liberada automaticamente após atingir o tempo limite.

1. Acesse o console do AgentBay. No painel de navegação à esquerda, escolha Policy Management.

2. Clique em Create Policy. Defina Release Inactive Desktops como Ative.

3. Insira os valores de tempo limite para Release Desktop after MCP Interaction Terminates e Release Desktop after MCP Interaction Terminates.

4. Clique em Create Policy.

5. No painel de navegação à esquerda, escolha Service Management. Localize a chave de API . Na coluna Actions, clique no ícone ⋮.

6. Escolha View/Associate Policy. Na seção Associated Policy, clique em Associate Policy. Selecione a política criada e clique em Confirm.

   Nota

   Cada chave de API pode ser associada a apenas uma política. Ao criar uma chave de API, ela é associada automaticamente à política padrão. Você deve primeiro clicar em Dissociate.

from agentbay.session_params import CreateSessionParams

# Create Windows environment and automate notepad
params = CreateSessionParams(image_id="windows_latest")
session = agent_bay.create(params).session

# Start Notepad application
session.computer.start_app("notepad.exe")
# Returns: ProcessListResult with started process info

# Input text into notepad
session.computer.input_text("Hello from Windows!")
# Returns: BoolResult with success status

agent_bay.delete(session)

# Create browser environment
params = CreateSessionParams(image_id="browser_latest")
session = agent_bay.create(params).session

# Initialize and navigate
from agentbay.browser import BrowserOption
session.browser.initialize(BrowserOption())
session.browser.agent.navigate("https://www.baidu.com")
print("Web navigation successful")

agent_bay.delete(session)

# Create development environment and execute code
params = CreateSessionParams(image_id="code_latest")
session = agent_bay.create(params).session

# Execute code
result = session.code.run_code("print('Hello from CodeSpace!')", "python")
# Returns: CodeExecutionResult with output
# Example: result.result = "Hello from CodeSpace!"

agent_bay.delete(session)

# Create Android environment and send HOME key
params = CreateSessionParams(image_id="mobile_latest")
session = agent_bay.create(params).session

# Press HOME key to return to home screen
from agentbay.mobile import KeyCode
session.mobile.send_key(KeyCode.HOME)
# Returns: BoolResult with success status
# Example: result.success = True (returns to Android home screen)

agent_bay.delete(session)

# This data will be LOST when session ends
session.file_system.write_file("/tmp/temp_data.txt", "This will disappear")

from agentbay import ContextSync

# Create persistent storage
context = agent_bay.context.get("my-project", create=True).context
context_sync = ContextSync.new(context.id, "/tmp/persistent")

# Create session with persistent data
params = CreateSessionParams(context_syncs=[context_sync])
session = agent_bay.create(params).session

# This data will be SAVED across sessions
session.file_system.write_file("/tmp/persistent/important.txt", "This will persist")

# Example API call
screenshot = session.computer.screenshot()

# The result object contains:
print(screenshot.success)     # True/False - whether the operation succeeded
print(screenshot.data)        # Your actual data (screenshot URL)
print(screenshot.request_id)  # Request ID for troubleshooting

Utilidades dos IDs de solicitação

• Resolução de problemas: Compartilhe este ID com o suporte para obter assistência mais rápida.

• Rastreamento: Acompanhe operações individuais nos logs de trace.

• Depuração: Identifique exatamente qual chamada de API apresentou falha.

Quando utilizar IDs de solicitação

• Quando uma chamada de API falhar inesperadamente.

• Ao notar problemas de desempenho em uma operação específica.

• Sempre que entrar em contato com o suporte sobre algum incidente.

Exemplo de resolução de problemas

result = session.code.run_code("print('hello')", "python")
if not result.success:
    print(f"Code execution failed! Request ID: {result.request_id}")
    # Share this Request ID with support for faster help