Skip to main content
View source

xTrace Memory

View as Markdown

A RocketRide tool node that gives an agent persistent, shared xTrace memory. Pick it when agents need cross-session context for a user or group, rather than the run-scoped memory used internally by an agent.

About xTrace Memory

xTrace Memory is a service for storing conversation-derived memory and retrieving relevant context later. It is designed to let separate agents share an organization- or group-scoped memory pool.

What it does

The node has no data lanes and exposes explicit store and recall operations. remember ingests conversation turns and returns the ingest-job state; recall searches the configured scope and can return a ready-to-inject context block. Unlike a run-scoped scratchpad, this store is not cleared when a session opens, so agents pointing at the same scope can use the same memories.

As a tool

The prefix defaults to xtrace.

FunctionDescription
xtrace.rememberIngest conversation turns into shared persistent memory.
xtrace.recallSearch memory for context relevant to a required query.

remember accepts either messages (preferred: objects with role and content) or one content value, plus optional user_id and conv_id. It returns success, status, job_id, memories_created, and error; missing content or user scope returns a failed result. recall accepts query, optional user_id, group_ids, mode, and limit, and returns context, ranked results, count, and error. A recall with no user, group, agent, or app scope returns an error instead of searching the entire organization.

Configuration

Set the API key and organization ID first. The remaining defaults work for a basic per-user memory; use the advanced controls only when you need intentional sharing, a narrower scope, or different ingest and recall behavior.

User id and Group ids (shared memory)

A configured user ID supplies the default owner for both tools. Group IDs are a comma-separated shared scope; use them only when memories should be visible across users or agents. A call can override these values, so keep the configured scope narrow when the same node serves different requests.

Ingest behavior

Synchronous ingest is on by default, so remember waits for extraction to reach a terminal state or the configured 30-second timeout. Turn it off only when the caller can tolerate a pending job. Artifact extraction is off by default; enable it only when that extra extraction is necessary.

Recall behavior

compose is the default recall mode and returns an injected-context block as well as ranked rows. Use retrieve when the caller needs only the ranked records. The recall limit defaults to 10 and is clamped from 1 to 100; increase it only when the agent can make use of the additional context.

Agent and App scope

Optional agent and app IDs are attached at ingest and both narrow recall. Use them to partition one organization memory pool; both values participate in the recall scope.

Authentication

Set api_key and org_id. Requests carry them in the x-api-key and X-Org-Id headers. Failed HTTP requests are returned to the tool as failed result objects; idempotent retrieval retries rate limits, server errors, and timeouts, while ingestion avoids ambiguous retries that could duplicate memory.

Upstream docs

Schema

FieldTypeDescriptionDefault
xtrace_memory.agent_idstringAgent id
Optional agent scope stamped on ingested memories and AND-narrowed on recall.
""
xtrace_memory.api_keystringAPI Key
xTrace API key (xtk_...). Get it from the Developer Portal: app.xtrace.ai → Settings → API Keys (not in mem.xtrace.ai).
""
xtrace_memory.app_idstringApp id
Optional app scope stamped on ingested memories and AND-narrowed on recall.
""
xtrace_memory.base_urlstringBase URL
xTrace Memory API base URL. Production by default; use https://api.staging.xtrace.ai for staging.
"https://api.production.xtrace.ai"
xtrace_memory.extract_artifactsbooleanExtract artifacts
Opt into artifact extraction (the most expensive stage). Facts and episodes are always extracted. Leave off unless you need it.
false
xtrace_memory.group_idsstringGroup ids (shared memory)
Optional. Comma-separated group ids (grp_...) to share memory across users/agents. Leave empty for private memory.
""
xtrace_memory.ingest_timeoutintegerIngest timeout (s)
Max seconds to wait/poll for an ingest job to reach a terminal state.
30
xtrace_memory.org_idstringOrg id
xTrace organization id (org_...). Same place as the API key: app.xtrace.ai → Settings → API Keys.
""
xtrace_memory.search_limitintegerRecall limit
Maximum number of memory rows to retrieve per recall.
10
xtrace_memory.search_modestringRecall mode
'compose' returns a ready-to-inject markdown context block (LLM-selected); 'retrieve' returns ranked rows only.
"compose"
xtrace_memory.show_advancedbooleanAdvanced settings
Show advanced options. The defaults work for most cases, leave off for a simple setup.
false
xtrace_memory.user_idstringUser id
Who this memory belongs to (used to store and recall). Can be passed by the agent per call.
""
xtrace_memory.waitbooleanSynchronous ingest
When on, ingest waits (up to ~30s) for extraction to finish so the agent gets a terminal result. When off, ingest returns immediately and runs in the background.
true

Dependencies

  • requests
  • tenacity