Skip to content

API Reference

Complete API reference documentation for AgentFense.

Available References

Python API Reference

Auto-generated documentation from Python SDK source code, including:

  • Sandbox / AsyncSandbox classes
  • SandboxClient / AsyncSandboxClient classes
  • Permission types and enums
  • Exception classes
  • Utility functions

gRPC/Proto Reference

Protocol Buffer definitions and gRPC service specifications:

  • SandboxService - Sandbox lifecycle and execution
  • CodebaseService - Codebase and file management
  • Message types and field documentation

Go API Reference

Coming soon

Go package documentation for internal server components.

  • Python SDK: Start with High-Level API
  • REST API: Use the HTTP gateway at :8080 (see gRPC Reference for endpoints)
  • gRPC: Connect directly to :9000 using generated clients

Versioning

API documentation is versioned alongside the AgentFense releases. Make sure to use the documentation version that matches your installed version.

Current version: Check GitHub Releases