Create saved AI provider
curl --request POST \
--url http://localhost:3000/api/openapi/ai-providers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"model": "<string>",
"apiKey": "<string>",
"baseURL": ""
}
'import requests
url = "http://localhost:3000/api/openapi/ai-providers"
payload = {
"label": "<string>",
"model": "<string>",
"apiKey": "<string>",
"baseURL": ""
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: '<string>', model: '<string>', apiKey: '<string>', baseURL: ''})
};
fetch('http://localhost:3000/api/openapi/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/ai-providers",
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([
'label' => '<string>',
'model' => '<string>',
'apiKey' => '<string>',
'baseURL' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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/openapi/ai-providers"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"model\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"baseURL\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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/openapi/ai-providers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"model\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"baseURL\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/ai-providers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"model\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"baseURL\": \"\"\n}"
response = http.request(request)
puts response.read_body"<unknown>"{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "Invalid AI provider configuration.",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "AI agent workspace is not configured.",
"data": "<unknown>"
}AI Providers
Create saved AI provider
Stores an encrypted provider/model/API key combination. The key is never returned.
POST
/
ai-providers
Create saved AI provider
curl --request POST \
--url http://localhost:3000/api/openapi/ai-providers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"model": "<string>",
"apiKey": "<string>",
"baseURL": ""
}
'import requests
url = "http://localhost:3000/api/openapi/ai-providers"
payload = {
"label": "<string>",
"model": "<string>",
"apiKey": "<string>",
"baseURL": ""
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: '<string>', model: '<string>', apiKey: '<string>', baseURL: ''})
};
fetch('http://localhost:3000/api/openapi/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/ai-providers",
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([
'label' => '<string>',
'model' => '<string>',
'apiKey' => '<string>',
'baseURL' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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/openapi/ai-providers"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"model\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"baseURL\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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/openapi/ai-providers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"model\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"baseURL\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/openapi/ai-providers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"model\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"baseURL\": \"\"\n}"
response = http.request(request)
puts response.read_body"<unknown>"{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "Invalid AI provider configuration.",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "AI agent workspace is not configured.",
"data": "<unknown>"
}Authorizations
The API key to authenticate requests.
Body
application/json
Response
OK
The response is of type any.
⌘I