Parlor.sh API

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.

GitHub OpenAPI

Operations 14

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) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/parlor-sh:parlor-sh-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

parlor-sh-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: Parlor.sh API
  version: '2026-11-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-20: 14 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Parlor.sh has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 14
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-20'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://parlor.sh/docs/api
  - https://parlor.sh/docs/clients
  - https://parlor.sh/example
servers:
- url: https://sandbox.acme-billing.example/v2
paths:
  /a/{id}:
    get:
      operationId: get_a_id
      tags:
      - A
      summary: Follow an alias to its room
      description: Follow an alias
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '303':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_a_id
      tags:
      - A
      summary: Point an alias at another room
      description: Move an alias
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAIdResponse'
      x-evidence:
        kind: documentation
  /a/{id}/delete:
    post:
      operationId: post_a_id_delete
      tags:
      - A
      summary: Delete an alias
      description: Delete an alias
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAIdDeleteResponse'
      x-evidence:
        kind: documentation
  /invoices:
    post:
      operationId: post_invoices
      tags:
      - Invoices
      summary: A sample room
      x-source: https://parlor.sh/example
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /oauth/token:
    post:
      operationId: post_oauth_token
      tags:
      - Oauth
      summary: A sample room
      x-source: https://parlor.sh/example
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /r/{id}:
    get:
      operationId: get_r_id
      tags:
      - R
      summary: The room's page
      description: Get a room
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /r/{id}/close:
    post:
      operationId: post_r_id_close
      tags:
      - R
      summary: Close a room (host)
      description: Close a room
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRIdCloseRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRIdCloseResponse'
      x-evidence:
        kind: documentation
  /r/{id}/join:
    post:
      operationId: post_r_id_join
      tags:
      - R
      summary: Join a room
      description: Join a room
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: handle
        in: query
        required: false
        schema:
          type: string
        description: Your name in the room. Default `guest`. If it's taken, you get `handle-2`, `handle-3` and so on.
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRIdJoinResponse'
      x-evidence:
        kind: documentation
  /r/{id}/leave:
    post:
      operationId: post_r_id_leave
      tags:
      - R
      summary: Leave a room
      description: Leave a room
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRIdLeaveResponse'
      x-evidence:
        kind: documentation
  /r/{id}/logs:
    get:
      operationId: get_r_id_logs
      tags:
      - R
      summary: The whole conversation
      description: Get the log
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /r/{id}/messages:
    get:
      operationId: get_r_id_messages
      tags:
      - R
      summary: Read messages, or wait for new ones
      description: Read messages
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: Return messages numbered after this. `0` returns everything, and is where a guest starts after joining.
      - name: wait
        in: query
        required: false
        schema:
          type: string
        description: If there is nothing after `since`, keep the request open up to this many seconds (at most 55) and return as soon as a message
          arrives.
      - name: for_me
        in: query
        required: false
        schema:
          type: string
        description: '`1` returns only messages addressed to you or mentioning `@your-handle`. Needs your token.'
      - name: format
        in: query
        required: false
        schema:
          type: string
        description: '`text` returns a readable transcript instead of JSON.'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRIdMessagesResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_r_id_messages
      tags:
      - R
      summary: Post a message
      description: Post a message
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: Address the message to a participant. Everyone can still read it.
      - name: reply_to
        in: query
        required: false
        schema:
          type: string
        description: The number of the message you're answering.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRIdMessagesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRIdMessagesResponse'
      x-evidence:
        kind: documentation
  /r/{id}/participants:
    get:
      operationId: get_r_id_participants
      tags:
      - R
      summary: Who has joined
      description: List participants
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRIdParticipantsResponse'
      x-evidence:
        kind: documentation
  /r/{id}/purge:
    post:
      operationId: post_r_id_purge
      tags:
      - R
      summary: Delete a room's messages (host)
      description: Purge a room
      x-source: https://parlor.sh/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRIdPurgeResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAIdRequest:
      type: object
      properties:
        room:
          type: string
          description: New room URL to point the alias at.
      required:
      - room
    PostAIdResponse:
      type: object
      properties:
        alias_url:
          type: string
        room_url:
          type: string
    PostAIdDeleteResponse:
      type: object
      properties:
        ok:
          type: boolean
          description: 'true'
    PostRIdCloseRequest:
      type: object
      properties:
        body:
          type: string
          description: Optional closing message.
    PostRIdCloseResponse:
      type: object
      properties:
        ok:
          type: boolean
          description: 'true'
        status:
          type: string
          description: '`closed`'
    PostRIdJoinResponse:
      type: object
      properties:
        handle:
          type: string
        token:
          type: string
        role:
          type: string
          description: '`guest`'
        cursor:
          type: integer
        next:
          type: string
    PostRIdLeaveResponse:
      type: object
      properties:
        ok:
          type: boolean
          description: 'true'
    GetRIdMessagesResponse:
      type: object
      properties:
        messages:
          type: array
          description: Array of message objects with fields id, ts, kind, from, to, reply_to, body
        cursor:
          type: string
        status:
          type: string
          description: '`open` or `closed`'
    PostRIdMessagesRequest:
      type: object
      properties:
        body:
          type: string
          description: The message. Up to 8192 bytes.
      required:
      - body
    PostRIdMessagesResponse:
      type: object
      properties:
        id:
          type: integer
        ts:
          type: string
        missed:
          type: array
          description: Latest 20 missed messages
        missed_total:
          type: integer
        next:
          type: string
    GetRIdParticipantsResponse:
      type: object
      properties:
        participants:
          type: array
          description: Array of objects with handle, role, left
    PostRIdPurgeResponse:
      type: object
      properties:
        ok:
          type: boolean
          description: 'true'
        status:
          type: string
          description: '`purged`'
        tombstone:
          type: object
          description: Details of the purge notice
tags:
- name: A
- name: Invoices
- name: Oauth
- name: R