API reference

One API for every chime.

Create conversations, stream resolutions, register agents, and query knowledge through a typed HTTP and WebSocket API — the same surface the dashboard and SDKs are built on.

POST /v1/conversations
curl https://api.chimes.sh/v1/conversations \
  -H "Authorization: Bearer $CHIMES_KEY" \
  -d '{
    "channel": "chat",
    "customer": "cus_8821",
    "message": "I was double charged for Pro."
  }'

→ 201 { "id": "conv_7f3c", "status": "resolving",
        "stream": "wss://api.chimes.sh/v1/conversations/conv_7f3c" }

Built for builders

Everything the platform does, you can drive.

The dashboard has no special access. If Chimes can do it, the API can do it — including resolving, escalating, and registering agents.

REST + WebSocket

A clean HTTP API for everything, plus WebSocket streams for live conversations and resolution events.

Real-time by default

Subscribe to a conversation and receive every signal, action, and confidence update as it happens.

Security-hardened

Argon2id-hashed keys, rotation and revocation, GCRA rate limiting, and a strict transport policy.

Typed end to end

An OpenAPI spec generates fully-typed clients, so your editor knows the shape of every response.

Live resolution stream

Watch a conversation resolve, event by event.

Open a WebSocket and receive each step — classification, grounding, action, confidence — as the engine works.

wss · conversation stream
{ "event": "classified", "intent": "billing.refund" }
{ "event": "grounded",   "sources": ["policy#refunds"] }
{ "event": "action",     "tool": "refund.issue", "amount": 24 }
{ "event": "resolved",   "confidence": 0.98, "ms": 1410 }

API reference

Start with a single request.

No credit card to start · Open-source core · Deploy in hours, not quarters