Java

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

threads:readPages through results

Signature

Page list(RequestOptions options)

Returns 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

options.qString: Searches the titles.
options.sortString: newest (the default) or oldest by the last change, or title, as in uk.openemail.constants.ChatSorts. A cursor carries on in the order it was handed out in.
options.limitint: Page size, from 1 to 100. The server defaults to 25.
options.cursorString: The nextCursor of the previous page. Leave it out for the first page.
options.apiKeyString: Overrides the client's API key for this call only.

Returns

A Page of maps with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.

Example

Page page = client.chats().list(RequestOptions.of("q", "invoices")); for (Map<String, Object> chat : page) {    System.out.println(chat.get("title") + " " + chat.get("messageCount"));} if (page.hasMore()) {    System.out.println("Next page: " + page.nextCursor());}

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()
Ruby: chats.list
PHP: chats->list
Go: Chats.List
C#: Chats.ListAsync
CLI: openemail chats list

`chats().listAll`

Collect every chat into one list

threads:readPages through results

Signature

List<Map<String, Object>> listAll(RequestOptions options)

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

options.qString: Searches the titles.
options.sortString: newest (the default) or oldest by the last change, or title, as in uk.openemail.constants.ChatSorts. A cursor carries on in the order it was handed out in.
options.limitint: Page size for each request, from 1 to 100. The server defaults to 25.
options.cursorString: Starts the walk after this cursor instead of the first page.
options.apiKeyString: Overrides the client API key for every page of this walk.

Returns

A list of maps holding every chat.

Example

List<Map<String, Object>> chats = client.chats().listAll(); for (Map<String, Object> all : chats) {    System.out.println(all.get("id") + " " + all.get("title"));}

Notes

If any page fails the call throws and the rows already fetched are discarded.

Also available in

API: GET /chats
TypeScript: chats.listAll()
Python: chats.list_all()
Ruby: chats.list_all
PHP: chats->listAll
Go: Chats.ListAll
C#: Chats.ListAllAsync

`chats().iterate`

Stream the chats one at a time

threads:readPages through results

Signature

PagedIterable iterate(RequestOptions options)

Returns a PagedIterable that yields one chat at a time, in the order sort names, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.

Parameters

options.qString: Searches the titles.
options.sortString: newest (the default) or oldest by the last change, or title, as in uk.openemail.constants.ChatSorts. A cursor carries on in the order it was handed out in.
options.limitint: Page size for each request, from 1 to 100. The server defaults to 25.
options.cursorString: Starts the walk after this cursor instead of the first page.
options.apiKeyString: Overrides the client API key for every page of this walk.

Returns

A PagedIterable that yields one chat map per step.

Example

for (Map<String, Object> chat : client.chats().iterate(RequestOptions.of("sort", "title"))) {    System.out.println(chat.get("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()
Ruby: chats.iterate
PHP: chats->iterate
Go: Chats.Iterate
C#: Chats.IterateAsync

`chats().get`

Retrieve a chat

threads:read

Signature

Map<String, Object> get(String id, RequestOptions options)

Returns one chat with the assistant by its id: its title, how many messages it holds and when it last changed.

Parameters

idStringRequired: The chat id from list.
options.apiKeyString: Overrides the client's API key for this call only.

Returns

A map with id, title, kind, messageCount and updatedAt.

Example

Map<String, Object> chat = client.chats().get("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65"); System.out.println(chat.get("title"));

Notes

An unknown id is a 404.

Also available in

API: GET /chats/{id}
TypeScript: chats.get()
Python: chats.get()
Ruby: chats.get
PHP: chats->get
Go: Chats.Get
C#: Chats.GetAsync
CLI: openemail chats get

`chats().rename`

Rename a chat

threads:write

Signature

Map<String, Object> rename(String id, String title, RequestOptions options)

Gives a chat with the assistant a new title, up to 120 characters, and returns the chat as it is now.

Parameters

idStringRequired: The chat id from list.
titleStringRequired: The new title, from 1 to 120 characters.
options.apiKeyString: Overrides the client's API key for this call only.

Returns

The same map as chats().get, with the new title.

Example

Map<String, Object> result = client.chats().rename("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices"); System.out.println(result.get("id") + " " + result.get("title"));

Notes

An unknown id is a 404.

Also available in

API: PATCH /chats/{id}
TypeScript: chats.rename()
Python: chats.rename()
Ruby: chats.rename
PHP: chats->rename
Go: Chats.Rename
C#: Chats.RenameAsync
CLI: openemail chats rename

`chats().delete`

Delete a chat

threads:write

Signature

Map<String, Object> delete(String id, RequestOptions options)

Deletes a chat with the assistant and every message in it, for good. Nothing the assistant did in the mailbox is undone.

Parameters

idStringRequired: The chat id from list.
options.apiKeyString: Overrides the client's API key for this call only.

Returns

A map with object set to chat, the id and deleted set to true.

Example

Map<String, Object> result = client.chats().delete("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65"); System.out.println(result.get("id"));

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()
Ruby: chats.delete
PHP: chats->delete
Go: Chats.Delete
C#: Chats.DeleteAsync
CLI: openemail chats delete

client.chats()

Methods

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.