Chats
Every operation in this group: what it accepts, what it returns and the errors it can answer with.
Operations
The conversations held with the assistant in the app, as the Chats page lists them. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
GET/chats
List the assistant chats
The chats of the workspace, newest first, a page at a time, each with its title, how many messages it holds and when it last changed. q searches the titles and sort orders them. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:read scope.
Query parameters
qstringSearch the titles.
Up to 200 characterssortstringnewestandoldestorder by the last change, andtitlealphabetically.One of"newest""oldest""title"Default"newest"limitintegerRows per page, 1 to 100.
At least 1At most 100Default25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
Returns
A page of chats.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/chats/{id}
Retrieve a chat
One chat by id. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:read scope.
Path parameters
idstringRequiredThe chat id from
GET /chats.
Returns
The chat.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
PATCH/chats/{id}
Rename a chat
Gives the chat a new title. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:write scope.
Path parameters
idstringRequiredThe chat id from
GET /chats.
Request body
titlestringRequired- 1 to 120 characters
Returns
The chat with its new title.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
DELETE/chats/{id}
Delete a chat
Deletes the chat and every message in it, for good. Nothing it did in the mailbox is undone. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:write scope.
Path parameters
idstringRequiredThe chat id from
GET /chats.
Returns
Deleted.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
Objects
Chatobject
objectstringRequired- One of
"chat" idstringRequiredtitlestringRequiredkindstringRequired- One of
"chat" messageCountintegerRequired- At least 0
updatedAtstringRequiredWhen a message last arrived in it.
Formatdate-time
ChatListobject
objectstring- One of
"list" dataChat[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringAn opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Can be null
DeletedChatobject
objectstring- One of
"chat" idstringdeletedboolean- One of
true