Router Management

Get router

Get a router configuration by router ID.

GET/router/v1/routers/{router_id}

Authorizations

Authorizationstringrequired

Your authentication credentials. For Basic authentication, please populate Basic $INWORLD_API_KEY.

Please make sure your API Key has write permissions for the Router API in order to create, update, and delete routers. You can create a key in one command with the Inworld CLI: inworld workspace add-key.

Path Parameters

router_idstringrequired

Router ID.

Get router

curl --location 'https://api.inworld.ai/router/v1/routers/<router_id>' \
--header "Authorization: Basic $INWORLD_API_KEY"

default_response

{
  "name": "string",
  "displayName": "string",
  "routes": [
    {
      "route": {
        "route_id": "string",
        "variants": [
          {
            "variant": {},
            "weight": 0
          }
        ]
      },
      "condition": {
        "cel_expression": "string"
      }
    }
  ],
  "defaultRoute": {
    "route_id": "string",
    "variants": [
      {
        "variant": {
          "variant_id": "string",
          "model_id": "string",
          "model_selection": {
            "models": [],
            "sort": [],
            "ignore": [],
            "provider": {}
          },
          "text_generation_config": {
            "max_tokens": 0,
            "top_p": 0,
            "temperature": 0,
            "repetition_penalty": 0,
            "frequency_penalty": 0,
            "presence_penalty": 0,
            "stop_sequences": [],
            "seed": 0,
            "logit_bias": [],
            "reasoning": {}
          },
          "message_templates": [
            {}
          ],
          "web_search": {
            "engine": "exa",
            "max_results": 3,
            "max_steps": 1
          }
        },
        "weight": 0
      }
    ]
  },
  "defaults": {
    "message_templates": [
      {
        "role": "string",
        "content": "string",
        "content_items": [
          {}
        ],
        "tool_calls": [
          {
            "id": "string",
            "type": "function",
            "function": {}
          }
        ],
        "tool_call_id": "string"
      }
    ],
    "text_generation_config": {
      "max_tokens": 0,
      "top_p": 0,
      "temperature": 0,
      "repetition_penalty": 0,
      "frequency_penalty": 0,
      "presence_penalty": 0,
      "stop_sequences": [
        "string"
      ],
      "seed": 0,
      "logit_bias": [
        {
          "token_id": "string",
          "bias_value": 0
        }
      ],
      "reasoning": {
        "effort": "unspecified",
        "max_tokens": 0,
        "exclude": true
      }
    }
  }
}