cURL
curl --location 'https://api.inworld.ai/router/v1/routers?page_size=10' \
--header "Authorization: Basic $INWORLD_API_KEY"import os
import requests
url = "https://api.inworld.ai/router/v1/routers"
headers = {
"Authorization": f"Basic {os.getenv('INWORLD_API_KEY')}"
}
params = {
"page_size": 10
}
response = requests.get(url, headers=headers, params=params)
print(response.json())const url = 'https://api.inworld.ai/router/v1/routers?page_size=10';
const response = await fetch(url, {
headers: {
'Authorization': `Basic ${process.env.INWORLD_API_KEY}`,
},
});
const data = await response.json();
console.log(data);{
"routers": [
{
"name": "<string>",
"displayName": "<string>",
"routes": [
{
"route": {
"route_id": "<string>",
"variants": [
{
"variant": {
"variant_id": "<string>",
"model_id": "<string>",
"model_selection": {
"models": [
"<string>"
],
"sort": [
{
"metric": "SORT_METRIC_UNSPECIFIED",
"direction": "SORT_DIRECTION_UNSPECIFIED"
}
],
"ignore": [
"<string>"
],
"provider": {
"order": [
"<string>"
],
"allow_fallbacks": true
}
},
"text_generation_config": {
"max_tokens": 123,
"top_p": 123,
"temperature": 123,
"repetition_penalty": 123,
"frequency_penalty": 123,
"presence_penalty": 123,
"stop_sequences": [
"<string>"
],
"seed": 123,
"logit_bias": [
{
"token_id": "<string>",
"bias_value": 123
}
],
"reasoning": {
"max_tokens": 123,
"exclude": true
}
},
"message_templates": [
{
"role": "<string>",
"content": "<string>",
"content_items": [
{
"text": "<string>"
}
],
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"tool_call_id": "<string>"
}
],
"web_search": {
"engine": "exa",
"max_results": 3,
"max_steps": 1
}
},
"weight": 123
}
]
},
"condition": {
"cel_expression": "<string>"
}
}
],
"defaultRoute": {
"route_id": "<string>",
"variants": [
{
"variant": {
"variant_id": "<string>",
"model_id": "<string>",
"model_selection": {
"models": [
"<string>"
],
"sort": [
{
"metric": "SORT_METRIC_UNSPECIFIED",
"direction": "SORT_DIRECTION_UNSPECIFIED"
}
],
"ignore": [
"<string>"
],
"provider": {
"order": [
"<string>"
],
"allow_fallbacks": true
}
},
"text_generation_config": {
"max_tokens": 123,
"top_p": 123,
"temperature": 123,
"repetition_penalty": 123,
"frequency_penalty": 123,
"presence_penalty": 123,
"stop_sequences": [
"<string>"
],
"seed": 123,
"logit_bias": [
{
"token_id": "<string>",
"bias_value": 123
}
],
"reasoning": {
"max_tokens": 123,
"exclude": true
}
},
"message_templates": [
{
"role": "<string>",
"content": "<string>",
"content_items": [
{
"text": "<string>"
}
],
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"tool_call_id": "<string>"
}
],
"web_search": {
"engine": "exa",
"max_results": 3,
"max_steps": 1
}
},
"weight": 123
}
]
},
"defaults": {
"message_templates": [
{
"role": "<string>",
"content": "<string>",
"content_items": [
{
"text": "<string>"
}
],
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"tool_call_id": "<string>"
}
],
"text_generation_config": {
"max_tokens": 123,
"top_p": 123,
"temperature": 123,
"repetition_penalty": 123,
"frequency_penalty": 123,
"presence_penalty": 123,
"stop_sequences": [
"<string>"
],
"seed": 123,
"logit_bias": [
{
"token_id": "<string>",
"bias_value": 123
}
],
"reasoning": {
"max_tokens": 123,
"exclude": true
}
}
}
}
],
"next_page_token": "<string>"
}"Unauthorized"Router
List routers
List routers available to your API key.
GET
/
router
/
v1
/
routers
cURL
curl --location 'https://api.inworld.ai/router/v1/routers?page_size=10' \
--header "Authorization: Basic $INWORLD_API_KEY"import os
import requests
url = "https://api.inworld.ai/router/v1/routers"
headers = {
"Authorization": f"Basic {os.getenv('INWORLD_API_KEY')}"
}
params = {
"page_size": 10
}
response = requests.get(url, headers=headers, params=params)
print(response.json())const url = 'https://api.inworld.ai/router/v1/routers?page_size=10';
const response = await fetch(url, {
headers: {
'Authorization': `Basic ${process.env.INWORLD_API_KEY}`,
},
});
const data = await response.json();
console.log(data);{
"routers": [
{
"name": "<string>",
"displayName": "<string>",
"routes": [
{
"route": {
"route_id": "<string>",
"variants": [
{
"variant": {
"variant_id": "<string>",
"model_id": "<string>",
"model_selection": {
"models": [
"<string>"
],
"sort": [
{
"metric": "SORT_METRIC_UNSPECIFIED",
"direction": "SORT_DIRECTION_UNSPECIFIED"
}
],
"ignore": [
"<string>"
],
"provider": {
"order": [
"<string>"
],
"allow_fallbacks": true
}
},
"text_generation_config": {
"max_tokens": 123,
"top_p": 123,
"temperature": 123,
"repetition_penalty": 123,
"frequency_penalty": 123,
"presence_penalty": 123,
"stop_sequences": [
"<string>"
],
"seed": 123,
"logit_bias": [
{
"token_id": "<string>",
"bias_value": 123
}
],
"reasoning": {
"max_tokens": 123,
"exclude": true
}
},
"message_templates": [
{
"role": "<string>",
"content": "<string>",
"content_items": [
{
"text": "<string>"
}
],
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"tool_call_id": "<string>"
}
],
"web_search": {
"engine": "exa",
"max_results": 3,
"max_steps": 1
}
},
"weight": 123
}
]
},
"condition": {
"cel_expression": "<string>"
}
}
],
"defaultRoute": {
"route_id": "<string>",
"variants": [
{
"variant": {
"variant_id": "<string>",
"model_id": "<string>",
"model_selection": {
"models": [
"<string>"
],
"sort": [
{
"metric": "SORT_METRIC_UNSPECIFIED",
"direction": "SORT_DIRECTION_UNSPECIFIED"
}
],
"ignore": [
"<string>"
],
"provider": {
"order": [
"<string>"
],
"allow_fallbacks": true
}
},
"text_generation_config": {
"max_tokens": 123,
"top_p": 123,
"temperature": 123,
"repetition_penalty": 123,
"frequency_penalty": 123,
"presence_penalty": 123,
"stop_sequences": [
"<string>"
],
"seed": 123,
"logit_bias": [
{
"token_id": "<string>",
"bias_value": 123
}
],
"reasoning": {
"max_tokens": 123,
"exclude": true
}
},
"message_templates": [
{
"role": "<string>",
"content": "<string>",
"content_items": [
{
"text": "<string>"
}
],
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"tool_call_id": "<string>"
}
],
"web_search": {
"engine": "exa",
"max_results": 3,
"max_steps": 1
}
},
"weight": 123
}
]
},
"defaults": {
"message_templates": [
{
"role": "<string>",
"content": "<string>",
"content_items": [
{
"text": "<string>"
}
],
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"tool_call_id": "<string>"
}
],
"text_generation_config": {
"max_tokens": 123,
"top_p": 123,
"temperature": 123,
"repetition_penalty": 123,
"frequency_penalty": 123,
"presence_penalty": 123,
"stop_sequences": [
"<string>"
],
"seed": 123,
"logit_bias": [
{
"token_id": "<string>",
"bias_value": 123
}
],
"reasoning": {
"max_tokens": 123,
"exclude": true
}
}
}
}
],
"next_page_token": "<string>"
}"Unauthorized"Authorizations
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.
Query Parameters
The maximum number of routers to return.
Required range:
x >= 0A page token, received from a previous ListRouters call.
Was this page helpful?
⌘I