api

AgentBay Python SDK API Reference

This directory contains auto-generated API reference documentation.

Quick Links

• 📁 Synchronous API (sync/)
• ⚡ Asynchronous API (async/)
• 📦 Common Classes (common/)

Synchronous vs Asynchronous

AgentBay provides both synchronous and asynchronous APIs with identical interfaces:

Feature	Sync API	Async API
Use Case	Simple scripts, linear workflows	Concurrent operations, high performance
Performance	Sequential execution	4-6x faster for parallel tasks
Syntax	result = agent.create()	result = await agent.create()
Import	from agentbay import AgentBay	from agentbay import AsyncAgentBay

See Synchronous vs Asynchronous Guide for detailed comparison.

---

Synchronous API

All synchronous API classes are in the sync/ directory:

• AgentBay - agentbay.agentbay
• Network - agentbay.beta_network
• Session - agentbay.session
• Command - agentbay.command
• Context - agentbay.context
• Context Manager - agentbay.context_manager
• File System - agentbay.filesystem
• Agent - agentbay.agent
• OSS - agentbay.oss
• Browser - agentbay.browser
• BrowserAgent - agentbay.browser_agent
• Extension - agentbay.extension
• Code - agentbay.code
• Computer - agentbay.computer
• Mobile - agentbay.mobile
• BrowserFingerprint - agentbay.fingerprint
• MobileSimulate - agentbay.mobile_simulate
• SessionParams - agentbay.agentbay._common.params.session_params

Asynchronous API

All asynchronous API classes are in the async/ directory:

• AsyncAgentBay - agentbay.agentbay
• AsyncNetwork - agentbay.beta_network
• AsyncSession - agentbay.session
• AsyncCommand - agentbay.command
• AsyncContext - agentbay.context
• AsyncContextManager - agentbay.context_manager
• AsyncFileSystem - agentbay.filesystem
• AsyncAgent - agentbay.agent
• AsyncOss - agentbay.oss
• AsyncBrowser - agentbay.browser
• AsyncBrowserAgent - agentbay.browser_agent
• AsyncExtension - agentbay.extension
• AsyncCode - agentbay.code
• AsyncComputer - agentbay.computer
• AsyncMobile - agentbay.mobile
• AsyncBrowserFingerprint - agentbay.fingerprint
• AsyncMobileSimulate - agentbay.mobile_simulate
• AsyncSessionParams - agentbay.agentbay._common.params.session_params

Common Classes

Shared classes used by both sync and async APIs are in the common/ directory:

• Configuration - agentbay._common.config
• Exceptions - agentbay._common.exceptions
• Logging - agentbay._common.logger
• Context Sync - agentbay._common.params.context_sync
• Code Execution Models - agentbay._common.models.code
• Browser Models - agentbay._common.models.browser
• Response Models - agentbay._common.models.response
• Browser Agent Models - agentbay._common.models.browser_agent

---

Note: This documentation is auto-generated from source code. Run python scripts/generate_api_docs.py to regenerate.