ai-agents

ai-agents close-conversation

Close an AI agent conversation

Usage

pega ai-agents close-conversation <agentId> [flags]

Source endpoint: PUT /ai-agents/{agentID}/conversations/{conversationID}/close — view command source

Arguments

Argument	Required	Description
agentId	Yes	Agent 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

pega ai-agents close-conversation MYAGENT --conversation PXCONV-1

ai-agents dislike

Dislike a message in an AI agent conversation

Usage

pega ai-agents dislike <agentId> [flags]

Source endpoint: PUT /ai-agents/{agentID}/conversations/{conversationID}/messages/{messageID}/dislike — view command source

Arguments

Argument	Required	Description
agentId	Yes	Agent 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
--message	option	Yes		Message ID to dislike
--feedback	option	Yes		Free-text feedback (becomes feedbackText in body)

Examples

pega ai-agents dislike MYAGENT --conversation PXCONV-1 --message MSG-1 --feedback "off topic"

ai-agents get-conversation

Get details of a single AI agent conversation

Usage

pega ai-agents get-conversation <agentId> [flags]

Source endpoint: GET /ai-agents/{agentID}/conversations/{conversationID} — view command source

Arguments

Argument	Required	Description
agentId	Yes	Agent 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
--conversation	option	Yes		Conversation ID

Examples

pega ai-agents get-conversation MYAGENT --conversation PXCONV-503025

ai-agents like

Like a message in an AI agent conversation

Usage

pega ai-agents like <agentId> [flags]

Source endpoint: PUT /ai-agents/{agentID}/conversations/{conversationID}/messages/{messageID}/like — view command source

Arguments

Argument	Required	Description
agentId	Yes	Agent 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
--message	option	Yes		Message ID to like

Examples

pega ai-agents like MYAGENT --conversation PXCONV-1 --message MSG-1

ai-agents list

Fetch all AI agents enabled for external access

Usage

pega ai-agents list [flags]

Source endpoint: GET /ai-agents — view command source

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

Examples

pega ai-agents list

ai-agents list-conversations

List conversations for an AI agent

Usage

pega ai-agents list-conversations <agentId> [flags]

Source endpoint: GET /ai-agents/{agentID}/conversations — view command source

Arguments

Argument	Required	Description
agentId	Yes	Agent 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 context or landing-page context)
--page-size	option	No		Results per page
--page-index	option	No		Page index (0-based)

Examples

pega ai-agents list-conversations MYAGENT --context-id MYORG-MYAPP-WORK\!M-123

pega ai-agents list-conversations MYAGENT --context-id CTX --page-size 20 --page-index 0

ai-agents send-message

Send a message in an AI agent conversation

Usage

pega ai-agents send-message <agentId> [flags]

Source endpoint: PATCH /ai-agents/{agentID}/conversations/{conversationID} — view command source

Arguments

Argument	Required	Description
agentId	Yes	Agent 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
--conversation	option	Yes		Conversation ID
--request	option	Yes		User query text
--attachments	option	No		JSON array of attachment descriptors (inline JSON, @file, or - for stdin)
--active-channel	option	No		Channel type (Web, Email, Chat, ...)
--active-channel-id	option	No		Unique ID of the channel

Examples

pega ai-agents send-message MYAGENT --conversation PXCONV-1 --request "hello"

pega ai-agents send-message MYAGENT --conversation PXCONV-1 --request "with file" --attachments @attachments.json

ai-agents start-conversation

Start a new AI agent conversation

Usage

pega ai-agents start-conversation <agentId> [flags]

Source endpoint: POST /ai-agents/{agentID}/conversations — view command source

Arguments

Argument	Required	Description
agentId	Yes	Agent 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
--active-channel	option	No		Channel type (Web, Email, Chat, ...)
--active-channel-id	option	No		Unique ID of the channel

Examples

pega ai-agents start-conversation MYAGENT --context-id MYORG-WORK\!M-123

pega ai-agents start-conversation MYAGENT --no-execute-starter