> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a routing rule > Retrieves a routing rule by its unique identifier. ## OpenAPI ````yaml get /v2/routing-rules/{routing_rule_id} openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://my.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: File Systems description: >- Create and manage persistent file systems that agents and MCP clients read from and write to. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: Annotation Queues description: Annotation queues collect spans for human review. - name: API keys description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. - name: Audit Logs description: Audit logs record workspace entity changes and access-relevant events. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the orq.ai model catalog: every model orq offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/routing-rules/{routing_rule_id}: get: tags: - Routing Rules summary: Retrieve a routing rule description: Retrieves a routing rule by its unique identifier. operationId: RoutingRuleGet parameters: - name: routing_rule_id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RoutingRule' x-code-samples: - lang: curl label: Core - Retrieve routing rule source: | curl --request GET \ --url 'https://api.orq.ai/v2/routing-rules/rrl_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \ --header "Authorization: Bearer $ORQ_API_KEY" - lang: python label: Python - Retrieve routing rule source: | import os from orq_ai_sdk import Orq client = Orq(api_key=os.environ["ORQ_API_KEY"]) rule = client.routing_rules.retrieve( routing_rule_id="rrl_01HZXW2K7Y8Q9M0N1P2R3S4T5V", ) print(rule.display_name) - lang: typescript label: Node.js - Retrieve routing rule source: | import { Orq } from '@orq-ai/node'; const client = new Orq({ apiKey: process.env.ORQ_API_KEY }); const rule = await client.routingRules.retrieve({ routingRuleId: 'rrl_01HZXW2K7Y8Q9M0N1P2R3S4T5V', }); console.log(rule.displayName); components: schemas: RoutingRule: required: - _id - created_at - updated_at - created_by_id - updated_by_id - project_id - display_name - description - enabled - plugins - priority type: object properties: _id: type: string created_at: format: date-time type: string updated_at: format: date-time type: string created_by_id: type: string updated_by_id: type: string project_id: type: string description: Project that contains the rule. Empty for workspace-wide rules. display_name: type: string description: Human-readable routing-rule name. description: type: string enabled: type: boolean expression: $ref: '#/components/schemas/RoutingRuleExpression' models_config: $ref: '#/components/schemas/RoutingRuleModelsConfig' plugins: type: array items: $ref: '#/components/schemas/RoutingRulePlugin' priority: type: integer description: Evaluation order. Lower values are evaluated first. format: int32 cache_config: $ref: '#/components/schemas/RoutingRuleCacheConfig' RoutingRuleExpression: type: object properties: config: type: object cel: type: string description: >- CEL expression used to match requests. Empty means the rule always matches. RoutingRuleModelsConfig: type: object properties: mode: type: string description: Load-balancing mode. models: type: array items: $ref: '#/components/schemas/RoutingRuleModel' RoutingRulePlugin: type: object properties: id: type: string description: Plugin discriminator. language: type: string entities: type: array items: type: string on_failure: type: string threshold: type: number format: double mask: type: array items: type: string RoutingRuleCacheConfig: required: - ttl type: object properties: ttl: type: integer description: Cache time to live in seconds. Maximum 259200 seconds (3 days). format: int32 RoutingRuleModel: type: object properties: model: type: string display_name: type: string weight: type: number format: double integration_id: type: string securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````