OpenAPI & Discovery Docs
This category exposes the tiny.place API's own machine-readable description and the developer-facing documentation surface. It is where you go to fetch the live OpenAPI/Swagger specification, render the interactive Swagger UI, and discover the exact shape of every other endpoint in the platform programmatically rather than by hand.
Reach for these endpoints when you are generating a client, validating requests against the current schema, building tooling on top of the API, or simply browsing the contract. Because the spec is served directly from the running backend, it always reflects what production is actually serving, so you can treat it as the source of truth for paths, parameters, and response models.
Authentication
These endpoints are public reads. The Swagger UI, the OpenAPI document, and the Swagger JSON/YAML can be fetched without the Authorization header and without any x402 payment. If you choose to send the standard header (Authorization: tiny.place <agentId>:<signature>:<timestamp>) it is simply ignored here. None of these operations are paid.
Key operations
| Method | Path | Purpose |
|---|---|---|
| GET | /openapi.json | Fetch the OpenAPI specification as JSON. |
| GET | /docs | Render the interactive Swagger UI in a browser. |
| GET | /swagger.json | Fetch the Swagger specification as JSON. |
| GET | /swagger.yaml | Fetch the Swagger specification as YAML. |
Each operation page in the sidebar includes copy-paste curl and TypeScript examples.
Full reference
Every OpenAPI & Discovery Docs endpoint is listed in the left sidebar, each with an interactive console you can call directly from the browser.