Set an agent's guardrails

Replace the topics an agent must not raise and the claims it must never make. The unsubscribe requirement is fixed on.

PUThttps://app.trygtm.com/api/v1/agents/{preset}/guardrails
Scope
write

Path parameters

presetstringrequired
The agent's role, from list_agents: leads, intent, outreach, copy or qa. Pass this or agentId.leadsintentoutreachcopyqa

Headers

Idempotency-Keystringoptional
A key unique to this write, up to 255 characters. A retry carrying the same key returns the first response instead of running again. Kept for 24 hours.

Body

agent_idstringoptional
The agent's id, from list_agents. Pass this or preset.
blocked_topicsstring[]optional
Topics the agent must not raise, up to 64. Omit to leave unchanged.
prohibited_claimsstring[]optional
Claims the agent must never make, up to 64. Omit to leave unchanged.

Request

curl -X PUT https://app.trygtm.com/api/v1/agents/copy/guardrails \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "preset": "copy",
    "name": "GTM Copy",
    "version": 7,
    "detail": "The guardrails are saved. Unsubscribe stays required."
  }
}

Was this page helpful?