문서로 건너뛰기
CLI

openemail chats

이 네임스페이스의 모든 명령과 그 인수, 플래그, 예시.

명령

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.

여기 있는 모든 명령은 --json, --profile, --dry-run 같은 전역 플래그도 받습니다. 전역 플래그 보기

openemail chats list

List the assistant chats

범위threads:read로그인 필요별칭ls

사용법

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.

플래그

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

기본값"newest"
--limit <n>

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

기본값25
--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

예시

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

다른 사용처

API
GET /chats
SDK
chats.list()

openemail chats get

Retrieve a chat

범위threads:read로그인 필요별칭showview

사용법

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.

인수

<id>필수

The chat id from list.

예시

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

다른 사용처

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

openemail chats rename

Rename a chat

범위threads:write로그인 필요

사용법

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.

인수

<id>필수

The chat id from list.

<title>필수

The new title, from 1 to 120 characters.

예시

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

다른 사용처

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

openemail chats delete

Delete a chat

범위threads:write로그인 필요
확인을 요청합니다
별칭rmdelremove

사용법

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.

인수

<id>필수

The chat id from list.

예시

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

다른 사용처

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