> ## Documentation Index
> Fetch the complete documentation index at: https://docs.herm.run/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI specification

> Download the machine-readable OpenAPI 3.1 contract for the Herm API.

The Herm REST API is described by an OpenAPI 3.1 document:

* [Download `openapi.yaml`](/openapi.yaml)
* Base URL: `https://api.herm.run`
* Authentication: `x-api-key`

Use the specification with API explorers, contract validators, and SDK
generators. It covers the documented core agents, automations, sessions, events,
and vaults surface. Product-specific integration endpoints may be released
separately. The SSE endpoint is represented as `text/event-stream`; event
envelopes are documented in the [Events Reference](/api-reference/events-reference).