Skip to main content
PATCH
TypeScript SDK

Authorizations

x-api-key
string
header
required

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

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. Setting a prompt on a catch-all group converts it to a prompted group going forward; a prompt can never be removed via PATCH (empty string is a 422).

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.

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"
prompt
string | null

Classifier criterion. Read by the ingest pipeline on every request that includes this group's id in group_ids. null marks a catch-all group: every extracted memory judged shareable (not personal) is tagged with it.

updated_at
string<date-time>

ISO-8601 timestamp of the most recent edit.