Core - List routing rules
curl --get 'https://my.orq.ai/v2/routing-rules' \
--header "Authorization: Bearer $ORQ_API_KEY" \
--data-urlencode 'limit=25'
import { Orq } from '@orq-ai/node';
const client = new Orq({ apiKey: process.env.ORQ_API_KEY });
const page = await client.routingRules.list({ limit: 25 });
for (const rule of page.data) {
console.log(rule._id, rule.displayName);
}
import os
from orq_ai_sdk import Orq
client = Orq(api_key=os.environ["ORQ_API_KEY"])
page = client.routing_rules.list(limit=25)
for rule in page.data:
print(rule._id, rule.display_name)
{
"object": "<string>",
"data": [
{
"_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,
"plugins": [
{
"id": "<string>",
"language": "<string>",
"entities": [
"<string>"
],
"on_failure": "<string>",
"threshold": 123,
"mask": [
"<string>"
],
"regions": [
"<string>"
],
"entity_thresholds": {},
"models_config": {
"mode": "<string>",
"models": [
{
"model": "<string>",
"display_name": "<string>",
"weight": 123,
"integration_id": "<string>"
}
],
"fallback_on_codes": [
499
]
},
"checks": {}
}
],
"priority": 123,
"expression": {
"config": {},
"cel": "<string>"
},
"models_config": {
"mode": "<string>",
"models": [
{
"model": "<string>",
"display_name": "<string>",
"weight": 123,
"integration_id": "<string>"
}
],
"fallback_on_codes": [
499
]
},
"cache_config": {
"ttl": 123
}
}
],
"has_more": true
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}Routing Rules
List routing rules
Returns routing rules ordered by ascending priority. Supports cursor pagination, search, status, project, and referenced-model filters.
GET
/
v2
/
routing-rules
Core - List routing rules
curl --get 'https://my.orq.ai/v2/routing-rules' \
--header "Authorization: Bearer $ORQ_API_KEY" \
--data-urlencode 'limit=25'
import { Orq } from '@orq-ai/node';
const client = new Orq({ apiKey: process.env.ORQ_API_KEY });
const page = await client.routingRules.list({ limit: 25 });
for (const rule of page.data) {
console.log(rule._id, rule.displayName);
}
import os
from orq_ai_sdk import Orq
client = Orq(api_key=os.environ["ORQ_API_KEY"])
page = client.routing_rules.list(limit=25)
for rule in page.data:
print(rule._id, rule.display_name)
{
"object": "<string>",
"data": [
{
"_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,
"plugins": [
{
"id": "<string>",
"language": "<string>",
"entities": [
"<string>"
],
"on_failure": "<string>",
"threshold": 123,
"mask": [
"<string>"
],
"regions": [
"<string>"
],
"entity_thresholds": {},
"models_config": {
"mode": "<string>",
"models": [
{
"model": "<string>",
"display_name": "<string>",
"weight": 123,
"integration_id": "<string>"
}
],
"fallback_on_codes": [
499
]
},
"checks": {}
}
],
"priority": 123,
"expression": {
"config": {},
"cel": "<string>"
},
"models_config": {
"mode": "<string>",
"models": [
{
"model": "<string>",
"display_name": "<string>",
"weight": 123,
"integration_id": "<string>"
}
],
"fallback_on_codes": [
499
]
},
"cache_config": {
"ttl": 123
}
}
],
"has_more": true
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}Related guide: Routing rules guide. See the Routing rules guide for a walkthrough with examples.
Authorizations
Query Parameters
Was this page helpful?