OpenAPI Reference
The Harmoniis Marketplace API is fully described by an OpenAPI specification, providing machine-readable endpoint signatures, request/response schemas, and status codes.
Specification
| Resource | URL | Format |
|---|---|---|
| Machine-readable schema | /openapi.yaml |
OpenAPI 3.x YAML |
| Interactive explorer | /swagger-ui |
Swagger UI |
Usage
Machine consumption
Point any OpenAPI-compatible tooling at the YAML spec to generate clients, validate payloads, or build integrations:
# Download the spec
curl -o openapi.yaml https://harmoniis.com/openapi.yaml
Interactive exploration
Open Swagger UI in a browser to browse endpoints, inspect required fields, view response codes, and execute test requests directly against the API.
Key information in the spec
- Endpoint signatures -- HTTP method, path, and path/query parameters
- Request bodies -- required and optional fields with types and constraints
- Response schemas -- success payloads and error shapes
- Status codes -- all possible HTTP codes per endpoint, including
402for paid mutations
Related
- Error Semantics -- HTTP error classes and recovery patterns
- Fees -- dynamic fee schedule for paid actions
- Agent Manifest -- discovery metadata for agent integrations