---
title: "OpenAPI"
description: "The OpenAPI reference entrypoint generated per business operation."
---

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

# OpenAPI

## Stable identifier

Appaloft's OpenAPI 3.1 spec is generated by `@appaloft/openapi` — operation names, input schemas, output shapes, and error descriptions all come directly from the same business operation contract shared with CLI/Web/SDK. There's no separately maintained, OpenAPI-exclusive business logic.

## Entrypoint addresses <a id="api-openapi-reference" />

| Address | Description |
| --- | --- |
| `/api/openapi.json` | The raw OpenAPI 3.1 JSON document |
| `/api/reference` | A Scalar-based interactive API reference |
| `/docs/reference/openapi/*` | Per-operation reference pages generated by the public documentation site |

`/docs/reference/openapi/` is a stable entrypoint so Web help links, CLI `--help` output, and external bookmarks can all point to the same location consistently.

## Contract source

If API behavior changes, update the business operation catalog, the public documentation record, and the corresponding API/CLI help links together, keeping all three in sync — don't change only one of them.

## Related tasks

- [HTTP API reference](/docs/en/reference/http-api/)
- [TypeScript SDK](/docs/en/reference/typescript-sdk/)

Source: https://docs.appaloft.com/en/reference/openapi/index.mdx