Update A Registered External Chat Completions Agent.
curl --request PATCH \
--url https://{api_endpoint}/v1/agents/external-chat/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"name": "<string>",
"api_url": "<string>",
"auth_config": {},
"chat_params": {},
"instructions": "<string>",
"nickname": "<string>",
"connection_id": "<string>",
"config": {
"hidden": false,
"enable_cot": false
},
"context_access_enabled": true,
"context_variables": [
"<string>"
]
}
'import requests
url = "https://{api_endpoint}/v1/agents/external-chat/{id}"
payload = {
"title": "<string>",
"description": "<string>",
"tags": ["<string>"],
"name": "<string>",
"api_url": "<string>",
"auth_config": {},
"chat_params": {},
"instructions": "<string>",
"nickname": "<string>",
"connection_id": "<string>",
"config": {
"hidden": False,
"enable_cot": False
},
"context_access_enabled": True,
"context_variables": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
tags: ['<string>'],
name: '<string>',
api_url: '<string>',
auth_config: {},
chat_params: {},
instructions: '<string>',
nickname: '<string>',
connection_id: '<string>',
config: {hidden: false, enable_cot: false},
context_access_enabled: true,
context_variables: ['<string>']
})
};
fetch('https://{api_endpoint}/v1/agents/external-chat/{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_endpoint}/v1/agents/external-chat/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'description' => '<string>',
'tags' => [
'<string>'
],
'name' => '<string>',
'api_url' => '<string>',
'auth_config' => [
],
'chat_params' => [
],
'instructions' => '<string>',
'nickname' => '<string>',
'connection_id' => '<string>',
'config' => [
'hidden' => false,
'enable_cot' => false
],
'context_access_enabled' => true,
'context_variables' => [
'<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_endpoint}/v1/agents/external-chat/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"api_url\": \"<string>\",\n \"auth_config\": {},\n \"chat_params\": {},\n \"instructions\": \"<string>\",\n \"nickname\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"config\": {\n \"hidden\": false,\n \"enable_cot\": false\n },\n \"context_access_enabled\": true,\n \"context_variables\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://{api_endpoint}/v1/agents/external-chat/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"api_url\": \"<string>\",\n \"auth_config\": {},\n \"chat_params\": {},\n \"instructions\": \"<string>\",\n \"nickname\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"config\": {\n \"hidden\": false,\n \"enable_cot\": false\n },\n \"context_access_enabled\": true,\n \"context_variables\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/agents/external-chat/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"api_url\": \"<string>\",\n \"auth_config\": {},\n \"chat_params\": {},\n \"instructions\": \"<string>\",\n \"nickname\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"config\": {\n \"hidden\": false,\n \"enable_cot\": false\n },\n \"context_access_enabled\": true,\n \"context_variables\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}External Chat Agents
Update A Registered External Chat Completions Agent.
Update A Registered External Chat Completions Agent.
curl --request PATCH \
--url https://{api_endpoint}/v1/agents/external-chat/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"name": "<string>",
"api_url": "<string>",
"auth_config": {},
"chat_params": {},
"instructions": "<string>",
"nickname": "<string>",
"connection_id": "<string>",
"config": {
"hidden": false,
"enable_cot": false
},
"context_access_enabled": true,
"context_variables": [
"<string>"
]
}
'import requests
url = "https://{api_endpoint}/v1/agents/external-chat/{id}"
payload = {
"title": "<string>",
"description": "<string>",
"tags": ["<string>"],
"name": "<string>",
"api_url": "<string>",
"auth_config": {},
"chat_params": {},
"instructions": "<string>",
"nickname": "<string>",
"connection_id": "<string>",
"config": {
"hidden": False,
"enable_cot": False
},
"context_access_enabled": True,
"context_variables": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
tags: ['<string>'],
name: '<string>',
api_url: '<string>',
auth_config: {},
chat_params: {},
instructions: '<string>',
nickname: '<string>',
connection_id: '<string>',
config: {hidden: false, enable_cot: false},
context_access_enabled: true,
context_variables: ['<string>']
})
};
fetch('https://{api_endpoint}/v1/agents/external-chat/{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_endpoint}/v1/agents/external-chat/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'description' => '<string>',
'tags' => [
'<string>'
],
'name' => '<string>',
'api_url' => '<string>',
'auth_config' => [
],
'chat_params' => [
],
'instructions' => '<string>',
'nickname' => '<string>',
'connection_id' => '<string>',
'config' => [
'hidden' => false,
'enable_cot' => false
],
'context_access_enabled' => true,
'context_variables' => [
'<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_endpoint}/v1/agents/external-chat/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"api_url\": \"<string>\",\n \"auth_config\": {},\n \"chat_params\": {},\n \"instructions\": \"<string>\",\n \"nickname\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"config\": {\n \"hidden\": false,\n \"enable_cot\": false\n },\n \"context_access_enabled\": true,\n \"context_variables\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://{api_endpoint}/v1/agents/external-chat/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"api_url\": \"<string>\",\n \"auth_config\": {},\n \"chat_params\": {},\n \"instructions\": \"<string>\",\n \"nickname\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"config\": {\n \"hidden\": false,\n \"enable_cot\": false\n },\n \"context_access_enabled\": true,\n \"context_variables\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/agents/external-chat/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"api_url\": \"<string>\",\n \"auth_config\": {},\n \"chat_params\": {},\n \"instructions\": \"<string>\",\n \"nickname\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"config\": {\n \"hidden\": false,\n \"enable_cot\": false\n },\n \"context_access_enabled\": true,\n \"context_variables\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Available options:
BEARER_TOKEN, API_KEY, NONE Show child attributes
Show child attributes
Enable access to context variables for this agent
List of context variable names that this agent can access
Response
Successful Response
⌘I

