List Guardrail Configs

GET

https://host.com/apis/guardrails/v2/workspaces/:workspace/configs

GET

/apis/guardrails/v2/workspaces/:workspace/configs

$ curl https://host.com/apis/guardrails/v2/workspaces/workspace/configs

1 {
2   "data": [
3     {
4       "workspace": "string",
5       "id": "string",
6       "created_at": "2024-01-15T09:30:00Z",
7       "created_by": "string",
8       "updated_at": "2024-01-15T09:30:00Z",
9       "updated_by": "string",
10       "entity_id": "string",
11       "parent": "string",
12       "name": "",
13       "project": "string",
14       "description": "string",
15       "data": {
16         "models": [
17           {
18             "type": "string",
19             "engine": "string",
20             "model": "string",
21             "parameters": {
22               "base_url": "string",
23               "default_headers": {}
24             },
25             "mode": "chat",
26             "cache": {
27               "enabled": false,
28               "maxsize": 50000,
29               "stats": {
30                 "enabled": false,
31                 "log_interval": 1.1
32               }
33             }
34           }
35         ],
36         "instructions": [
37           {
38             "type": "string",
39             "content": "string"
40           }
41         ],
42         "actions_server_url": "string",
43         "sample_conversation": "user \"Hello there!\"\n  express greeting\nbot express greeting\n  \"Hello! How can I assist you today?\"\nuser \"What can you do for me?\"\n  ask about capabilities\nbot respond about capabilities\n  \"As an AI assistant, I can help you with a wide range of tasks. This includes question answering on various topics, generating text for various purposes and providing suggestions based on your preferences.\"\nuser \"Tell me a bit about the history of NVIDIA.\"\n  ask general question\nbot response for general question\n  \"NVIDIA is a technology company that specializes in designing and manufacturing graphics processing units (GPUs) and other computer hardware. The company was founded in 1993 by Jen-Hsun Huang, Chris Malachowsky, and Curtis Priem.\"\nuser \"tell me more\"\n  request more information\nbot provide more information\n  \"Initially, the company focused on developing 3D graphics processing technology for the PC gaming market. In 1999, NVIDIA released the GeForce 256, the world's first GPU, which was a major breakthrough for the gaming industry. The company continued to innovate in the GPU space, releasing new products and expanding into other markets such as professional graphics, mobile devices, and artificial intelligence.\"\nuser \"thanks\"\n  express appreciation\nbot express appreciation and offer additional help\n  \"You're welcome. If you have any more questions or if there's anything else I can help you with, please don't hesitate to ask.\"\n",
44         "prompts": [
45           {
46             "task": "string",
47             "content": "string",
48             "messages": [
49               {
50                 "type": "string",
51                 "content": "string"
52               }
53             ],
54             "models": [
55               "string"
56             ],
57             "output_parser": "string",
58             "max_length": 16000,
59             "mode": "standard",
60             "stop": [
61               "string"
62             ],
63             "max_tokens": 1
64           }
65         ],
66         "prompting_mode": "standard",
67         "lowest_temperature": 0.001,
68         "enable_multi_step_generation": false,
69         "colang_version": "1.0",
70         "custom_data": {},
71         "rails": {
72           "config": {
73             "fact_checking": {
74               "parameters": {},
75               "fallback_to_self_check": false
76             },
77             "autoalign": {
78               "parameters": {},
79               "input": {
80                 "guardrails_config": {}
81               },
82               "output": {
83                 "guardrails_config": {}
84               }
85             },
86             "patronus": {
87               "input": {
88                 "evaluate_config": {
89                   "success_strategy": "all_pass",
90                   "params": {}
91                 }
92               },
93               "output": {
94                 "evaluate_config": {
95                   "success_strategy": "all_pass",
96                   "params": {}
97                 }
98               }
99             },
100             "sensitive_data_detection": {
101               "recognizers": [
102                 {}
103               ],
104               "input": {
105                 "entities": [
106                   "string"
107                 ],
108                 "mask_token": "*",
109                 "score_threshold": 0.2
110               },
111               "output": {
112                 "entities": [
113                   "string"
114                 ],
115                 "mask_token": "*",
116                 "score_threshold": 0.2
117               },
118               "retrieval": {
119                 "entities": [
120                   "string"
121                 ],
122                 "mask_token": "*",
123                 "score_threshold": 0.2
124               }
125             },
126             "regex_detection": {
127               "input": {
128                 "patterns": [
129                   "string"
130                 ],
131                 "case_insensitive": false
132               },
133               "output": {
134                 "patterns": [
135                   "string"
136                 ],
137                 "case_insensitive": false
138               },
139               "retrieval": {
140                 "patterns": [
141                   "string"
142                 ],
143                 "case_insensitive": false
144               }
145             },
146             "jailbreak_detection": {
147               "server_endpoint": "string",
148               "length_per_perplexity_threshold": 89.79,
149               "prefix_suffix_perplexity_threshold": 1845.65,
150               "nim_base_url": "string",
151               "nim_server_endpoint": "classify",
152               "api_key_env_var": "string",
153               "nim_url": "string",
154               "nim_port": 1,
155               "embedding": "string"
156             },
157             "injection_detection": {
158               "injections": [
159                 "string"
160               ],
161               "action": "reject",
162               "yara_rules": {}
163             },
164             "privateai": {
165               "server_endpoint": "string",
166               "input": {
167                 "entities": [
168                   "string"
169                 ]
170               },
171               "output": {
172                 "entities": [
173                   "string"
174                 ]
175               },
176               "retrieval": {
177                 "entities": [
178                   "string"
179                 ]
180               }
181             },
182             "gliner": {
183               "server_endpoint": "http://localhost:1235/v1/extract",
184               "threshold": 0.5,
185               "chunk_length": 384,
186               "overlap": 128,
187               "flat_ner": false,
188               "input": {
189                 "entities": [
190                   "string"
191                 ]
192               },
193               "output": {
194                 "entities": [
195                   "string"
196                 ]
197               },
198               "retrieval": {
199                 "entities": [
200                   "string"
201                 ]
202               }
203             },
204             "fiddler": {
205               "fiddler_endpoint": "http://localhost:8080/process/text",
206               "safety_threshold": 0.1,
207               "faithfulness_threshold": 0.05
208             },
209             "clavata": {
210               "server_endpoint": "https://gateway.app.clavata.ai:8443",
211               "policies": {},
212               "label_match_logic": "ANY",
213               "input": {
214                 "policy": "string",
215                 "labels": [
216                   "string"
217                 ]
218               },
219               "output": {
220                 "policy": "string",
221                 "labels": [
222                   "string"
223                 ]
224               }
225             },
226             "crowdstrike_aidr": {
227               "timeout": 30
228             },
229             "pangea": {
230               "input": {
231                 "recipe": "string"
232               },
233               "output": {
234                 "recipe": "string"
235               }
236             },
237             "guardrails_ai": {
238               "validators": [
239                 {
240                   "name": "string",
241                   "parameters": {},
242                   "metadata": {}
243                 }
244               ]
245             },
246             "trend_micro": {
247               "v1_url": "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails",
248               "api_key_env_var": "string",
249               "application_name": "nemo-guardrails",
250               "detailed_response": false
251             },
252             "ai_defense": {
253               "timeout": 30,
254               "fail_open": false
255             },
256             "content_safety": {
257               "multilingual": {
258                 "enabled": false,
259                 "refusal_messages": {}
260               },
261               "reasoning": {
262                 "enabled": false
263               }
264             }
265           },
266           "input": {
267             "parallel": false,
268             "flows": [
269               "string"
270             ]
271           },
272           "output": {
273             "parallel": false,
274             "flows": [
275               "string"
276             ],
277             "streaming": {
278               "enabled": true,
279               "chunk_size": 200,
280               "context_size": 50,
281               "stream_first": true
282             },
283             "apply_to_reasoning_traces": false
284           },
285           "retrieval": {
286             "flows": [
287               "string"
288             ]
289           },
290           "dialog": {
291             "single_call": {
292               "enabled": false,
293               "fallback_to_multiple_calls": true
294             },
295             "user_messages": {
296               "embeddings_only": false,
297               "embeddings_only_similarity_threshold": 0.5,
298               "embeddings_only_fallback_intent": "string"
299             }
300           },
301           "actions": {
302             "instant_actions": [
303               "string"
304             ]
305           },
306           "tool_output": {
307             "flows": [
308               "string"
309             ],
310             "parallel": false
311           },
312           "tool_input": {
313             "flows": [
314               "string"
315             ],
316             "parallel": false
317           }
318         },
319         "enable_rails_exceptions": false,
320         "passthrough": true,
321         "tracing": {
322           "enabled": false,
323           "adapters": [
324             {
325               "name": "FileSystem"
326             }
327           ],
328           "span_format": "opentelemetry",
329           "enable_content_capture": false
330         }
331       }
332     }
333   ],
334   "pagination": {
335     "page": 1,
336     "page_size": 1,
337     "current_page_size": 1,
338     "total_pages": 1,
339     "total_results": 1
340   },
341   "sort": "string",
342   "filter": {}
343 }

List available guardrail configs. Lists guardrail configs for a specific workspace.

Path parameters

workspacestringRequired

Query parameters

pageintegerOptionalDefaults to 1

Page number.

page_sizeintegerOptionalDefaults to 10

Page size.

sortenumOptionalDefaults to created_at

The field to sort by. To sort in decreasing order, use - in front of the field name.

Allowed values:

filterobjectOptional

Filter guardrail configs by name, description, project, created_at, and updated_at.

Response

Successful Response

datalist of objects

paginationobject

Pagination information.

sortstring

The field on which the results are sorted.

filtermap from strings to any

Filtering information.

Errors

422

Unprocessable Entity Error