Core - Retrieve guardrail rule
curl --request GET \
--url 'https://api.orq.ai/v2/guardrail-rules/grl_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \
--header 'Authorization: Bearer $ORQ_API_KEY'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orq.ai/v2/guardrail-rules/{guardrail_rule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orq.ai/v2/guardrail-rules/{guardrail_rule_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"guardrail_rule": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"project_id": "<string>",
"display_name": "<string>",
"description": "<string>",
"enabled": true,
"guardrails": [
{
"id": "<string>",
"execute_on": "<string>",
"sample_rate": 123,
"is_guardrail": true,
"options": {}
}
],
"plugins": [
{
"id": "<string>",
"language": "<string>",
"entities": [
"<string>"
],
"on_failure": "<string>",
"threshold": 123
}
],
"timeout": 123,
"expression": {
"config": {},
"cel": "<string>"
}
}
}Guardrail Rules
Retrieve a guardrail rule
Retrieves a guardrail rule by its unique identifier.
GET
/
v2
/
guardrail-rules
/
{guardrail_rule_id}
Core - Retrieve guardrail rule
curl --request GET \
--url 'https://api.orq.ai/v2/guardrail-rules/grl_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \
--header 'Authorization: Bearer $ORQ_API_KEY'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orq.ai/v2/guardrail-rules/{guardrail_rule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orq.ai/v2/guardrail-rules/{guardrail_rule_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"guardrail_rule": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"project_id": "<string>",
"display_name": "<string>",
"description": "<string>",
"enabled": true,
"guardrails": [
{
"id": "<string>",
"execute_on": "<string>",
"sample_rate": 123,
"is_guardrail": true,
"options": {}
}
],
"plugins": [
{
"id": "<string>",
"language": "<string>",
"entities": [
"<string>"
],
"on_failure": "<string>",
"threshold": 123
}
],
"timeout": 123,
"expression": {
"config": {},
"cel": "<string>"
}
}
}Was this page helpful?
⌘I