REST API Reference

All API endpoints are served at http://localhost:3456/api/.

Base URL

http://localhost:3456/api

Authentication

When accessed through the relay server, authentication via RELAY_PASSWORD is required. The login endpoint sets a JWT cookie. When running locally, no authentication is required.

Response Format

All responses are JSON. Errors return:

{
  "error": "Error description"
}

Endpoints

Agents

• Agent endpoints - Create, manage, and interact with agents

Pipeline Tasks

• Task endpoints - Manage pipeline tasks and meta agent

Templates

• Template endpoints - CRUD operations for instruction templates (used as CLAUDE.md / AGENTS.md)

Settings

• GET /api/settings - Get server settings (internal-agent retention and session-file delete policy)
• GET /api/settings/runtime-capabilities - Get runtime-detected provider capabilities (reasoning efforts + model options)
• PUT /api/settings - Update server settings

Other

• GET /api/sessions - List Claude Code sessions
• GET /api/directories?path=/path - Browse server filesystem directories
• GET /api/directories/claude-md?path=/path&provider=codex - Check instruction file with provider-aware detection and compatibility fallback
• GET /api/health - Health check