Management API Overview
The Formael Management API gives you programmatic access to the same governance capabilities available in the dashboard - agents, policies, approvals, budgets, and more - from your CI/CD pipelines, infrastructure-as-code workflows, and internal tooling.
Base URL
| Environment | URL |
|---|---|
| Production | https://api.formael.com |
Machine-Readable Spec
curl https://api.formael.com/openapi.jsonImport into Postman, generate client SDKs, or validate API contracts in CI using this OpenAPI 3.0 document.
Authentication
The API supports two authentication methods:
| Method | Use case | Header |
|---|---|---|
fml_mgmt_* management token | Automation, CI/CD, programmatic access | Authorization: Bearer fml_mgmt_... |
| Keycloak JWT | Dashboard, user-scoped operations | Authorization: Bearer <jwt> |
See Authentication for full details on creating tokens and choosing the right method.
Available Resources
| Resource | Description |
|---|---|
agents | Create and manage AI agents |
policy | Configure governance policy rules |
approvals | Manage HITL approval requests |
iec | Query intent execution records and analytics |
budget | Set and monitor agent spending limits |
credentials | Store provider credentials |
bindings | Map capabilities to providers |
domains | View domain catalog and health |
approval-groups | Manage approval routing groups |
members | Manage organization members |
organization | View and update organization settings |
capabilities | Browse the capability catalog |
management-keys | Create and revoke API tokens |
maturity | Platform health and maturity scoring |
sso | Configure SSO domains and identity providers |
Versioning
The current API version is v1. Management plane routes are prefixed /manage/v1/. Breaking changes will be versioned.
Error Handling
All errors follow a standard JSON envelope. See Error Handling for status codes and retry patterns.