Create a model alias.

POST

api

aliases

curl --request POST \
  --url http://localhost:3000/api/aliases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "targets": [
    {
      "provider": "openai",
      "model": "<string>"
    }
  ]
}
'

import requests

url = "http://localhost:3000/api/aliases"

payload = {
    "alias": "<string>",
    "targets": [
        {
            "provider": "openai",
            "model": "<string>"
        }
    ]
}
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({alias: '<string>', targets: [{provider: 'openai', model: '<string>'}]})
};

fetch('http://localhost:3000/api/aliases', 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/aliases",
  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([
    'alias' => '<string>',
    'targets' => [
        [
                'provider' => 'openai',
                'model' => '<string>'
        ]
    ]
  ]),
  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/aliases"

	payload := strings.NewReader("{\n  \"alias\": \"<string>\",\n  \"targets\": [\n    {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    }\n  ]\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/aliases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alias\": \"<string>\",\n  \"targets\": [\n    {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/aliases")

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  \"alias\": \"<string>\",\n  \"targets\": [\n    {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    }\n  ]\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

alias

string

required

Required string length: 1 - 120

targets

object

required

object[]
object

Show child attributes

Response

Resource object.

{key}

any

Create a model alias.

curl --request POST \
  --url http://localhost:3000/api/aliases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "targets": [
    {
      "provider": "openai",
      "model": "<string>"
    }
  ]
}
'

import requests

url = "http://localhost:3000/api/aliases"

payload = {
    "alias": "<string>",
    "targets": [
        {
            "provider": "openai",
            "model": "<string>"
        }
    ]
}
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({alias: '<string>', targets: [{provider: 'openai', model: '<string>'}]})
};

fetch('http://localhost:3000/api/aliases', 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/aliases",
  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([
    'alias' => '<string>',
    'targets' => [
        [
                'provider' => 'openai',
                'model' => '<string>'
        ]
    ]
  ]),
  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/aliases"

	payload := strings.NewReader("{\n  \"alias\": \"<string>\",\n  \"targets\": [\n    {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    }\n  ]\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/aliases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alias\": \"<string>\",\n  \"targets\": [\n    {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/aliases")

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  \"alias\": \"<string>\",\n  \"targets\": [\n    {\n      \"provider\": \"openai\",\n      \"model\": \"<string>\"\n    }\n  ]\n}"

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

{}

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

Overview

Endpoints

Create a model alias.

Authorizations

Headers

Body

Response