assistants
assistants close-conversation
Close a GenAI assistant conversation
Usage
bash
pega assistants close-conversation <assistantId> [flags]Source endpoint: PUT /assistants/{assistantID}/conversations/{conversationID}/close — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
assistantId | Yes | Assistant rule ID |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
--conversation | option | Yes | Conversation ID |
Examples
sh
pega assistants close-conversation MYASSISTANT --conversation PXCONV-1assistants get-conversation
Get details of a single GenAI assistant conversation
Usage
bash
pega assistants get-conversation <assistantId> [flags]Source endpoint: GET /assistants/{assistantID}/conversations/{conversationID} — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
assistantId | Yes | Assistant rule ID |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
--conversation | option | Yes | Conversation ID |
Examples
sh
pega assistants get-conversation MYASSISTANT --conversation PXCONV-503025assistants list-conversations
List conversations for a GenAI assistant
Usage
bash
pega assistants list-conversations <assistantId> [flags]Source endpoint: GET /assistants/{assistantID}/conversations — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
assistantId | Yes | Assistant rule ID (pxInsName) |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
--context-id | option | Yes | Context ID (case or landing-page context) | |
--page-size | option | No | Results per page | |
--page-index | option | No | Page index (0-based) |
Examples
sh
pega assistants list-conversations MYASSISTANT --context-id MYORG-WORK\!M-123sh
pega assistants list-conversations MYASSISTANT --context-id CTX --page-size 20 --page-index 0assistants send-message
Send a message in a GenAI assistant conversation
Usage
bash
pega assistants send-message <assistantId> [flags]Source endpoint: PATCH /assistants/{assistantID}/conversations/{conversationID} — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
assistantId | Yes | Assistant rule ID |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
--conversation | option | Yes | Conversation ID | |
--request | option | Yes | User query text |
Examples
sh
pega assistants send-message MYASSISTANT --conversation PXCONV-1 --request "hello"assistants start-conversation
Start a new GenAI assistant conversation
Usage
bash
pega assistants start-conversation <assistantId> [flags]Source endpoint: POST /assistants/{assistantID}/conversations — view command source
Arguments
| Argument | Required | Description |
|---|---|---|
assistantId | Yes | Assistant rule ID (pxInsName) |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--format | option | No | json | Output format (json, compact, yaml, table) |
--fields | option | No | Comma-separated top-level fields to include in output | |
--dry-run | boolean | No | Print HTTP request details and exit without executing | |
--quiet | boolean | No | Suppress all stderr progress/warning output | |
--verbose | boolean | No | Emit full HTTP request/response details to stderr | |
--no-cache | boolean | No | Bypass token file cache; perform fresh OAuth exchange | |
--profile | option | No | default | Named config profile |
--context-id | option | No | Context ID (case or landing-page context) | |
--interaction-id | option | No | Unique ID for external-app interactions | |
--execute-starter | boolean | No | Whether to execute the configured starter question on initiation |
Examples
sh
pega assistants start-conversation MYASSISTANT --context-id MYORG-WORK\!M-123sh
pega assistants start-conversation MYASSISTANT --no-execute-starter