Skip to main content
PATCH
/
v1
/
groups
/
{group_id}
Update group
curl --request PATCH \
  --url https://api.production.xtrace.ai/v1/groups/{group_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Org-Id: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "prompt": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "group",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Long-lived org API key. Alternative: Authorization: Bearer <key>.

​
X-Org-Id
string
header
required

Required alongside the API key (no key→org reverse index).

Path Parameters

​
group_id
string
required

Body

application/json

PATCH /v1/groups/{id} — partial update. Any field set to None is left unchanged. Editing prompt does NOT retroactively re-tag existing memory rows.

​
name
string | null

New name; leave null to keep existing.

Required string length: 1 - 120
​
prompt
string | null

New classifier prompt; leave null to keep existing. Does not retroactively re-tag existing memory rows.

Required string length: 1 - 2000
​
status
enum<string> | null

Set to "active" to un-archive a previously-archived group. The normal way to archive is DELETE /v1/groups/{id}.

Available options:
active,
archived

Response

Successful Response

Wire shape of a group. id is the opaque handle that goes into IngestRequest.group_ids and into search filters.

​
id
string
required

Stable group id of the form grp_<32-hex-chars>.

Example:

"grp_a1b2c3d4e5f6071829304a5b6c7d8e9f"

​
name
string
required

Human-readable label.

​
prompt
string
required

Classifier criterion. Read by the ingest pipeline on every request that includes this group's id in group_ids.

​
status
enum<string>
required

active groups are tagged on new ingests. archived groups still surface on search (rows tagged with the id stay reachable) but the ingest classifier rejects them.

Available options:
active,
archived
​
created_at
string<date-time>
required

ISO-8601 timestamp the group was registered.

​
object
string
default:group

Constant discriminator for the resource type.

Allowed value: "group"
​
updated_at
string<date-time>

ISO-8601 timestamp of the most recent edit.