Get Routing Rule

Get Routing Rule

Returns a single routing rule by ID for the authenticated user.

Endpoint

GET /v1/routing-rules/{id}

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	The routing rule ID

Examples

TypeScript

import Tokenrouter from 'tokenrouter';

const client = new Tokenrouter({
  apiKey: process.env.TOKENROUTER_API_KEY
});

const rule = await client.routingRules.retrieve(123);

console.log(`Rule: ${rule.data.name}`);
console.log(`Priority: ${rule.data.priority}`);
console.log(`Enabled: ${rule.data.is_enabled}`);
console.log(`Match Conditions:`, rule.data.match_json);
console.log(`Actions:`, rule.data.action_json);

Python

from tokenrouter import Tokenrouter

client = Tokenrouter(
    api_key=os.getenv("TOKENROUTER_API_KEY")
)

rule = client.routing_rules.retrieve(123)

print(f"Rule: {rule.data.name}")
print(f"Priority: {rule.data.priority}")
print(f"Enabled: {rule.data.is_enabled}")
print(f"Match Conditions: {rule.data.match_json}")
print(f"Actions: {rule.data.action_json}")

cURL

curl https://api.tokenrouter.io/v1/routing-rules/123 \
  -H "Authorization: Bearer tr_..."

Response

{
  "data": {
    "id": 123,
    "user_id": 456,
    "name": "Code Review → Anthropic",
    "is_enabled": true,
    "priority": 100,
    "match_json": {
      "task": "code_review"
    },
    "action_json": {
      "set_provider": "anthropic",
      "set_model": "claude-3-5-sonnet-20241022"
    },
    "created_at": "2025-11-10T12:00:00Z",
    "updated_at": "2025-11-10T12:00:00Z"
  }
}

Response Fields

Field	Type	Description
id	integer	Unique rule identifier
user_id	integer	Owner user ID
name	string	Rule name
is_enabled	boolean	Whether rule is active
priority	integer	Rule priority (-1000 to 1000)
match_json	object	Match conditions
action_json	object	Actions to apply
created_at	string	ISO timestamp of creation
updated_at	string	ISO timestamp of last update

Error Responses

404 Not Found

Returned when the rule doesn’t exist or doesn’t belong to the authenticated user:

{
  "error": {
    "message": "Routing rule not found",
    "type": "not_found_error",
    "http_status": 404
  }
}

Practical Examples

Check if Rule is Active

TypeScript

const rule = await client.routingRules.retrieve(123);

if (rule.data.is_enabled) {
  console.log('Rule is active and will be evaluated');
} else {
  console.log('Rule is disabled');
}

Python

rule = client.routing_rules.retrieve(123)

if rule.data.is_enabled:
    print("Rule is active and will be evaluated")
else:
    print("Rule is disabled")

Inspect Rule Actions

TypeScript

const rule = await client.routingRules.retrieve(123);

const actions = rule.data.action_json;

if (actions.set_provider) {
  console.log(`Forces provider: ${actions.set_provider}`);
}

if (actions.set_model) {
  console.log(`Forces model: ${actions.set_model}`);
}

if (actions.set_mode) {
  console.log(`Overrides mode: ${actions.set_mode}`);
}

Python

rule = client.routing_rules.retrieve(123)

actions = rule.data.action_json

if 'set_provider' in actions:
    print(f"Forces provider: {actions['set_provider']}")

if 'set_model' in actions:
    print(f"Forces model: {actions['set_model']}")

if 'set_mode' in actions:
    print(f"Overrides mode: {actions['set_mode']}")

Clone Rule for Editing

TypeScript

// Get existing rule
const original = await client.routingRules.retrieve(123);

// Create a similar rule with different priority
const cloned = await client.routingRules.create({
  name: `${original.data.name} (Copy)`,
  priority: original.data.priority - 10,
  is_enabled: false,  // Start disabled
  match_json: original.data.match_json,
  action_json: original.data.action_json
});

console.log('Created cloned rule:', cloned.data.id);

Python

# Get existing rule
original = client.routing_rules.retrieve(123)

# Create a similar rule with different priority
cloned = client.routing_rules.create(
    name=f"{original.data.name} (Copy)",
    priority=original.data.priority - 10,
    is_enabled=False,  # Start disabled
    match_json=original.data.match_json,
    action_json=original.data.action_json
)

print(f"Created cloned rule: {cloned.data.id}")

Use Cases

Audit Rule Configuration

Use this endpoint to verify rule settings before enabling:

const rule = await client.routingRules.retrieve(ruleId);

// Verify conditions
assert(rule.data.match_json.task === 'coding');

// Verify actions
assert(rule.data.action_json.set_provider === 'openai');

// Enable if verified
if (!rule.data.is_enabled) {
  await client.routingRules.update(ruleId, { is_enabled: true });
}

Monitor Rule Changes

Track when rules were last modified:

const rule = await client.routingRules.retrieve(ruleId);

const lastModified = new Date(rule.data.updated_at);
const hoursSinceUpdate = (Date.now() - lastModified.getTime()) / (1000 * 60 * 60);

if (hoursSinceUpdate > 24) {
  console.log('Rule hasn\'t been updated in over 24 hours');
}

Next Steps

• Update Routing Rule
• Delete Routing Rule
• List All Rules
• Create New Rule