Skip to main content

​
Synopsis

Starts the HTTP API server that powers the Web Console and enables remote runbook execution. The server provides REST endpoints, SSE streaming, job scheduling via Inngest, and real-time updates via Redis Pub/Sub.
The API server requires Team plan or higher for remote execution features.

​
Prerequisites

Before starting the server, ensure you have:
  1. PostgreSQL — Database for runbooks, jobs, settings, and metering
  2. Redis — Required for SSE real-time streaming and Pub/Sub
  3. Inngest (optional) — Job queue for scheduled and background execution

​
Environment variables

​
Required

​
Optional

​
AI provider credentials

The server uses the same AI provider environment variables as the CLI:

​
Setup

1

Configure environment

Create a .env file with required variables:
2

Run database migrations

3

Start the server

​
API endpoints

The server exposes REST endpoints for managing runbooks, jobs, and settings. All endpoints require authentication via API key or session. See SDK for programmatic usage.