# OpenAPI Imports

The API reference is generated from HollyHR's public Zod contracts and exposes a
downloadable OpenAPI 3.1 schema.

Use the schema when you want to inspect the API in another tool, generate a
local client, or share the contract with an integration platform.

## Download the schema

Open the API reference and use the schema download action. The reference also
includes an interactive request playground for checking requests against the
same OpenAPI contract:

```text
/reference
```

The generated file is named:

```text
hollyhr-openapi-v1
```

The committed source copy lives at:

```text
docs/api/openapi.v1.yaml
```

## Import into Postman or Insomnia

1. Download the OpenAPI schema from the API reference.
2. Import it into Postman, Insomnia, or another OpenAPI-compatible client.
3. Set an environment variable for the base URL:

```text
https://{workspace}.hollyhr.com/api/v1
```

4. Set an environment variable for your bearer token.
5. Send requests with:

```text
Authorization: Bearer {{HOLLYHR_API_TOKEN}}
Accept: application/json
```

Do not paste live API tokens into shared workspaces, public collections, client
code, or screenshots.

## Generate local clients

Generated clients are not official HollyHR SDKs. Treat generated code as a
local convenience and keep the OpenAPI schema pinned in your project so API
changes are reviewed deliberately.

For production integrations, keep request IDs, error codes, ETags,
idempotency keys, and rate-limit headers visible in your logs.

## AI-readable docs

The staged developer docs publish an AI-readable index at:

```text
/llms.txt
```

It links to the canonical guide pages and the generated OpenAPI schema so
agent-assisted integration work can start from the same public contract as the
human docs.