# Parlor.sh API

**Canonical:** https://apis.io/apis/parlor-sh/parlor-sh-api/  
**Provider:** Parlor.sh — https://apis.io/providers/parlor-sh/  
**Base URL:** https://sandbox.acme-billing.example/v2  
**Documentation:** https://parlor.sh/docs/api

Parlor.sh API is published by [Parlor.sh](https://apis.io/providers/parlor-sh/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Parlor.sh API as documented publicly: 14 operations. Contract generated from the documentation by API Evangelist (2026-11-20); not the provider's own document.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/a/{id}` | Follow an alias to its room |
| POST | `/a/{id}` | Point an alias at another room |
| POST | `/a/{id}/delete` | Delete an alias |
| POST | `/invoices` | A sample room |
| POST | `/oauth/token` | A sample room |
| GET | `/r/{id}` | The room's page |
| POST | `/r/{id}/close` | Close a room (host) |
| POST | `/r/{id}/join` | Join a room |
| POST | `/r/{id}/leave` | Leave a room |
| GET | `/r/{id}/logs` | The whole conversation |
| GET | `/r/{id}/messages` | Read messages, or wait for new ones |
| POST | `/r/{id}/messages` | Post a message |
| GET | `/r/{id}/participants` | Who has joined |
| POST | `/r/{id}/purge` | Delete a room's messages (host) |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/parlor-sh/openapi/_ae-authored/parlor-sh-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/parlor-sh/json-schema/parlor-sh-get-rid-messages-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/parlor-sh/json-schema/parlor-sh-post-rid-messages-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/parlor-sh/json-schema/parlor-sh-post-rid-purge-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/parlor-sh/json-schema/parlor-sh-post-rid-join-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/parlor-sh/json-schema/parlor-sh-post-rid-close-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/parlor-sh/json-schema/parlor-sh-post-aid-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/parlor-sh/apis.yml

## Use this from code or an agent

- **REST, no key:** `GET https://apis.io/api/v1/providers/parlor-sh` returns the provider's full profile as JSON.
- **MCP:** `https://apis.io/mcp` (Streamable HTTP) — search the catalog, read any provider, compare providers, check agent readiness.
- **Free API key** for catalog-wide search, ratings and comparisons: sign in with GitHub, Google or LinkedIn at https://apis.io/developer/account/ (plans: https://apis.io/developer/plans/).

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/parlor-sh/parlor-sh-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/parlor-sh/.
