uipath-cli
latest
false
UiPath CLI user guide
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Attach, list, and remove memory spaces and memory items on a low-code agent with `uip agent memory`.
uip agent memory manages the memory-space features attached to an agent: a memory space is a retrieval-augmented recall source (episodic or escalation memory) the agent can search against at runtime. uip agent memory item manages individual key/value items seeded into a configured memory space.
Local-only — no login required.
Synopsis
uip agent memory add <name> --memory-space <name> --folder-path <path> [--reference-key <key>] [--description <desc>] [--threshold <n>] [--result-count <n>] [--search-mode <hybrid|semantic>] [--field <name=weight>]... [--disable-dynamic-few-shot] [--path <dir>]
uip agent memory list [--path <dir>]
uip agent memory remove <name> [--folder-path <path>] [--path <dir>]
uip agent memory item add <name> <key> <value> --memory-type <episodic|escalation> [--folder-path <path>] [--description <desc>] [--metadata <json>] [--path <dir>]
uip agent memory item list <name> [--folder-path <path>] [--path <dir>]
uip agent memory item remove <name> <key> [--folder-path <path>] [--path <dir>]
uip agent memory add <name> --memory-space <name> --folder-path <path> [--reference-key <key>] [--description <desc>] [--threshold <n>] [--result-count <n>] [--search-mode <hybrid|semantic>] [--field <name=weight>]... [--disable-dynamic-few-shot] [--path <dir>]
uip agent memory list [--path <dir>]
uip agent memory remove <name> [--folder-path <path>] [--path <dir>]
uip agent memory item add <name> <key> <value> --memory-type <episodic|escalation> [--folder-path <path>] [--description <desc>] [--metadata <json>] [--path <dir>]
uip agent memory item list <name> [--folder-path <path>] [--path <dir>]
uip agent memory item remove <name> <key> [--folder-path <path>] [--path <dir>]
All invocations honor the global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the standard contract.
uip agent memory add
Attach a memory space to the agent.
Arguments
<name>(required) — Feature name to use in the agent.
Options
| Flag | Default | Required | Purpose |
|---|---|---|---|
--memory-space <name> | — | yes | Memory space name to attach. |
--folder-path <path> | — | yes | Folder path where the memory space exists. |
--reference-key <key> | — | Memory space solution resource key. | |
--description <desc> | — | Memory space description. | |
--threshold <n> | 0 | Retrieval score threshold. | |
--result-count <n> | 3 | Number of results to retrieve (positive integer). | |
--search-mode <mode> | hybrid | hybrid or semantic. | |
--field <name=weight> | — | Input field weight. Repeatable. | |
--disable-dynamic-few-shot | off | Attach the memory space without enabling dynamic few-shot retrieval (enabled by default). | |
--path <path> | . | Path to the agent project directory. |
Example
uip agent memory add SupportRecall --memory-space customer-support-recall --folder-path Shared --path ./my-agent
uip agent memory add SupportRecall --memory-space customer-support-recall --folder-path Shared --path ./my-agent
Data shape (--output json)
{
"Code": "AgentMemoryAdd",
"Data": {
"Status": "Memory space added",
"Name": "SupportRecall",
"MemorySpace": "customer-support-recall",
"FolderPath": "Shared",
"DynamicFewShotEnabled": true,
"Id": "a1b2c3d4-0000-0000-0000-000000000070"
}
}
{
"Code": "AgentMemoryAdd",
"Data": {
"Status": "Memory space added",
"Name": "SupportRecall",
"MemorySpace": "customer-support-recall",
"FolderPath": "Shared",
"DynamicFewShotEnabled": true,
"Id": "a1b2c3d4-0000-0000-0000-000000000070"
}
}
uip agent memory list
Options
| Flag | Default | Purpose |
|---|---|---|
--path <path> | . | Path to the agent project directory. |
Example
uip agent memory list --path ./my-agent
uip agent memory list --path ./my-agent
Data shape (--output json)
{
"Code": "AgentMemoryList",
"Data": [
{ "Name": "SupportRecall", "MemorySpace": "customer-support-recall", "FolderPath": "Shared", "DynamicFewShotEnabled": true, "Id": "a1b2c3d4-0000-0000-0000-000000000070" }
]
}
{
"Code": "AgentMemoryList",
"Data": [
{ "Name": "SupportRecall", "MemorySpace": "customer-support-recall", "FolderPath": "Shared", "DynamicFewShotEnabled": true, "Id": "a1b2c3d4-0000-0000-0000-000000000070" }
]
}
uip agent memory remove
Arguments
<name>(required) — Feature name, memory space name, or ID to remove.
Options
| Flag | Purpose |
|---|---|
--folder-path <path> | Folder path, when removing by memory space name. |
--path <path> | Path to the agent project directory (default .). |
Example
uip agent memory remove SupportRecall --path ./my-agent
uip agent memory remove SupportRecall --path ./my-agent
Data shape (--output json)
{ "Code": "AgentMemoryRemove", "Data": { "Status": "Memory space removed", "Name": "SupportRecall" } }
{ "Code": "AgentMemoryRemove", "Data": { "Status": "Memory space removed", "Name": "SupportRecall" } }
A memory space not found by name/ID fails the command with a non-zero exit code.
uip agent memory item add
Add a memory item to a configured memory space.
Arguments
| Name | Required | Purpose |
|---|---|---|
<name> | yes | Feature name, memory space name, or ID. |
<key> | yes | Memory item key. |
<value> | yes | Memory item value. |
Options
| Flag | Required | Purpose |
|---|---|---|
--folder-path <path> | Folder path, when selecting by memory space name. | |
--memory-type <type> | yes | episodic (0) or escalation (1) — numeric values 0/1 also accepted. |
--description <desc> | Memory item description. | |
--metadata <json> | Memory item metadata as a JSON object. | |
--path <path> | Path to the agent project directory (default .). |
Examples
uip agent memory item add SupportRecall customer-tier gold --memory-type episodic --metadata '{"source":"seed"}' --path ./my-agent
uip agent memory item add SupportRecall escalation-case pending --memory-type escalation --path ./my-agent
uip agent memory item add SupportRecall customer-tier gold --memory-type episodic --metadata '{"source":"seed"}' --path ./my-agent
uip agent memory item add SupportRecall escalation-case pending --memory-type escalation --path ./my-agent
Data shape (--output json)
{
"Code": "AgentMemoryItemAdd",
"Data": { "Status": "Memory item added", "Memory": "SupportRecall", "Key": "customer-tier", "MemoryType": 0, "Id": "a1b2c3d4-0000-0000-0000-000000000080" }
}
{
"Code": "AgentMemoryItemAdd",
"Data": { "Status": "Memory item added", "Memory": "SupportRecall", "Key": "customer-tier", "MemoryType": 0, "Id": "a1b2c3d4-0000-0000-0000-000000000080" }
}
uip agent memory item list
Arguments
<name>(required) — Feature name, memory space name, or ID.
Options
| Flag | Purpose |
|---|---|
--folder-path <path> | Folder path, when selecting by memory space name. |
--path <path> | Path to the agent project directory (default .). |
Example
uip agent memory item list SupportRecall --path ./my-agent
uip agent memory item list SupportRecall --path ./my-agent
Data shape (--output json)
{
"Code": "AgentMemoryItemList",
"Data": [
{ "Key": "customer-tier", "Value": "gold", "MemoryType": 0, "Description": null, "Metadata": { "source": "seed" }, "Id": "a1b2c3d4-0000-0000-0000-000000000080" }
]
}
{
"Code": "AgentMemoryItemList",
"Data": [
{ "Key": "customer-tier", "Value": "gold", "MemoryType": 0, "Description": null, "Metadata": { "source": "seed" }, "Id": "a1b2c3d4-0000-0000-0000-000000000080" }
]
}
uip agent memory item remove
Arguments
| Name | Required | Purpose |
|---|---|---|
<name> | yes | Feature name, memory space name, or ID. |
<key> | yes | Memory item key or ID to remove. |
Options
| Flag | Purpose |
|---|---|
--folder-path <path> | Folder path, when selecting by memory space name. |
--path <path> | Path to the agent project directory (default .). |
Example
uip agent memory item remove SupportRecall customer-tier --path ./my-agent
uip agent memory item remove SupportRecall customer-tier --path ./my-agent
Data shape (--output json)
{ "Code": "AgentMemoryItemRemove", "Data": { "Status": "Memory item removed", "Memory": "SupportRecall", "Key": "customer-tier" } }
{ "Code": "AgentMemoryItemRemove", "Data": { "Status": "Memory item removed", "Memory": "SupportRecall", "Key": "customer-tier" } }
Related
uip agent validate— re-run after editing memory configuration.uip agent refresh— regenerates derived files after a memory space is added.
See also
- Synopsis
- uip agent memory add
- Arguments
- Options
- Example
- Data shape (--output json)
- uip agent memory list
- Options
- Example
- Data shape (--output json)
- uip agent memory remove
- Arguments
- Options
- Example
- Data shape (--output json)
- uip agent memory item add
- Arguments
- Options
- Examples
- Data shape (--output json)
- uip agent memory item list
- Arguments
- Options
- Example
- Data shape (--output json)
- uip agent memory item remove
- Arguments
- Options
- Example
- Data shape (--output json)
- Related
- See also