uip conversational

Syntax and options for `uip conversational`, which chats with deployed UiPath conversational agents and manages the conversations that result — chat, agents, and conversations.

uip conversational interacts with deployed conversational agents — Orchestrator-deployed processes exposed as a chat interface, built on the UiPath conversational-agent runtime. This page covers discovering agent releases (agents), starting/managing the conversations you have with them (conversations), and chatting in real time (chat). For conversation history, feedback, voice-channel routing, and profile settings, see Conversational: exchanges, messages, trunks & user-settings.

Conceitos

• Agent release — a deployed Orchestrator process release that has conversational capability enabled, identified by a release ID plus the folder it lives in. Discover releases with agents list.
• Conversation — a persistent session against one agent release, created with conversations create, identified by a UUID. All chat activity happens inside a conversation.
• Chat vs. conversations — conversations create/list/get manage the conversation record itself (metadata, label, agent input); chat is the live, real-time interaction with an existing conversation — you create a conversation first, then chat into it.
• --agent-input on conversations create/update is a JSON string that seeds or updates the agent's initial input for the conversation; it's wrapped as { inline: <parsed JSON> } before being sent.

Resumo

uip conversational chat <conversation-id> [-m, --message <text>]
uip conversational agents list [--folder-id <id>]
uip conversational agents get --release-id <id> --folder-id <id>
uip conversational conversations create --release-id <id> --folder-id <id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations list [--limit <n>] [--sort-order <order>] [--cursor <token>] [--agent-id <id>] [--agent-key <guid>] [--label <substring>]
uip conversational conversations get <conversation-id>
uip conversational conversations update <conversation-id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations delete <conversation-id> -y
uip conversational conversations attachments upload <conversation-id> --file <path>
uip conversational conversations attachments get-uri <conversation-id> --file-name <name>

uip conversational chat

Interact with an existing conversation in real time — either a single-shot message (--message) or an interactive REPL (omit --message).

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	Conversation UUID (from conversations create/list).

Opções

Long	Valor	Description
-m, --message <text>	String	Send a single message and exit after the exchange completes (non-interactive). Omit to start the interactive REPL instead.

Without --message, chat requires a prompt-capable terminal — it fails fast in a non-interactive environment (CI, piped output) with instructions to use --message instead. In the REPL, type /exit or /quit to end the session, or press Ctrl+C. Assistant responses stream to stdout token-by-token; inline citation markers ([1], [2], ...) render as the response streams, and a --- Citations --- footnote block with titles/URLs prints after each exchange completes, deduplicated across the session.

Exemplos

# Single-shot message
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001 --message "What's the status of order 4471?"

# Interactive REPL
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001

This command streams human-readable text to stdout rather than emitting the CLI's usual --output json envelope — it's designed for interactive use, not scripting. A start-up or mid-session error is still reported through the standard OutputFormatter.error envelope before the process exits non-zero.

uip conversational agents

Inspect conversational agent releases.

uip conversational agents list

Opções

Long	Valor	Description
--folder-id <id>	positive integer	Filter conversational agents by folder.

Exemplo

uip conversational agents list --folder-id 123456

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationalAgentList",
  "Data": [
    {
      "id": 42,
      "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
      "name": "Support Assistant",
      "description": "Handles tier-1 support conversations",
      "processVersion": "1.0.0",
      "processKey": "SupportAssistant",
      "folderId": 123456,
      "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
      "createdTime": "2026-08-01T10:00:00Z"
    }
  ]
}

Keys are kept in native camelCase (preserveDataKeys: true), not PascalCased.

uip conversational agents get

Opções

Long	Valor	Required	Description
--release-id <id>	positive integer	sim	Agent release ID.
--folder-id <id>	positive integer	sim	Folder ID containing the agent.

Exemplo

uip conversational agents get --release-id 42 --folder-id 123456

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationalAgent",
  "Data": {
    "id": 42,
    "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "name": "Support Assistant",
    "description": "Handles tier-1 support conversations",
    "processVersion": "1.0.0",
    "processKey": "SupportAssistant",
    "folderId": 123456,
    "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
    "createdTime": "2026-08-01T10:00:00Z",
    "appearance": { "...": "agent chat-widget appearance config" }
  }
}

appearance is the one field get returns beyond what list already shows.

uip conversational conversations

Create, list, inspect, update, and delete conversations, plus manage their file attachments.

uip conversational conversations create

Opções

