Docs

API Reference

REST API reference for the Amfelt platform, generated from its OpenAPI specification.

Account

The authenticated user's own account and organization memberships.

Advise

LLM-backed advisor — the agent-callable action plus admin config and metering.

Agent

Registered Amfelt agents and their approval lifecycle.

Agent-Extras

Agent registration, invites, key rotation, security posture, and the registration-event audit log — the agent surface beyond the lifecycle core.

Agent-Release

Released builds of the Amfelt agent.

Agent-Versions

The organization's agent version policy per DTAP environment: follow the newest release, or hold a pinned version that moves by promotion.

Approvals

Generic approval requests: a change that needs a second person waits here until it is approved, declined, or expires.

Audit

The organization's audit log. Each record states who acted, what was done, to which class of governed object, and how it ended.

Catalog

Discovered ODCS data contracts for project catalog sources.

Checkpoint

Lifecycle checkpoints recorded during a job run.

Health

Liveness probe. Returns immediately with build information and uptime — no database, no auth.

Orgs

Self-service organization creation, membership, and invites.

Plugin

Plugins available for the Amfelt client.

Projects

Project lifecycle within a tenant.

Run

Job-run history, reports, and tasks persisted by the Amfelt agent.

Secret

Vault-backed secret storage and rotation.

Telemetry

Agent telemetry firehose. Agents POST run/task lifecycle events to feed the in-memory ring buffer that backs the live SSE stream; admins can purge the cache to reclaim memory.

Overview  

The Amfelt platform is driven by a REST API that exposes the control-plane resources: organizations, projects and their jobs, runs, agents, the catalog, secrets, and telemetry. The pages in this section are generated from the platform’s OpenAPI 3.x  specification and grouped by resource tag, so each operation’s parameters, request body, and responses always match the released contract.

Last updated on October 28, 2026