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. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: CommsHarbor Realtime API
version: 1d751aaf
description: Manage domain email, mailboxes, aliases and durable jobs. Each call uses its organization's identity.
servers:
- url: https://commsharbor.com
tags:
- name: Realtime
paths:
/api/realtime/ticket:
post:
operationId: post_api_realtime_ticket
summary: Create a short-lived browser ticket for the selected email workspace
description: 'Use the shared browser client with the session, CSRF and X-Organization-Id headers. Guests and API keys cannot create browser tickets. Server integrations use the HTTP management API.
Returns: { ticket, expires_in, namespace }'
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: {}
responses:
'200':
description: '{ ticket, expires_in, namespace }'
content:
application/json:
schema:
type: object
properties:
ticket:
type: string
description: Opaque browser credential. Do not log or store it.
expires_in:
type: integer
description: Seconds before an unused ticket expires.
namespace:
type: string
description: Product namespace on the shared transport.
required:
- ticket
- expires_in
- namespace
'401':
description: Session ended.
'403':
description: Organization access denied.
'503':
description: Live channel unavailable.
tags:
- Realtime
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Use an organisation API key (`mmk_…`) for permitted work in that organisation. Account operations require the shared account session. Paid routes accept a global credit token (`cred_…`). Monthly purchases require a recent human session.
globalAccount:
type: apiKey
in: cookie
name: __Host-mm-auth
description: Global session in the product's HttpOnly cookie; writes require exact Origin and X-CSRF-Token.
contaChaveApi:
type: http
scheme: bearer
bearerFormat: mmk_…
description: 'Account API key: `Authorization: Bearer mmk_…` or `X-Api-Key: mmk_…`. Created on the account page (API keys), valid only in the product where it was created; it acts as the account (or the organization that owns it).'
carteiraAgente:
type: http
scheme: bearer
bearerFormat: mmw_…
description: 'Wallet credential of an agent without an account (`Authorization: Bearer mmw_…`, 30 days, this product only): POST /api/auth/wallet/agent/start, sign the message with the wallet, POST /api/auth/wallet/agent/token. The owner is `x402:<address>`.'
x-service-info:
categories:
- email
- mailbox-management
docs:
homepage: https://commsharbor.com/
apiReference: https://commsharbor.com/developers
llms: https://commsharbor.com/llms.txt