Create or replace a model provider
curl --request PUT \
--url https://api.example.com/api/v1/settings/model-providers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"auth": {
"api_key": "<string>"
},
"models": [
{
"model_id": "<string>",
"name": "<string>",
"properties": {
"context_length": 123,
"max_output_tokens": 123,
"reasoning_efforts": []
}
}
],
"type": "openai",
"base_url": "https://api.openai.com/v1"
}
}
'import requests
url = "https://api.example.com/api/v1/settings/model-providers"
payload = { "manifest": {
"auth": { "api_key": "<string>" },
"models": [
{
"model_id": "<string>",
"name": "<string>",
"properties": {
"context_length": 123,
"max_output_tokens": 123,
"reasoning_efforts": []
}
}
],
"type": "openai",
"base_url": "https://api.openai.com/v1"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest: {
auth: {api_key: '<string>'},
models: [
{
model_id: '<string>',
name: '<string>',
properties: {context_length: 123, max_output_tokens: 123, reasoning_efforts: []}
}
],
type: 'openai',
base_url: 'https://api.openai.com/v1'
}
})
};
fetch('https://api.example.com/api/v1/settings/model-providers', 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://api.example.com/api/v1/settings/model-providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => [
'auth' => [
'api_key' => '<string>'
],
'models' => [
[
'model_id' => '<string>',
'name' => '<string>',
'properties' => [
'context_length' => 123,
'max_output_tokens' => 123,
'reasoning_efforts' => [
]
]
]
],
'type' => 'openai',
'base_url' => 'https://api.openai.com/v1'
]
]),
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://api.example.com/api/v1/settings/model-providers"
payload := strings.NewReader("{\n \"manifest\": {\n \"auth\": {\n \"api_key\": \"<string>\"\n },\n \"models\": [\n {\n \"model_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {\n \"context_length\": 123,\n \"max_output_tokens\": 123,\n \"reasoning_efforts\": []\n }\n }\n ],\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/v1/settings/model-providers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"auth\": {\n \"api_key\": \"<string>\"\n },\n \"models\": [\n {\n \"model_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {\n \"context_length\": 123,\n \"max_output_tokens\": 123,\n \"reasoning_efforts\": []\n }\n }\n ],\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/settings/model-providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": {\n \"auth\": {\n \"api_key\": \"<string>\"\n },\n \"models\": [\n {\n \"model_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {\n \"context_length\": 123,\n \"max_output_tokens\": 123,\n \"reasoning_efforts\": []\n }\n }\n ],\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"manifest": {
"auth": {
"api_key": "<string>"
},
"models": [
{
"model_id": "<string>",
"name": "<string>",
"properties": {
"context_length": 123,
"max_output_tokens": 123,
"reasoning_efforts": [
"none"
]
}
}
],
"type": "openai",
"base_url": "https://api.openai.com/v1"
},
"name": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"param": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"param": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"param": "<string>",
"type": "<string>"
}
}Models
Create or replace a model provider
Create or replace a provider (models included). Well-known types use type as name (one each); custom is named by the caller. auth.api_key: real value sets/rotates; redacted keeps existing (400 if none).
PUT
/
api
/
v1
/
settings
/
model-providers
Create or replace a model provider
curl --request PUT \
--url https://api.example.com/api/v1/settings/model-providers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"auth": {
"api_key": "<string>"
},
"models": [
{
"model_id": "<string>",
"name": "<string>",
"properties": {
"context_length": 123,
"max_output_tokens": 123,
"reasoning_efforts": []
}
}
],
"type": "openai",
"base_url": "https://api.openai.com/v1"
}
}
'import requests
url = "https://api.example.com/api/v1/settings/model-providers"
payload = { "manifest": {
"auth": { "api_key": "<string>" },
"models": [
{
"model_id": "<string>",
"name": "<string>",
"properties": {
"context_length": 123,
"max_output_tokens": 123,
"reasoning_efforts": []
}
}
],
"type": "openai",
"base_url": "https://api.openai.com/v1"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest: {
auth: {api_key: '<string>'},
models: [
{
model_id: '<string>',
name: '<string>',
properties: {context_length: 123, max_output_tokens: 123, reasoning_efforts: []}
}
],
type: 'openai',
base_url: 'https://api.openai.com/v1'
}
})
};
fetch('https://api.example.com/api/v1/settings/model-providers', 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://api.example.com/api/v1/settings/model-providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => [
'auth' => [
'api_key' => '<string>'
],
'models' => [
[
'model_id' => '<string>',
'name' => '<string>',
'properties' => [
'context_length' => 123,
'max_output_tokens' => 123,
'reasoning_efforts' => [
]
]
]
],
'type' => 'openai',
'base_url' => 'https://api.openai.com/v1'
]
]),
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://api.example.com/api/v1/settings/model-providers"
payload := strings.NewReader("{\n \"manifest\": {\n \"auth\": {\n \"api_key\": \"<string>\"\n },\n \"models\": [\n {\n \"model_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {\n \"context_length\": 123,\n \"max_output_tokens\": 123,\n \"reasoning_efforts\": []\n }\n }\n ],\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/v1/settings/model-providers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"auth\": {\n \"api_key\": \"<string>\"\n },\n \"models\": [\n {\n \"model_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {\n \"context_length\": 123,\n \"max_output_tokens\": 123,\n \"reasoning_efforts\": []\n }\n }\n ],\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/settings/model-providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": {\n \"auth\": {\n \"api_key\": \"<string>\"\n },\n \"models\": [\n {\n \"model_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {\n \"context_length\": 123,\n \"max_output_tokens\": 123,\n \"reasoning_efforts\": []\n }\n }\n ],\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"manifest": {
"auth": {
"api_key": "<string>"
},
"models": [
{
"model_id": "<string>",
"name": "<string>",
"properties": {
"context_length": 123,
"max_output_tokens": 123,
"reasoning_efforts": [
"none"
]
}
}
],
"type": "openai",
"base_url": "https://api.openai.com/v1"
},
"name": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"param": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"param": "<string>",
"type": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"param": "<string>",
"type": "<string>"
}
}Authorizations
Caller credential (Authorization: Bearer <token>). Required on protected routes when auth is enabled. Browser sessions may use the HttpOnly id_token or accessToken cookie instead.
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
Show child attributes
Show child attributes
Response
The saved provider
Show child attributes
Show child attributes