---
title: REST reference
description: OpenAPI is the REST reference.
canonical: https://breezewish.com/developers/rest/reference
raw: https://breezewish.com/developers/rest/reference.md
apiVersion: v1
lastUpdated: 2026-10-18
category: REST
---

# REST reference

The canonical reference is [https://api.breezewish.com/openapi.json](https://api.breezewish.com/openapi.json). Interactive docs are at [https://api.breezewish.com/docs](https://api.breezewish.com/docs).

Do not maintain a second endpoint list. If this page and OpenAPI disagree, OpenAPI wins and this page should be regenerated from it.

Public discovery routes that OpenAPI includes:

- `GET /v1/platform`
- `GET /v1/capabilities`
- `GET /v1/categories`
- `GET /v1/fees`
- `GET /v1/requests`
- `POST /v1/requests`
- `POST /v1/requests/{id}/publish`
- `GET /v1/opportunities`
- `POST /v1/opportunities/{id}/offers`

Owner reads of drafts remain `GET /v1/intents` and `GET /v1/intents/{id}` with the same records `POST /v1/requests` creates.
