Aller à la documentation
CLI

openemail chats

Chaque commande de cet espace de noms, avec ses arguments, ses options et ses exemples.

Commandes

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.

Chaque commande ici accepte aussi les options globales, comme --json, --profile et --dry-run. Voir les options globales

openemail chats list

List the assistant chats

Portéesthreads:readNécessite une connexionAliasls

Utilisation

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.

Options

--q <value>

Searches the titles.

--sort <value>

newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.

Par défaut"newest"
--limit <n>

Page size, from 1 to 100. The server defaults to 25.

Par défaut25
--cursor <value>

The nextCursor of the previous page. Leave it out for the first page.

--all

Fetch every page and stream the items as they arrive.

--max <n>

Stop after this many items. Implies --all.

--ndjson

Print every item as one JSON object per line. Implies --all

Exemples

openemail chats list
With optional flags
openemail chats list --q invoices
Walk every page and stop after 100 items
openemail chats list --all --max 100
One JSON object per line when piped
openemail chats list --all > chats.ndjson

Aussi disponible dans

API
GET /chats
SDK
chats.list()

openemail chats get

Retrieve a chat

Portéesthreads:readNécessite une connexionAliasshowview

Utilisation

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>Obligatoire

The chat id from list.

Exemples

openemail chats get 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65
Print the raw JSON
openemail chats get 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 --json

Aussi disponible dans

API
GET /chats/{id}
SDK
chats.get()

openemail chats rename

Rename a chat

Portéesthreads:writeNécessite une connexion

Utilisation

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>Obligatoire

The chat id from list.

<title>Obligatoire

The new title, from 1 to 120 characters.

Exemples

openemail chats rename 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 'Quarterly invoices'
Print the raw JSON
openemail chats rename 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 'Quarterly invoices' --json

Aussi disponible dans

API
PATCH /chats/{id}
SDK
chats.rename()

openemail chats delete

Delete a chat

Portéesthreads:writeNécessite une connexion
Vous demande de confirmer
Aliasrmdelremove

Utilisation

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>Obligatoire

The chat id from list.

Exemples

openemail chats delete 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65
Skip the confirmation, for scripts
openemail chats delete 8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65 --yes

Aussi disponible dans

API
DELETE /chats/{id}
SDK
chats.delete()