client.chats
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The conversations held with the assistant in the app: list and search them, read one, rename it and delete it. Only the workspace owner reaches them.
chats.list
List the assistant chats
list(q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::PageReturns one page of the conversations held with the assistant in the app, newest first, as its Chats page lists them, each with its title, how many messages it holds and when it last changed.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
qStringSearches the titles.
sortStringnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.limitIntegerPage size, from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorof the previous page. Leave it out for the first page.api_keyStringOverrides the client's API key for this call only.
Returns
An OpenEmail::Page of Hashes with items, has_more? and next_cursor. Each item has id, title, kind, messageCount and updatedAt.
Example
page = client.chats.list(q: "invoices") page.items.each { |chat| puts "#{chat[:title]} #{chat[:messageCount]}" }Notes
A cursor that names nothing in this list is 400
invalid_cursor.
Also available in
- API
GET /chats- TypeScript
chats.list()- Python
chats.list()- CLI
openemail chats list
chats.list_all
Collect every chat into one Array
list_all(q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Walks every page of list and returns every chat, in the order sort: names. One request per page, with the same filters on each.
Parameters
qStringSearches the titles.
sortStringnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.limitIntegerPage size for each request, from 1 to 100. The server defaults to 25.
cursorStringStarts the walk after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Array of Hashes holding every chat.
Example
chats = client.chats.list_all puts chats.lengthNotes
If any page fails, the error is raised and the rows already fetched are discarded.
Also available in
- API
GET /chats- TypeScript
chats.listAll()- Python
chats.list_all()
chats.iterate
Stream the chats one at a time
iterate(q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields one chat at a time, in the order sort: names, and requests the next page only once the current one is drained. Given a block, it yields each chat to the block instead. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.
Parameters
qStringSearches the titles.
sortStringnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.limitIntegerPage size for each request, from 1 to 100. The server defaults to 25.
cursorStringStarts the walk after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Enumerator of Hashes, one chat per step (or yields each one to a block).
Example
client.chats.iterate(sort: "title") { |chat| puts chat[:title] }Notes
Each page is one request, so a long walk makes many.
Also available in
- API
GET /chats- TypeScript
chats.iterate()- Python
chats.iterate()
chats.get
Retrieve a chat
get(id, api_key: nil) -> HashReturns one chat with the assistant by its id: its title, how many messages it holds and when it last changed.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
idStringRequiredThe chat id from
list.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with id, title, kind, messageCount and updatedAt.
Example
chat = client.chats.get("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65") puts chat[:title]Notes
An unknown id is a 404.
Also available in
- API
GET /chats/{id}- TypeScript
chats.get()- Python
chats.get()- CLI
openemail chats get
chats.rename
Rename a chat
rename(id, title, api_key: nil) -> HashGives a chat with the assistant a new title, up to 120 characters, and returns the chat as it is now.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
idStringRequiredThe chat id from
list.titleStringRequiredThe new title, from 1 to 120 characters.
api_keyStringOverrides the client's API key for this call only.
Returns
The same Hash as chats.get, with the new title.
Example
client.chats.rename("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices")Notes
An unknown id is a 404.
Also available in
- API
PATCH /chats/{id}- TypeScript
chats.rename()- Python
chats.rename()- CLI
openemail chats rename
chats.delete
Delete a chat
delete(id, api_key: nil) -> HashDeletes a chat with the assistant and every message in it, for good. Nothing the assistant did in the mailbox is undone.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
idStringRequiredThe chat id from
list.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to chat, the id and deleted set to true.
Example
client.chats.delete("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65")Notes
An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.
Also available in
- API
DELETE /chats/{id}- TypeScript
chats.delete()- Python
chats.delete()- CLI
openemail chats delete