Skip to main content
PUT
/
v1
/
agents
/
{agentId}
/
retention
Upsert an agent retention policy
curl --request PUT \
  --url https://{host}/v2/workspaces/slug:agent-factory/webhooks/v1/agents/{agentId}/retention \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversations_retention_days": 123,
  "documents_retention_days": 123,
  "tasks_retention_days": 123,
  "artifacts_retention_days": 123,
  "admin_override": true
}
'
{
  "policy": {},
  "effective": {
    "conversations_retention_days": 123,
    "documents_retention_days": 123,
    "tasks_retention_days": 123,
    "artifacts_retention_days": 123
  }
}

Authorizations

​
Authorization
string
header
required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Path Parameters

​
agentId
string
required
Maximum string length: 64

Body

application/json
​
conversations_retention_days
integer | null
​
documents_retention_days
integer | null
​
tasks_retention_days
integer | null
​
artifacts_retention_days
integer | null
​
admin_override
boolean

Admins only - opt out of org-limit enforcement.

Response

Upserted policy + effective values.

​
policy
object

Raw retention_policies document for this agent (scope: "agent"). Null when no override is set.

​
effective
object

Resolved retention values (agent → org → platform defaults).