Back to home

Chesly Docs

Build with the Chesly API — read messages, send messages, and manage your conversations programmatically.

API Reference

The full machine-readable spec is published at /openapi.yaml. Personal API tokens (csk_…) are accepted on the endpoints listed below; every other endpoint in the spec is reserved for the iOS app and rejects tokens with 403 forbidden_for_api_token.

Rooms

  • GET /api/rooms — list rooms
  • GET /api/rooms/:id — get a room
  • GET /api/rooms/filter/priority — priority inbox
  • POST /api/rooms/:id/read — mark messages read
  • POST /api/rooms/:id/typing — send typing indicator
  • POST /api/rooms/:id/{mute|unmute|archive|unarchive|favorite|unfavorite|pin|unpin}
  • POST /api/rooms/:id/messages — send a message

Messages

  • GET /api/messages — list messages (with roomId, before, limit)
  • PUT /api/messages/:id — edit a message you sent
  • DELETE /api/messages/:id — delete a message
  • POST /api/messages/schedule — schedule a message
  • DELETE /api/messages/scheduled/:id — cancel a scheduled message
  • POST /api/rooms/:id/messages/:messageId/reactions — add reaction
  • DELETE /api/rooms/:id/messages/:messageId/reactions/:emoji — remove reaction

Real-time sync

  • GET /api/sync — Server-Sent Events stream of new messages, edits, deletes, typing indicators, and read receipts

Email

  • GET /api/email/threads — list threads
  • GET /api/email/messages/:id — get a message
  • POST /api/email/compose — send / reply / forward
  • PUT /api/email/threads/:id — read/star/archive/ delete actions
  • POST /api/email/labels, signatures — full read/write

Reminders

  • GET /api/reminders — list
  • POST /api/reminders — create
  • PUT /api/reminders/:id — update
  • DELETE /api/reminders/:id — delete

Bridges (read-only)

  • GET /api/bridges — list connected accounts
  • GET /api/bridges/configured — available platforms
  • GET /api/bridges/dashboard — health + connection status
  • GET /api/bridges/chat-counts — per-bridge sync progress

For the full schema (request/response shapes, error envelopes, date formats), parse /openapi.yaml with your tool of choice — Postman, Insomnia, Bruno, or any OpenAPI-compatible client.