Zur Dokumentation springen
CLI

openemail chats

Jeder Befehl in diesem Namespace, mit seinen Argumenten, Flags und Beispielen.

Befehle

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.

Jeder Befehl hier nimmt auch die globalen Flags an, etwa --json, --profile und --dry-run. Zu den globalen Flags

openemail chats list

List the assistant chats

Geltungsbereichethreads:readErfordert eine AnmeldungAliassels

Aufruf

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) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.

Standard"newest"
--limit <n>

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

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

Beispiele

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

Auch verfügbar über

API
GET /chats
SDK
chats.list()

openemail chats get

Retrieve a chat

Geltungsbereichethreads:readErfordert eine AnmeldungAliasseshowview

Aufruf

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.

Argumente

<id>Erforderlich

The chat id from list.

Beispiele

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

Auch verfügbar über

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

openemail chats rename

Rename a chat

Geltungsbereichethreads:writeErfordert eine Anmeldung

Aufruf

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.

Argumente

<id>Erforderlich

The chat id from list.

<title>Erforderlich

The new title, from 1 to 120 characters.

Beispiele

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

Auch verfügbar über

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

openemail chats delete

Delete a chat

Geltungsbereichethreads:writeErfordert eine Anmeldung
Fragt nach einer Bestätigung
Aliassermdelremove

Aufruf

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.

Argumente

<id>Erforderlich

The chat id from list.

Beispiele

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

Auch verfügbar über

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