Create a routing rule.

POST

api

routing-rules

curl --request POST \
  --url http://localhost:3000/api/routing-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "priority": 123,
  "match": {
    "virtual_key_ids": [
      "<string>"
    ],
    "team_ids": [
      "<string>"
    ],
    "models": [
      "<string>"
    ],
    "metadata": [
      {}
    ]
  },
  "action": {
    "type": "rewrite_model",
    "to": {
      "provider": "openai",
      "model": "<string>"
    },
    "fallbacks": [
      {
        "provider": "openai",
        "model": "<string>"
      }
    ]
  },
  "description": "<string>",
  "enabled": true
}
'

import requests

url = "http://localhost:3000/api/routing-rules"

payload = {
    "priority": 123,
    "match": {
        "virtual_key_ids": ["<string>"],
        "team_ids": ["<string>"],
        "models": ["<string>"],
        "metadata": [{}]
    },
    "action": {
        "type": "rewrite_model",
        "to": {
            "provider": "openai",
            "model": "<string>"
        },
        "fallbacks": [
            {
                "provider": "openai",
                "model": "<string>"
            }
        ]
    },
    "description": "<string>",
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    priority: 123,
    match: {
      virtual_key_ids: ['<string>'],
      team_ids: ['<string>'],
      models: ['<string>'],
      metadata: [{}]
    },
    action: {
      type: 'rewrite_model',
      to: {provider: 'openai', model: '<string>'},
      fallbacks: [{provider: 'openai', model: '<string>'}]
    },
    description: '<string>',
    enabled: true
  })
};

fetch('http://localhost:3000/api/routing-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/routing-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'priority' => 123,
    'match' => [
        'virtual_key_ids' => [
                '<string>'
        ],
        'team_ids' => [
                '<string>'
        ],
        'models' => [
                '<string>'
        ],
        'metadata' => [
                [
                                
                ]
        ]
    ],
    'action' => [
        'type' => 'rewrite_model',
        'to' => [
                'provider' => 'openai',
                'model' => '<string>'
        ],
        'fallbacks' => [
                [
                                'provider' => 'openai',
                                'model' => '<string>'
                ]
        ]
    ],
    'description' => '<string>',
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/routing-rules"

	payload := strings.NewReader("{\n  \"priority\": 123,\n  \"match\": {\n    \"virtual_key_ids\": [\n      \"<string>\"\n    ],\n    \"team_ids\": [\n      \"<string>\"\n    ],\n    \"models\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      {}\n    ]\n  },\n  \"action\": {\n    \"type\": \"rewrite_model\",\n    \"to\": {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    },\n    \"fallbacks\": [\n      {\n        \"provider\": \"openai\",\n        \"model\": \"<string>\"\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:3000/api/routing-rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"priority\": 123,\n  \"match\": {\n    \"virtual_key_ids\": [\n      \"<string>\"\n    ],\n    \"team_ids\": [\n      \"<string>\"\n    ],\n    \"models\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      {}\n    ]\n  },\n  \"action\": {\n    \"type\": \"rewrite_model\",\n    \"to\": {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    },\n    \"fallbacks\": [\n      {\n        \"provider\": \"openai\",\n        \"model\": \"<string>\"\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/routing-rules")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"priority\": 123,\n  \"match\": {\n    \"virtual_key_ids\": [\n      \"<string>\"\n    ],\n    \"team_ids\": [\n      \"<string>\"\n    ],\n    \"models\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      {}\n    ]\n  },\n  \"action\": {\n    \"type\": \"rewrite_model\",\n    \"to\": {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    },\n    \"fallbacks\": [\n      {\n        \"provider\": \"openai\",\n        \"model\": \"<string>\"\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{}

{
  "error": {
    "code": "budget_exceeded",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

WorkOS session access token (human dashboard sessions) on the control plane.

Headers

X-Spillway-Org

string<uuid>

Example:

"601c5d19-0b88-42f7-acda-d1d31abd100d"

Body

application/json

priority

integer

required

match

object

required

Show child attributes

action

object

required

Option 1
Option 2

Show child attributes

description

string

Maximum string length: 500

enabled

boolean

default:true

Response

Resource object.

{key}

any

Create a routing rule.

curl --request POST \
  --url http://localhost:3000/api/routing-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "priority": 123,
  "match": {
    "virtual_key_ids": [
      "<string>"
    ],
    "team_ids": [
      "<string>"
    ],
    "models": [
      "<string>"
    ],
    "metadata": [
      {}
    ]
  },
  "action": {
    "type": "rewrite_model",
    "to": {
      "provider": "openai",
      "model": "<string>"
    },
    "fallbacks": [
      {
        "provider": "openai",
        "model": "<string>"
      }
    ]
  },
  "description": "<string>",
  "enabled": true
}
'

import requests

url = "http://localhost:3000/api/routing-rules"

payload = {
    "priority": 123,
    "match": {
        "virtual_key_ids": ["<string>"],
        "team_ids": ["<string>"],
        "models": ["<string>"],
        "metadata": [{}]
    },
    "action": {
        "type": "rewrite_model",
        "to": {
            "provider": "openai",
            "model": "<string>"
        },
        "fallbacks": [
            {
                "provider": "openai",
                "model": "<string>"
            }
        ]
    },
    "description": "<string>",
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    priority: 123,
    match: {
      virtual_key_ids: ['<string>'],
      team_ids: ['<string>'],
      models: ['<string>'],
      metadata: [{}]
    },
    action: {
      type: 'rewrite_model',
      to: {provider: 'openai', model: '<string>'},
      fallbacks: [{provider: 'openai', model: '<string>'}]
    },
    description: '<string>',
    enabled: true
  })
};

