Skip to main content

routes.health

Health check routes for agent-runtimes server.

health_check​

@router.get("")
async def health_check() -> dict[str, Any]

Basic health check endpoint.

Returns:

Health status with timestamp.

readiness_check​

@router.get("/ready")
async def readiness_check() -> dict[str, Any]

Readiness check endpoint.

Checks if the service is ready to accept traffic.

Returns:

Readiness status with component states.

liveness_check​

@router.get("/live")
async def liveness_check() -> dict[str, Any]

Liveness check endpoint.

Simple check to verify the service is alive.

Returns:

Liveness status.

startup_info​

@router.get("/startup")
async def startup_info(request: Request) -> dict[str, Any]

Startup information endpoint.

Returns details about the runtime and the agent/sandbox that were created during server startup (via --agent-id CLI flag). The sandbox section is always enriched with the current state from the :class:CodeSandboxManager so that it reflects any reconfiguration performed after startup (e.g. via the /api/v1/agents/mcp-servers/start endpoint).

This is consumed by CLI tools such as agent-runtimes chat to display runtime and sandbox information to the user.

Returns:

Startup info including runtime host/port and sandbox details.