Documentation

API

A local REST and WebSocket API, the same one the desktop app uses.

Authentication

When an API token is configured it is written to ~/.foreman/token, and every request except /health must present it as a bearer token.

curl -H "Authorization: Bearer <token>" \
  http://127.0.0.1:4319/projects

Without it you get a bare {"error":"unauthorized"}. Browsers can’t set headers on WebSocket or EventSource connections, so ?token= is accepted there instead.

Create and start a task

curl -X POST http://127.0.0.1:4319/tasks \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "demo-repo",
    "title": "Update dependencies and run tests",
    "autonomyLevel": 1
  }'

Endpoints

A selection of the orchestrator’s REST surface. All of it listens on loopback unless you change FOREMAN_HOST.