AgentOS Server API Reference

NewServer

Create HTTP server.

Signature:

func NewServer(config *Config) (*Server, error)

type Config struct {
    Address        string           // Server address (default: :8080)
    SessionStorage session.Storage  // Session storage (default: memory)
    Logger         *slog.Logger     // Logger (default: slog.Default())
    Debug          bool             // Debug mode (default: false)
    AllowOrigins   []string         // CORS origins
    AllowMethods   []string         // CORS methods
    AllowHeaders   []string         // CORS headers
    RequestTimeout time.Duration    // Request timeout (default: 30s)
    MaxRequestSize int64            // Max request size (default: 10MB)

    // Knowledge API (optional)
    VectorDBConfig *VectorDBConfig  // Vector database configuration (e.g., chromadb)
    EmbeddingConfig *EmbeddingConfig // Embedding model configuration (e.g., OpenAI)
}

type VectorDBConfig struct {
    Type           string // e.g., "chromadb"
    BaseURL        string // Vector DB endpoint
    CollectionName string // Default collection
    Database       string // Optional database name
    Tenant         string // Optional tenant name
}

type EmbeddingConfig struct {
    Provider string // e.g., "openai"
    APIKey   string
    Model    string // e.g., "text-embedding-3-small"
    BaseURL  string // e.g., "https://api.openai.com/v1"
}

Example:

server, err := agentos.NewServer(&agentos.Config{
    Address: ":8080",
    Debug:   true,
    RequestTimeout: 60 * time.Second,
})

Server.RegisterAgent

Register an agent.

Signature:

func (s *Server) RegisterAgent(agentID string, ag *agent.Agent) error

Example:

err := server.RegisterAgent("assistant", myAgent)

Server.Start / Shutdown

Start and stop server.

Signatures:

func (s *Server) Start() error
func (s *Server) Shutdown(ctx context.Context) error

Example:

go func() {
    if err := server.Start(); err != nil {
        log.Fatal(err)
    }
}()

// Graceful shutdown
quit := make(chan os.Signal, 1)
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
<-quit

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
server.Shutdown(ctx)

API Endpoints

See OpenAPI Specification for complete API documentation.

Core Endpoints:

• GET /health - Health check
• POST /api/v1/sessions - Create session
• GET /api/v1/sessions/{id} - Get session
• PUT /api/v1/sessions/{id} - Update session
• DELETE /api/v1/sessions/{id} - Delete session
• GET /api/v1/sessions - List sessions
• GET /api/v1/agents - List agents
• POST /api/v1/agents/{id}/run - Run agent

Knowledge Endpoints (optional):

• POST /api/v1/knowledge/search — Vector similarity search in knowledge base
• GET /api/v1/knowledge/config — Available chunkers, VectorDBs, and embedding model info
• POST /api/v1/knowledge/content — Minimal ingestion (text/plain or application/json)

Example request:

curl -X POST http://localhost:8080/api/v1/knowledge/search \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How to create an Agent?",
    "limit": 5,
    "filters": {"source": "documentation"}
  }'

Minimal server config for Knowledge API:

server, err := agentos.NewServer(&agentos.Config{
  Address: ":8080",
  VectorDBConfig: &agentos.VectorDBConfig{
    Type:           "chromadb",
    BaseURL:        os.Getenv("CHROMADB_URL"),
    CollectionName: "agno_knowledge",
  },
  EmbeddingConfig: &agentos.EmbeddingConfig{
    Provider: "openai",
    APIKey:   os.Getenv("OPENAI_API_KEY"),
    Model:    "text-embedding-3-small",
  },
})

See runnable example: cmd/examples/knowledge_api/.

Best Practices

1. Always Use Contexts

ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()

output, err := ag.Run(ctx, input)

2. Handle Errors Properly

output, err := ag.Run(ctx, input)
if err != nil {
    switch {
    case types.IsInvalidInputError(err):
        // Handle invalid input
    case types.IsRateLimitError(err):
        // Retry with backoff
    default:
        // Handle other errors
    }
}

3. Manage Memory

// Clear when starting new topic
ag.ClearMemory()

// Or use limited memory
mem := memory.NewInMemory(50)

4. Set Appropriate Timeouts

server, _ := agentos.NewServer(&agentos.Config{
    RequestTimeout: 60 * time.Second, // For complex agents
})