Add a model
curl --request POST \
--url https://gateway.your-domain.com/model/new \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model_name": "gpt-4o",
"forceai_params": {
"model": "openai/gpt-4o",
"custom_llm_provider": "openai",
"api_key": "sk-..."
},
"model_info": {
"mode": "chat"
}
}
'import requests
url = "https://gateway.your-domain.com/model/new"
payload = {
"model_name": "gpt-4o",
"forceai_params": {
"model": "openai/gpt-4o",
"custom_llm_provider": "openai",
"api_key": "sk-..."
},
"model_info": { "mode": "chat" }
}
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({
model_name: 'gpt-4o',
forceai_params: {model: 'openai/gpt-4o', custom_llm_provider: 'openai', api_key: 'sk-...'},
model_info: {mode: 'chat'}
})
};
fetch('https://gateway.your-domain.com/model/new', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway.your-domain.com/model/new",
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([
'model_name' => 'gpt-4o',
'forceai_params' => [
'model' => 'openai/gpt-4o',
'custom_llm_provider' => 'openai',
'api_key' => 'sk-...'
],
'model_info' => [
'mode' => 'chat'
]
]),
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 := "https://gateway.your-domain.com/model/new"
payload := strings.NewReader("{\n \"model_name\": \"gpt-4o\",\n \"forceai_params\": {\n \"model\": \"openai/gpt-4o\",\n \"custom_llm_provider\": \"openai\",\n \"api_key\": \"sk-...\"\n },\n \"model_info\": {\n \"mode\": \"chat\"\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("https://gateway.your-domain.com/model/new")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model_name\": \"gpt-4o\",\n \"forceai_params\": {\n \"model\": \"openai/gpt-4o\",\n \"custom_llm_provider\": \"openai\",\n \"api_key\": \"sk-...\"\n },\n \"model_info\": {\n \"mode\": \"chat\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.your-domain.com/model/new")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model_name\": \"gpt-4o\",\n \"forceai_params\": {\n \"model\": \"openai/gpt-4o\",\n \"custom_llm_provider\": \"openai\",\n \"api_key\": \"sk-...\"\n },\n \"model_info\": {\n \"mode\": \"chat\"\n }\n}"
response = http.request(request)
puts response.read_body{
"model_name": "gpt-4o",
"model_info": {
"id": "504f9647-...",
"mode": "chat"
}
}{
"error": {
"message": "Authentication Error, No api key passed in."
}
}Models
Add a model
Add a model for a supported provider using forceai_params.
POST
/
model
/
new
Add a model
curl --request POST \
--url https://gateway.your-domain.com/model/new \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model_name": "gpt-4o",
"forceai_params": {
"model": "openai/gpt-4o",
"custom_llm_provider": "openai",
"api_key": "sk-..."
},
"model_info": {
"mode": "chat"
}
}
'import requests
url = "https://gateway.your-domain.com/model/new"
payload = {
"model_name": "gpt-4o",
"forceai_params": {
"model": "openai/gpt-4o",
"custom_llm_provider": "openai",
"api_key": "sk-..."
},
"model_info": { "mode": "chat" }
}
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({
model_name: 'gpt-4o',
forceai_params: {model: 'openai/gpt-4o', custom_llm_provider: 'openai', api_key: 'sk-...'},
model_info: {mode: 'chat'}
})
};
fetch('https://gateway.your-domain.com/model/new', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway.your-domain.com/model/new",
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([
'model_name' => 'gpt-4o',
'forceai_params' => [
'model' => 'openai/gpt-4o',
'custom_llm_provider' => 'openai',
'api_key' => 'sk-...'
],
'model_info' => [
'mode' => 'chat'
]
]),
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 := "https://gateway.your-domain.com/model/new"
payload := strings.NewReader("{\n \"model_name\": \"gpt-4o\",\n \"forceai_params\": {\n \"model\": \"openai/gpt-4o\",\n \"custom_llm_provider\": \"openai\",\n \"api_key\": \"sk-...\"\n },\n \"model_info\": {\n \"mode\": \"chat\"\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("https://gateway.your-domain.com/model/new")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model_name\": \"gpt-4o\",\n \"forceai_params\": {\n \"model\": \"openai/gpt-4o\",\n \"custom_llm_provider\": \"openai\",\n \"api_key\": \"sk-...\"\n },\n \"model_info\": {\n \"mode\": \"chat\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.your-domain.com/model/new")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model_name\": \"gpt-4o\",\n \"forceai_params\": {\n \"model\": \"openai/gpt-4o\",\n \"custom_llm_provider\": \"openai\",\n \"api_key\": \"sk-...\"\n },\n \"model_info\": {\n \"mode\": \"chat\"\n }\n}"
response = http.request(request)
puts response.read_body{
"model_name": "gpt-4o",
"model_info": {
"id": "504f9647-...",
"mode": "chat"
}
}{
"error": {
"message": "Authentication Error, No api key passed in."
}
}Authorizations
A ForceAI virtual key or the master key, sent as Authorization: Bearer <key>.
Body
application/json
Response
The created model