Retention profile

Set and read how much of a request Zumik retains. The default is metadata-only; opt into tokenized or encrypted full-fidelity traces when you need them.

A retention profile controls how much of a request Zumik keeps. The default across the platform is metadata-only: raw inputs are not retained. Opt into richer fidelity when you need input items for replay or compaction. Profile ids are prefixed rtp_. See retention and purge.

All requests require a bearer API key. See authentication.

Set the profile

POST /v2/retention-profile

Installs (or replaces) the project's retention profile.

trace_modestringrequired

How much of each request to retain: metadata (default behavior, no raw text), tokenized, or encrypted_full_fidelity.

default_retention_daysintegerdefault: 30

How long retained data is kept, in days.

cache_retentionstringdefault: provider_default

The cache-retention policy.

curl https://api.zumik.ai/v2/retention-profile \
  -H "Authorization: Bearer $ZUMIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trace_mode": "encrypted_full_fidelity",
    "default_retention_days": 30,
    "cache_retention": "provider_default"
  }'

{
  "id": "rtp_01jy7nqr90t2u3v4w5x6y7z8a1",
  "object": "retention_profile",
  "project_id": "prj_01jy7n0a4c8m2t6v9q3wrxk7bd",
  "trace_mode": "encrypted_full_fidelity",
  "default_retention_days": 30,
  "cache_retention": "provider_default",
  "updated_at": "2026-06-15T16:38:55Z"
}

idstring

Opaque profile id, prefixed rtp_.

objectstring

Always retention_profile.

project_idstring

The owning project.

trace_modestring

The retention fidelity.

default_retention_daysinteger

Retention period in days.

cache_retentionstring

The cache-retention policy.

updated_atstring

RFC 3339 update timestamp.

Read the profile

GET /v2/retention-profile

curl https://api.zumik.ai/v2/retention-profile \
  -H "Authorization: Bearer $ZUMIK_API_KEY"

Returns the profile object, or 404 when none is configured (the metadata-only default still applies).

Errors

Status	Code	When
401	`invalid_api_key`	Missing or invalid API key.
404	`invalid_request_error`	No retention profile is configured for this project.

See the full table on errors.

Retention profile

Set the profile

Read the profile

Errors

On this page