API Reference

Use the Faramesh API when integrating agents or building custom tools. Base URL: your Horizon URL or http://localhost:8000 for self-hosted. Interactive docs: /docs (Swagger) and /redoc.

Authentication

Send your API key in the request:

curl -H "Authorization: Bearer YOUR_API_KEY"

curl -H "Authorization: Bearer YOUR_API_KEY"

curl -H "Authorization: Bearer YOUR_API_KEY"

If the deployment enforces rate limits, the API may return 429; see Troubleshooting.

Core endpoints

Actions

Method	Path	Description
POST	`/v1/actions`	Submit an action
GET	`/v1/actions`	List actions (filter by status, agent, tool)
GET	`/v1/actions/{id}`	Get action details
POST	`/v1/actions/{id}/approval`	Approve or deny (include token in body)

Policies

Method	Path	Description
GET	`/v1/policies`	List policies
POST	`/v1/policies`	Create policy
PUT	`/v1/policies/{id}`	Update policy
DELETE	`/v1/policies/{id}`	Delete policy
POST	`/v1/policies/{id}/activate`	Activate policy
POST	`/v1/policies/import-yaml`	Import policy from YAML (body)

API Keys

Method	Path	Description
GET	`/v1/api-keys`	List your API keys
POST	`/v1/api-keys`	Create a new key
DELETE	`/v1/api-keys/{id}`	Revoke a key

Agents

Method	Path	Description
GET	`/v1/agents`	List agents
POST	`/v1/agents`	Register an agent

Analytics and audit

Method	Path	Description
GET	`/v1/analytics`	Usage analytics
GET	`/v1/events`	Event stream (Server-Sent Events)

Provenance (Merkle chain, DPR, replay)

Method	Path	Description
GET	`/v1/provenance/{hash}/proof`	Merkle inclusion proof for a decision
POST	`/v1/replay`	Re-evaluate a historical decision (deterministic replay)

See Cryptographic provenance for details.

For full request/response schemas, use the interactive docs at /docs.

Table of content