openemail chats
Every command in this namespace, with its arguments, flags and examples.
Commands
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.
Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags
openemail chats list
List the assistant chats
lsUsage
openemail chats list [flags]
Resolves 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.
Add --all to walk every page: a table on a terminal, one JSON object per line when piped or with --ndjson, and one { items, hasMore, nextCursor } document with --json. --max <n> stops after that many items.
Flags
--q <value>Searches the titles.
--sort <value>newest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.Default"newest"--limit <n>Page size, from 1 to 100. The server defaults to 25.
Default25--cursor <value>The
nextCursorof the previous page. Leave it out for the first page.--allFetch every page and stream the items as they arrive.
--max <n>Stop after this many items. Implies
--all.--ndjsonPrint every item as one JSON object per line. Implies
--all
Examples
openemail chats listopenemail chats list --q invoicesopenemail chats list --all --max 100openemail chats list --all > chats.ndjsonAlso available in
- API
GET /chats- SDK
chats.list()
openemail chats get
Retrieve a chat
showviewUsage
openemail chats get <id> [flags]
Resolves 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.
Arguments
<id>RequiredThe chat id from
list.
Examples
openemail chats get 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65openemail chats get 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 --jsonAlso available in
openemail chats rename
Rename a chat
Usage
openemail chats rename <id> <title> [flags]
Gives a chat with the assistant a new title, up to 120 characters, and resolves with 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.
Arguments
<id>RequiredThe chat id from
list.<title>RequiredThe new title, from 1 to 120 characters.
Examples
openemail chats rename 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 'Quarterly invoices'openemail chats rename 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 'Quarterly invoices' --jsonAlso available in
openemail chats delete
Delete a chat
rmdelremoveUsage
openemail chats delete <id> [flags]
Deletes 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.
Arguments
<id>RequiredThe chat id from
list.
Examples
openemail chats delete 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65openemail chats delete 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 --yes