Create a policy
Creates a named set of guardrails. It applies from the next request on, to the requests that name it in policies and to those its attachments match.
curl --request POST \
--url https://api.telnyx.com/v2/agent_gateways/{instance_id}/policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "baseline",
"description": "Mask personal data",
"guardrails": {
"add": [
"mask-pii"
]
}
}
'{
"data": {
"name": "baseline",
"description": "Mask personal data",
"base": null,
"guardrails": {
"add": [
"mask-pii"
],
"remove": []
},
"model": null,
"pipeline": null,
"created_at": "2026-11-02T12:58:53.995000Z",
"updated_at": "2026-11-02T12:58:53.995000Z"
}
}{
"errors": [
{
"code": "10013",
"title": "Missing association",
"detail": "One of the associated fields does not exist.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10013"
},
"source": {
"pointer": "/base"
}
}
]
}{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "The required authentication headers were either invalid or not included in the request.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "The requested resource or URL could not be found.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
}
}
]
}{
"errors": [
{
"code": "10027",
"title": "Unprocessable Entity",
"detail": "String should match pattern '^[A-Za-z0-9_.-]{1,100}$'",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10027"
},
"source": {
"pointer": "/name"
}
}
]
}Authorizations
Telnyx API key
Path Parameters
The Agent Gateway's id.
Body
A name, unique on the instance. A request names the policy in its policies field.
^[A-Za-z0-9_.-]{1,100}$What the policy is for.
A policy this one builds on, by name. The policy starts with the base's guardrails.
The guardrails a policy adds to its base's, and the ones it removes from them, by name.
Show child attributes
Show child attributes
A condition on the model, by name or regular expression. The policy's guardrails run only on requests for a matching model. null matches every model.
Ordered steps, in place of the guardrails running independently.
Show child attributes
Show child attributes
Response
The created policy
A named set of guardrails.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.telnyx.com/v2/agent_gateways/{instance_id}/policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "baseline",
"description": "Mask personal data",
"guardrails": {
"add": [
"mask-pii"
]
}
}
'{
"data": {
"name": "baseline",
"description": "Mask personal data",
"base": null,
"guardrails": {
"add": [
"mask-pii"
],
"remove": []
},
"model": null,
"pipeline": null,
"created_at": "2026-11-02T12:58:53.995000Z",
"updated_at": "2026-11-02T12:58:53.995000Z"
}
}{
"errors": [
{
"code": "10013",
"title": "Missing association",
"detail": "One of the associated fields does not exist.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10013"
},
"source": {
"pointer": "/base"
}
}
]
}{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "The required authentication headers were either invalid or not included in the request.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "The requested resource or URL could not be found.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
}
}
]
}{
"errors": [
{
"code": "10027",
"title": "Unprocessable Entity",
"detail": "String should match pattern '^[A-Za-z0-9_.-]{1,100}$'",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10027"
},
"source": {
"pointer": "/name"
}
}
]
}