Skip to content

API reference

Every endpoint in the Actuator REST API, organized by resource. The base URL is https://useactuator.ai; all paths are under /api/v1 unless otherwise noted.

Authentication options, error envelope, and rate-limit headers are covered on the authentication page.

Resources

  • Authentication — magic-link sign-in, signup, install-claim, session, invitation accept.
  • Organizations — org CRUD.
  • Members and invitations — list members, change roles, mint and redeem invitations.
  • API keys — mint, list, and revoke bearer tokens.
  • Projects — project CRUD inside an org.
  • Environments — environment CRUD inside a project.
  • Flags — boolean and string flag CRUD; project-scope identity, per-environment state.
  • Configs — typed config CRUD with optional JSON Schema validation.
  • Segments — reusable named predicate CRUD with reference-checking.
  • Evaluation — the hot path: evaluate flags and configs for a context. Plus preview, history, version probe, and validation helpers.
  • Proposals — agent-friendly propose / apply / cancel workflow.
  • Audit — query the audit log.
  • Errors — error envelope, status codes, full error code catalog, rate-limit headers.

OpenAPI

The full OpenAPI 3.1 spec is served at /openapi.yaml and /openapi.json — drop them into your spec viewer, code generator, or test runner of choice.