chat

13 endpoints at a glance

Method	Path	Summary
DELETE	/chat/attachments/{attachment_id}	Delete Attachment
GET	/chat/attachments/{attachment_id}/download	Download Attachment
GET	/chat/conversations	List Conversations
POST	/chat/conversations	Create Conversation
GET	/chat/conversations/{conv_id}	Get Conversation
POST	/chat/conversations/{conv_id}/attachments	Upload Attachment
POST	/chat/conversations/{conv_id}/leave	Leave Conversation
GET	/chat/conversations/{conv_id}/messages	List Messages
POST	/chat/conversations/{conv_id}/messages	Send Message
POST	/chat/conversations/{conv_id}/read	Mark Read
DELETE	/chat/messages/{msg_id}	Delete Message
PATCH	/chat/messages/{msg_id}	Edit Message
GET	/chat/unread-count	Unread Count

chat

---

List Conversations

GET

/chat/conversations

The viewer's conversations, newest-active first, with an unread flag.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/chat/conversations

Playground

Headers

authorization

Samples

---

Create Conversation

POST

/chat/conversations

Open a DM (1 other user, deduped) or create a group (N others).

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"participants": [

  

  

"string"

  

],

  

"title": ""

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/chat/conversations

Playground

Headers

authorization

Body

Samples

---

Get Conversation

GET

/chat/conversations/{conv_id}

Parameters

Header Parameters

authorization

Path Parameters

conv_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/chat/conversations/{conv_id}

Playground

Headers

authorization

Variables

Key

Value

conv_id*

Samples

---

Mark Read

POST

/chat/conversations/{conv_id}/read

Parameters

Header Parameters

authorization

Path Parameters

conv_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/chat/conversations/{conv_id}/read

Playground

Headers

authorization

Variables

Key

Value

conv_id*

Samples

---

Leave Conversation

POST

/chat/conversations/{conv_id}/leave

Leave a conversation. If it becomes empty, it's destroyed and its
messages, read cursors, and attachments are cascaded away.

Parameters

Header Parameters

authorization

Path Parameters

conv_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/chat/conversations/{conv_id}/leave

Playground

Headers

authorization

Variables

Key

Value

conv_id*

Samples

---

Unread Count

GET

/chat/unread-count

Number of conversations with unread messages (the nav badge).

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/chat/unread-count

Playground

Headers

authorization

Samples

---

List Messages

GET

/chat/conversations/{conv_id}/messages

Cursor window of messages as a diff.

• before → older history (scroll-up); new carries the older page,
  has_more reports whether yet-older messages exist.
• after → live incremental poll; new carries messages newer than
  the cursor and since (if given) yields the changed set (edits +
  tombstones) so already-rendered bubbles can be patched.
• neither → initial load; new is the latest page, has_more reports
  whether older history exists.

Parameters

Header Parameters

authorization

Path Parameters

conv_id*

Type

string

Required

Query Parameters

after

before

since

limit

Type

integer

Default

50

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/chat/conversations/{conv_id}/messages

Playground

Headers

authorization

Variables

Key

Value

conv_id*

after

before

since

limit

Samples

---

Send Message

POST

/chat/conversations/{conv_id}/messages

Parameters

Header Parameters

authorization

Path Parameters

conv_id*

Type

string

Required

Request Body

application/json

{

  

"body_md": "",

  

"attachments": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/chat/conversations/{conv_id}/messages

Playground

Headers

authorization

Variables

Key

Value

conv_id*

Body

Samples

---

Delete Message

DELETE

/chat/messages/{msg_id}

Parameters

Header Parameters

authorization

Path Parameters

msg_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/chat/messages/{msg_id}

Playground

Headers

authorization

Variables

Key

Value

msg_id*

Samples

---

Edit Message

PATCH

/chat/messages/{msg_id}

Parameters

Header Parameters

authorization

Path Parameters

msg_id*

Type

string

Required

Request Body

application/json

{

  

"body_md": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/chat/messages/{msg_id}

Playground

Headers

authorization

Variables

Key

Value

msg_id*

Body

Samples

---

Upload Attachment

POST

/chat/conversations/{conv_id}/attachments

Parameters

Header Parameters

authorization

Path Parameters

conv_id*

Type

string

Required

Request Body

multipart/form-data

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/chat/conversations/{conv_id}/attachments

Playground

Headers

authorization

Variables

Key

Value

conv_id*

Body

Samples

---

Download Attachment

GET

/chat/attachments/{attachment_id}/download

Parameters

Header Parameters

authorization

Path Parameters

attachment_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

[

]

GET

/chat/attachments/{attachment_id}/download

Playground

Headers

authorization

Variables

Key

Value

attachment_id*

Samples

---

Delete Attachment

DELETE

/chat/attachments/{attachment_id}

Remove a chat attachment (uploader-only) — e.g. an uploaded file the
user decides not to send.

Parameters

Header Parameters

authorization

Path Parameters

attachment_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/chat/attachments/{attachment_id}

Playground

Headers

authorization

Variables

Key

Value

attachment_id*

Samples

---