Long	Valor	Required	Description
--release-id <id>	positive integer	sim	ID of a conversational-enabled release.
--folder-id <id>	positive integer	sim	Folder ID containing the release.
--label <label>	String	não	Conversation label.
--autogenerate-label	Bandeira	não	Enable label autogeneration after exchanges occur.
--no-autogenerate-label	Bandeira	não	Disable label autogeneration.
--agent-input <json>	JSON string	não	Initial input for the agent — parsed and wrapped as { inline: <value> }. Fails fast on invalid JSON.

Exemplo

uip conversational conversations create --release-id 42 --folder-id 123456 --label "Order 4471"

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationCreated",
  "Data": {
    "id": "b2c3d4e5-0000-0000-0000-000000000001",
    "label": "Order 4471",
    "autogenerateLabel": false,
    "agentId": 42,
    "folderId": 123456,
    "agentInput": { "inline": {} },
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "spanId": "e5f6a7b8",
    "createdTime": "2026-08-01T10:00:00Z",
    "lastActivityTime": "2026-08-01T10:00:00Z"
  }
}

uip conversational conversations list

Opções

Long	Valor	Description
--limit <number>	positive integer	Conversations per page.
--sort-order <order>	ascending|descending	Sort order.
--cursor <token>	String	Pagination cursor for the next page.
--agent-id <id>	positive integer	Filter by agent release ID.
--agent-key <guid>	String	Filter by agent release key.
--label <substring>	String	Filter by label substring, case-insensitive, 1-100 chars.

Exemplo

uip conversational conversations list --agent-id 42 --limit 20

Formato dos dados (--output json)

{
  "Result": "Success",
  "Code": "ConversationList",
  "Data": {
    "items": [{ "id": "b2c3d4e5-0000-0000-0000-000000000001", "label": "Order 4471" }],
    "nextCursor": null
  }
}

uip conversational conversations get

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	Conversation UUID.

Exemplo

uip conversational conversations get b2c3d4e5-0000-0000-0000-000000000001

Formato dos dados (--output json)

Same shape as create's response, Code: "Conversation".

uip conversational conversations update

At least one option is required — omitting all four fails client-side before any network call.

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	Conversation UUID.

Opções

Long	Valor	Description
--label <label>	String	New conversation label.
--autogenerate-label	Bandeira	Enable label autogeneration.
--no-autogenerate-label	Bandeira	Disable label autogeneration.
--agent-input <json>	JSON string	Updated agent input — replaces the whole value, wrapped as { inline: <value> }.

Exemplo

uip conversational conversations update b2c3d4e5-0000-0000-0000-000000000001 --label "Order 4471 (resolved)"

Formato dos dados (--output json)

Same shape as create's response, Code: "ConversationUpdated".

uip conversational conversations delete

Destructive — requires -y/--yes; the CLI never prompts.

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	Conversation UUID.

Opções

Long	Description
-y, --yes	Confirm this irreversible operation. Required — omitting it fails before any network call.

Exemplo

uip conversational conversations delete b2c3d4e5-0000-0000-0000-000000000001 -y

Formato dos dados (--output json)

Same shape as create's response, Code: "ConversationDeleted" — the deleted conversation's last known state.

uip conversational conversations attachments upload

Upload a local file as a conversation attachment.

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	Conversation UUID.

Opções

Long	Valor	Required	Description
--file <path>	Path	sim	Path to the local file to upload.

Exemplo

uip conversational conversations attachments upload b2c3d4e5-0000-0000-0000-000000000001 --file ./invoice.pdf

Formato dos dados (--output json)

{ "Result": "Success", "Code": "AttachmentUploaded", "Data": { "...": "raw upload result from the conversational-agent SDK" } }

uip conversational conversations attachments get-uri

Get a pre-signed upload URI for an attachment, without uploading a local file (for out-of-band uploads).

Argumentos

Name	Required	Finalidade
<conversation-id>	sim	Conversation UUID.

Opções

Long	Valor	Required	Description
--file-name <name>	String	sim	Name of the file the URI will accept.

Exemplo

uip conversational conversations attachments get-uri b2c3d4e5-0000-0000-0000-000000000001 --file-name invoice.pdf

Formato dos dados (--output json)

{ "Result": "Success", "Code": "AttachmentUri", "Data": { "...": "pre-signed URI payload" } }

Relacionado

• Conversational: exchanges, messages, trunks & user-settings — conversation history, feedback, voice-channel routing, and profile settings.

Veja também

• Opções globais
• Códigos de saída