Docs

API Server

Weave can expose its weave operations over a small HTTP REST API — useful for automation, scripts, and CI. Like the MCP server, it runs in-process and shares the same database and orchestrator as the desktop app.

Enabling it

Turn it on under Settings → API / MCP. It's off by default.

  • Host — defaults to 127.0.0.1 (loopback only); set 0.0.0.0 to accept off-box connections.
  • Port — defaults to 8080.
  • Auth token — when set, every request needs Authorization: Bearer <token>; empty means no auth.

Endpoints

  • GET /projects — list projects (to find a project_id).
  • POST /weaves — create a weave (requires project_id).
  • GET /weaves / GET /weaves/{id} — list weaves, or fetch one with its tasks.
  • POST /weaves/{id}/run — start a run (returns immediately; poll for status).
  • POST /weaves/{id}/stop — stop a run.

A machine-readable OpenAPI 3.1 document is always served at GET /openapi.json (no token required) — import it into Postman, Insomnia, or a code generator.

# Create a weave, then run it
curl -X POST http://127.0.0.1:8080/weaves \
  -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' \
  -d '{"name":"nightly","project_id":"<project-uuid>"}'

curl -X POST http://127.0.0.1:8080/weaves/<id>/run -H 'Authorization: Bearer TOKEN'

See also: MCP Server for the MCP transport.