Assistant chats
The conversations held with the assistant in the app.
Assistant chats tools
| Tool | What it does |
|---|---|
| listChats | The chats held with the assistant in the app, newest first, with their titles and how many messages each holds. query searches the titles. Returned a page at a time. |
| getChat | One chat by its id. |
| renameChat | Give a chat a new title. |
| deleteChat | Delete a chat and every message in it, for good. Nothing the assistant did in the mailbox is undone. |
Each person reaches only their own chats, through a client connected with every address. Reading needs threads:read and changing needs threads:write.
The assistant in the app does not have these tools, so a chat never renames or deletes itself.
Reference
listChats
The conversations held with the assistant in the Nextmail app, as its Chats page lists them, newest first, each with its title, id and how many messages it holds. query searches the titles. Each person reaches only their own chats. One page at a time: when more follow, the last line gives a cursor to pass back for the next page.
Inputs
querystring- Up to 200 characters
sortstring- One of
"newest""oldest""title" limitinteger- At least 1At most 100
cursorstring- 1 to 2048 characters
Also available in
- API
GET /chats- TypeScript
nextmail.chats.list()nextmail.chats.listAll()nextmail.chats.iterate()- Python
chats.list()chats.list_all()chats.iterate()- Ruby
chats.listchats.list_allchats.iterate- PHP
chats->listchats->listAllchats->iterate- Go
Chats.ListChats.ListAllChats.Iterate- Java
chats().listchats().listAllchats().iterate- C#
Chats.ListAsyncChats.ListAllAsyncChats.IterateAsync
getChat
One chat with the assistant by its id: its title, how many messages it holds and when it last changed.
Inputs
idstringRequired- Not empty
Also available in
- API
GET /chats/{id}- TypeScript
nextmail.chats.get()- Python
chats.get()- Ruby
chats.get- PHP
chats->get- Go
Chats.Get- Java
chats().get- C#
Chats.GetAsync
renameChat
Give a chat with the assistant a new title.
Inputs
idstringRequired- Not empty
titlestringRequired- 1 to 120 characters
Also available in
- API
PATCH /chats/{id}- TypeScript
nextmail.chats.rename()- Python
chats.rename()- Ruby
chats.rename- PHP
chats->rename- Go
Chats.Rename- Java
chats().rename- C#
Chats.RenameAsync
deleteChat
Delete a chat with the assistant and every message in it, for good. Nothing it did in the mailbox is undone. Ask the person first.
Inputs
idstringRequired- Not empty
Also available in
- API
DELETE /chats/{id}- TypeScript
nextmail.chats.delete()- Python
chats.delete()- Ruby
chats.delete- PHP
chats->delete- Go
Chats.Delete- Java
chats().delete- C#
Chats.DeleteAsync