Read a preset by id

1 min readEdit this page
GET
/v1/namespaces/{nsid}/presets/{id}

Returns the preset if it exists, belongs to the caller's account, and has kind = 'preset'. Any other case yields 404.

Requires the policy:read scope.

Authorization

x-api-key<token>

Anthropic-style API key header.

In: header

Path Parameters

nsid*string

Id of the target namespace. Must be owned by the caller (or equal a namespace-baked credential's own namespace), else 404.

id*string

Surrogate id of the policies row.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/namespaces/string/presets/string"
{  "budget": {    "limit_micro_usd": 0,    "window": "day"  },  "disabled_at": "2019-08-24T14:15:22Z",  "guardrail": {    "allow_streaming": true,    "byok": "required",    "content_patterns": [      {        "action": "block",        "name": "string",        "pattern": "string"      }    ],    "max_request_tokens": 0,    "model_allow": [      "string"    ],    "model_deny": [      "string"    ]  },  "id": "string",  "name": "string",  "rate_limit": {    "max_requests": 0,    "max_tokens": 0,    "window_secs": 0  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}

How is this guide?