v1
Update Provider Config
Update a provider configuration (full replace via PUT).
PUT
/
v1
/
provider-configs
/
{config_id}
Update Provider Config
curl --request PUT \
--url https://api.example.com/v1/provider-configs/{config_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"api_key": "<string>",
"api_key_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"endpoint_url": "<string>",
"is_active": true,
"is_public": true,
"name": "<string>"
}
'import requests
url = "https://api.example.com/v1/provider-configs/{config_id}"
payload = {
"api_key": "<string>",
"api_key_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"endpoint_url": "<string>",
"is_active": True,
"is_public": True,
"name": "<string>"
}
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({
api_key: '<string>',
api_key_secret_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
endpoint_url: '<string>',
is_active: true,
is_public: true,
name: '<string>'
})
};
fetch('https://api.example.com/v1/provider-configs/{config_id}', 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/provider-configs/{config_id}",
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([
'api_key' => '<string>',
'api_key_secret_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'endpoint_url' => '<string>',
'is_active' => true,
'is_public' => true,
'name' => '<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 := "https://api.example.com/v1/provider-configs/{config_id}"
payload := strings.NewReader("{\n \"api_key\": \"<string>\",\n \"api_key_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"is_active\": true,\n \"is_public\": true,\n \"name\": \"<string>\"\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/v1/provider-configs/{config_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"api_key\": \"<string>\",\n \"api_key_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"is_active\": true,\n \"is_public\": true,\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/provider-configs/{config_id}")
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 \"api_key\": \"<string>\",\n \"api_key_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"is_active\": true,\n \"is_public\": true,\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "<string>",
"created_by": "<string>",
"endpoint_url": "<string>",
"id": "<string>",
"is_active": true,
"is_public": true,
"name": "<string>",
"provider_spec_id": "<string>",
"updated_at": "<string>",
"workspace_id": "<string>",
"model_instance_ids": [],
"provider_spec_key": "<string>",
"provider_spec_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Patch payload for an existing provider configuration. Unset = unchanged.
New API key. Replaces the previously stored secret. Send an empty string to clear the key for keyless custom endpoints.
Point this configuration at an existing workspace secret instead. Mutually exclusive with api_key.
New description for the configuration.
Maximum string length:
1000New endpoint URL, or empty string to clear.
Activate or deactivate the configuration.
Toggle workspace-wide visibility.
New human-readable label for the configuration.
Required string length:
1 - 255Response
Successful Response
⌘I
Update Provider Config
curl --request PUT \
--url https://api.example.com/v1/provider-configs/{config_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"api_key": "<string>",
"api_key_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"endpoint_url": "<string>",
"is_active": true,
"is_public": true,
"name": "<string>"
}
'import requests
url = "https://api.example.com/v1/provider-configs/{config_id}"
payload = {
"api_key": "<string>",
"api_key_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"endpoint_url": "<string>",
"is_active": True,
"is_public": True,
"name": "<string>"
}
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({
api_key: '<string>',
api_key_secret_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
endpoint_url: '<string>',
is_active: true,
is_public: true,
name: '<string>'
})
};
fetch('https://api.example.com/v1/provider-configs/{config_id}', 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/provider-configs/{config_id}",
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([
'api_key' => '<string>',
'api_key_secret_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'endpoint_url' => '<string>',
'is_active' => true,
'is_public' => true,
'name' => '<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 := "https://api.example.com/v1/provider-configs/{config_id}"
payload := strings.NewReader("{\n \"api_key\": \"<string>\",\n \"api_key_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"is_active\": true,\n \"is_public\": true,\n \"name\": \"<string>\"\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/v1/provider-configs/{config_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"api_key\": \"<string>\",\n \"api_key_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"is_active\": true,\n \"is_public\": true,\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/provider-configs/{config_id}")
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 \"api_key\": \"<string>\",\n \"api_key_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"is_active\": true,\n \"is_public\": true,\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "<string>",
"created_by": "<string>",
"endpoint_url": "<string>",
"id": "<string>",
"is_active": true,
"is_public": true,
"name": "<string>",
"provider_spec_id": "<string>",
"updated_at": "<string>",
"workspace_id": "<string>",
"model_instance_ids": [],
"provider_spec_key": "<string>",
"provider_spec_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}