Get policy

GET

https://platform.lakera.ai/api/v1/policies/:policyId

GET

/api/v1/policies/:policyId

$ curl https://platform.lakera.ai/api/v1/policies/policy-123456-random-g74j7 \
>      -H "Authorization: Bearer <token>"

1 {
2   "policy": {
3     "policy_id": "policy-123456-random-g74j7",
4     "version_id": 3,
5     "name": "string",
6     "default_threshold": "l1_confident",
7     "detectors": [
8       {
9         "type": "prompt_attack",
10         "location": "user::content",
11         "allowed_domains": [
12           "my-trusted-domain.com",
13           "another-safe-domain.com"
14         ],
15         "override_list": [
16           "deny_list_item1",
17           "deny_list_item2"
18         ],
19         "tool_access_action": "allow",
20         "tool_access_list": [
21           "get_weather"
22         ],
23         "allowed_tools": [
24           {
25             "tool_name": "string",
26             "tool_matcher": "string"
27           }
28         ]
29       }
30     ],
31     "custom_guardrails": [
32       {
33         "id": "custom-guardrail-123456-random-g74j7",
34         "locations": [
35           "user::content"
36         ]
37       }
38     ],
39     "updated_at": "2024-01-15T09:30:00Z",
40     "projects": [
41       {
42         "id": "string",
43         "name": "string",
44         "action": "detect"
45       }
46     ]
47   }
48 }

Retrieve a single policy, including the projects currently using it

Authentication

AuthorizationBearer

Bearer authentication using API key. Generate an API key from the AI Guardrails Dashboard. Example: Bearer sk_123…

Path parameters

policyIdstringRequired

Response

Policy details

policyobject

A policy as returned by the API

Errors

403

Forbidden Error

404

Not Found Error