Quick Start
How It Works
Agent Management
Agent CRUD Operations
| Method | Purpose | State Changes |
|---|---|---|
create_agent(config) | Deploy agent definition | Sets agent_id, agent_version |
retrieve_agent() | Get agent metadata | None |
list_agents(**kwargs) | List all agents | None |
archive_agent() | Mark agent inactive | Clears agent_id, agent_version, _session_id |
list_agent_versions() | Get version history | None |
Agent Version Management
Agent Metadata Retrieval
Environment Management
Environment CRUD Operations
| Method | Purpose | State Changes |
|---|---|---|
create_environment(config) | Provision sandbox | Sets environment_id |
retrieve_environment() | Get environment metadata | None |
list_environments(**kwargs) | List all environments | None |
archive_environment() | Mark environment inactive | Clears environment_id, _session_id |
delete_environment() | Destroy environment permanently | Clears environment_id, _session_id |
Environment Lifecycle
Session Management
Session CRUD Operations
| Method | Purpose | Returns |
|---|---|---|
create_session(agent_id, env_id) | Start agent session | session_id: str |
retrieve_session(session_id?) | Get session metadata | Dict[str, Any] |
list_sessions(**filters) | List sessions with filtering | List[Dict[str, Any]] |
archive_session(session_id?) | Mark session inactive | None |
delete_session(session_id?) | Delete session permanently | None |
Session Lifecycle
Common Patterns
Multi-Agent System
Session Pool Management
Resource Monitoring
Best Practices
Resource Management
Resource Management
Always clean up resources to avoid billing and quota issues:
Version Management
Version Management
Use agent versioning for reliable deployments:
State Management
State Management
Understand state clearing behavior:
Error Recovery
Error Recovery
Handle failures gracefully with proper resource tracking:
Related
Managed Runtime Protocol
Core protocol defining agent lifecycle operations
Managed Vault
Secure credential storage for agent integrations

