cURL
curl --request PUT \
--url https://api.example.com/v1/panel/settings/ai/providers \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"slug": "<string>",
"displayName": "<string>",
"enabled": true,
"zeroRetention": true,
"trainsOnData": true,
"keyConfigured": true,
"lastCheckOk": true,
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"retentionNote": "<string>",
"dataRegion": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"lastCheckError": "<string>",
"apiKey": "<string>"
}
'import requests
url = "https://api.example.com/v1/panel/settings/ai/providers"
payload = {
"slug": "<string>",
"displayName": "<string>",
"enabled": True,
"zeroRetention": True,
"trainsOnData": True,
"keyConfigured": True,
"lastCheckOk": True,
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"retentionNote": "<string>",
"dataRegion": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"lastCheckError": "<string>",
"apiKey": "<string>"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
displayName: '<string>',
enabled: true,
zeroRetention: true,
trainsOnData: true,
keyConfigured: true,
lastCheckOk: true,
updatedAt: '2023-11-07T05:31:56Z',
baseUrl: '<string>',
retentionNote: '<string>',
dataRegion: '<string>',
lastCheckedAt: '2023-11-07T05:31:56Z',
lastCheckError: '<string>',
apiKey: '<string>'
})
};
fetch('https://api.example.com/v1/panel/settings/ai/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/v1/panel/settings/ai/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([
'slug' => '<string>',
'displayName' => '<string>',
'enabled' => true,
'zeroRetention' => true,
'trainsOnData' => true,
'keyConfigured' => true,
'lastCheckOk' => true,
'updatedAt' => '2023-11-07T05:31:56Z',
'baseUrl' => '<string>',
'retentionNote' => '<string>',
'dataRegion' => '<string>',
'lastCheckedAt' => '2023-11-07T05:31:56Z',
'lastCheckError' => '<string>',
'apiKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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/v1/panel/settings/ai/providers"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"zeroRetention\": true,\n \"trainsOnData\": true,\n \"keyConfigured\": true,\n \"lastCheckOk\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"baseUrl\": \"<string>\",\n \"retentionNote\": \"<string>\",\n \"dataRegion\": \"<string>\",\n \"lastCheckedAt\": \"2023-11-07T05:31:56Z\",\n \"lastCheckError\": \"<string>\",\n \"apiKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-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/v1/panel/settings/ai/providers")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"zeroRetention\": true,\n \"trainsOnData\": true,\n \"keyConfigured\": true,\n \"lastCheckOk\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"baseUrl\": \"<string>\",\n \"retentionNote\": \"<string>\",\n \"dataRegion\": \"<string>\",\n \"lastCheckedAt\": \"2023-11-07T05:31:56Z\",\n \"lastCheckError\": \"<string>\",\n \"apiKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/ai/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"zeroRetention\": true,\n \"trainsOnData\": true,\n \"keyConfigured\": true,\n \"lastCheckOk\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"baseUrl\": \"<string>\",\n \"retentionNote\": \"<string>\",\n \"dataRegion\": \"<string>\",\n \"lastCheckedAt\": \"2023-11-07T05:31:56Z\",\n \"lastCheckError\": \"<string>\",\n \"apiKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"kind": "openai_compatible",
"displayName": "<string>",
"enabled": true,
"zeroRetention": true,
"trainsOnData": true,
"keyConfigured": true,
"lastCheckOk": true,
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"retentionNote": "<string>",
"dataRegion": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"lastCheckError": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}panel
Put v1panelsettingsaiproviders
Requires settings.write. An omitted apiKey leaves the stored credential alone, so a display name can be corrected without re-pasting a secret.
PUT
/
v1
/
panel
/
settings
/
ai
/
providers
cURL
curl --request PUT \
--url https://api.example.com/v1/panel/settings/ai/providers \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"slug": "<string>",
"displayName": "<string>",
"enabled": true,
"zeroRetention": true,
"trainsOnData": true,
"keyConfigured": true,
"lastCheckOk": true,
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"retentionNote": "<string>",
"dataRegion": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"lastCheckError": "<string>",
"apiKey": "<string>"
}
'import requests
url = "https://api.example.com/v1/panel/settings/ai/providers"
payload = {
"slug": "<string>",
"displayName": "<string>",
"enabled": True,
"zeroRetention": True,
"trainsOnData": True,
"keyConfigured": True,
"lastCheckOk": True,
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"retentionNote": "<string>",
"dataRegion": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"lastCheckError": "<string>",
"apiKey": "<string>"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
displayName: '<string>',
enabled: true,
zeroRetention: true,
trainsOnData: true,
keyConfigured: true,
lastCheckOk: true,
updatedAt: '2023-11-07T05:31:56Z',
baseUrl: '<string>',
retentionNote: '<string>',
dataRegion: '<string>',
lastCheckedAt: '2023-11-07T05:31:56Z',
lastCheckError: '<string>',
apiKey: '<string>'
})
};
fetch('https://api.example.com/v1/panel/settings/ai/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/v1/panel/settings/ai/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([
'slug' => '<string>',
'displayName' => '<string>',
'enabled' => true,
'zeroRetention' => true,
'trainsOnData' => true,
'keyConfigured' => true,
'lastCheckOk' => true,
'updatedAt' => '2023-11-07T05:31:56Z',
'baseUrl' => '<string>',
'retentionNote' => '<string>',
'dataRegion' => '<string>',
'lastCheckedAt' => '2023-11-07T05:31:56Z',
'lastCheckError' => '<string>',
'apiKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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/v1/panel/settings/ai/providers"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"zeroRetention\": true,\n \"trainsOnData\": true,\n \"keyConfigured\": true,\n \"lastCheckOk\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"baseUrl\": \"<string>\",\n \"retentionNote\": \"<string>\",\n \"dataRegion\": \"<string>\",\n \"lastCheckedAt\": \"2023-11-07T05:31:56Z\",\n \"lastCheckError\": \"<string>\",\n \"apiKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-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/v1/panel/settings/ai/providers")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"zeroRetention\": true,\n \"trainsOnData\": true,\n \"keyConfigured\": true,\n \"lastCheckOk\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"baseUrl\": \"<string>\",\n \"retentionNote\": \"<string>\",\n \"dataRegion\": \"<string>\",\n \"lastCheckedAt\": \"2023-11-07T05:31:56Z\",\n \"lastCheckError\": \"<string>\",\n \"apiKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/settings/ai/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"displayName\": \"<string>\",\n \"enabled\": true,\n \"zeroRetention\": true,\n \"trainsOnData\": true,\n \"keyConfigured\": true,\n \"lastCheckOk\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"baseUrl\": \"<string>\",\n \"retentionNote\": \"<string>\",\n \"dataRegion\": \"<string>\",\n \"lastCheckedAt\": \"2023-11-07T05:31:56Z\",\n \"lastCheckError\": \"<string>\",\n \"apiKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"kind": "openai_compatible",
"displayName": "<string>",
"enabled": true,
"zeroRetention": true,
"trainsOnData": true,
"keyConfigured": true,
"lastCheckOk": true,
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"retentionNote": "<string>",
"dataRegion": "<string>",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"lastCheckError": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Headers
Echoes the token from the current session. Required on every unsafe method.
Body
application/json
Pattern:
^[a-z0-9][a-z0-9_-]{1,40}$Available options:
openai_compatible, anthropic, gemini Required string length:
1 - 120The owner's answer from the provider's own terms. Omniflow cannot verify it and does not pretend to; it is recorded so the panel can warn before a feature is switched on rather than after data left.
Whether a credential is stored. The credential itself is never returned.
Where the provider is reached. Required for the OpenAI-compatible adapter, which is how an owner points at a model they host themselves. It is an address rather than a secret and is returned.
Maximum string length:
2000Maximum string length:
60Why the last test failed, or how the last one passed. It never carries the provider's own message, which can echo the prompt, and never a transport error, which can carry a key held in a query string.
Maximum string length:
500Write-only and never returned. Omitting it leaves the stored credential alone, so a display name can be corrected without re-pasting a secret.
Response
Saved
Pattern:
^[a-z0-9][a-z0-9_-]{1,40}$Available options:
openai_compatible, anthropic, gemini Required string length:
1 - 120The owner's answer from the provider's own terms. Omniflow cannot verify it and does not pretend to; it is recorded so the panel can warn before a feature is switched on rather than after data left.
Whether a credential is stored. The credential itself is never returned.
Where the provider is reached. Required for the OpenAI-compatible adapter, which is how an owner points at a model they host themselves. It is an address rather than a secret and is returned.
Maximum string length:
2000Maximum string length:
60Why the last test failed, or how the last one passed. It never carries the provider's own message, which can echo the prompt, and never a transport error, which can carry a key held in a query string.
Maximum string length:
500