fetch('http://localhost:3000/api/routing-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/routing-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'priority' => 123,
    'match' => [
        'virtual_key_ids' => [
                '<string>'
        ],
        'team_ids' => [
                '<string>'
        ],
        'models' => [
                '<string>'
        ],
        'metadata' => [
                [
                                
                ]
        ]
    ],
    'action' => [
        'type' => 'rewrite_model',
        'to' => [
                'provider' => 'openai',
                'model' => '<string>'
        ],
        'fallbacks' => [
                [
                                'provider' => 'openai',
                                'model' => '<string>'
                ]
        ]
    ],
    'description' => '<string>',
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/routing-rules"

	payload := strings.NewReader("{\n  \"priority\": 123,\n  \"match\": {\n    \"virtual_key_ids\": [\n      \"<string>\"\n    ],\n    \"team_ids\": [\n      \"<string>\"\n    ],\n    \"models\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      {}\n    ]\n  },\n  \"action\": {\n    \"type\": \"rewrite_model\",\n    \"to\": {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    },\n    \"fallbacks\": [\n      {\n        \"provider\": \"openai\",\n        \"model\": \"<string>\"\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:3000/api/routing-rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"priority\": 123,\n  \"match\": {\n    \"virtual_key_ids\": [\n      \"<string>\"\n    ],\n    \"team_ids\": [\n      \"<string>\"\n    ],\n    \"models\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      {}\n    ]\n  },\n  \"action\": {\n    \"type\": \"rewrite_model\",\n    \"to\": {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    },\n    \"fallbacks\": [\n      {\n        \"provider\": \"openai\",\n        \"model\": \"<string>\"\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/routing-rules")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"priority\": 123,\n  \"match\": {\n    \"virtual_key_ids\": [\n      \"<string>\"\n    ],\n    \"team_ids\": [\n      \"<string>\"\n    ],\n    \"models\": [\n      \"<string>\"\n    ],\n    \"metadata\": [\n      {}\n    ]\n  },\n  \"action\": {\n    \"type\": \"rewrite_model\",\n    \"to\": {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    },\n    \"fallbacks\": [\n      {\n        \"provider\": \"openai\",\n        \"model\": \"<string>\"\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{}

{
  "error": {
    "code": "budget_exceeded",
    "message": "<string>",
    "details": {}
  }
}

Overview

Endpoints

Create a routing rule.

Authorizations

Headers

Body

Response