API reference
16 endpointsAPI 0.5.1-rc.3OpenAPI 3.2.1
Download OpenAPI JSONBrowse endpoints by resource. Each page includes request fields, response shapes, and links to model definitions. For examples and native behavior, start with the API basics.
Base URL
http://127.0.0.1:8080
All endpoints use the /v1 prefix.
Authentication
relayToken
Authorization: Bearer <token>
Set your token in the relay configuration.
Conversations5 endpoints
Find conversations, mark them as read, and manage typing indicators.
- GETPage through conversations
/v1/conversations - GETRead one conversation
/v1/conversations/{conversation_id} - PUTMark a conversation as read
/v1/conversations/{conversation_id}/read - PUTStart or refresh a typing lease
/v1/conversations/{conversation_id}/typing - DELETEStop a typing lease
/v1/conversations/{conversation_id}/typing
Messages6 endpoints
Read and send messages, update reactions, and track send requests.
- GETPage through conversation messages
/v1/conversations/{conversation_id}/messages - POSTSubmit a message send
/v1/messages - GETRead one message
/v1/messages/{message_id} - PUTSet the local sender's reaction
/v1/messages/{message_id}/reaction - DELETEClear the local sender's reaction
/v1/messages/{message_id}/reaction - GETRead durable send request status
/v1/requests/{request_id}
Media2 endpoints
Upload files, inspect attachments, and download their bytes.
Events1 endpoints
Follow live changes and resume an event stream after a disconnect.
Status2 endpoints
Inspect the database, sender identity, and available capabilities.
Model schemas
Browse 55 definitions for request and response fields, allowed values, and nested objects.
Required fields must be present. Optional fields can be absent. Null is accepted only where the schema includes it.
Generated from Swift models and endpoint declarations. This reference does not send API requests.