Routing Rules

Create a routing rule

Changed on

Creates a routing rule with metadata and optional model, plugin, priority, and matching configuration. Rules default to disabled when enabled is omitted.

post/v2/routing-rules

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/routing-rules
  • Auth
    HTTP bearer

Request body

display_namestring required
descriptionstring
project_idstring

Optional project scope. Omit for a workspace-wide rule.

enabledboolean

Whether the rule is active. Defaults to false when omitted.

priorityinteger

Example request

{
  "display_name": "Route to Claude"
}

Response

Routing rule created successfully

_idstring required
created_atstring date-time required
updated_atstring date-time required
created_by_idstring required
updated_by_idstring required
project_idstring required

Project that contains the rule. Empty for workspace-wide rules.

display_namestring required

Human-readable routing-rule name.

descriptionstring required
enabledboolean required
priorityinteger required

Evaluation order. Lower values are evaluated first.

Changes

    • info

      added the new optional request property /

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • warning

      removed the request property /

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      removed the non-success response with the status