PATCH
/
v1
/
agents
/
external-chat
/
{id}
Update A Registered External Chat Completions Agent.
curl --request PATCH \
  --url http://{api_endpoint}/api/v1/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_scheme": "BEARER_TOKEN",
  "auth_config": {},
  "chat_params": {},
  "instructions": "<string>",
  "nickname": "<string>",
  "connection_id": "<string>",
  "config": {
    "hidden": false,
    "enable_cot": false
  },
  "context_access_enabled": true,
  "context_variables": [
    "<string>"
  ]
}'
"<any>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
title
string | null
​
description
string | null
​
tags
string[] | null
​
name
string | null
​
api_url
string | null
​
auth_scheme
enum<string> | null
Available options:
BEARER_TOKEN,
API_KEY,
NONE
​
auth_config
object | null
​
chat_params
object | null
​
instructions
string | null
​
nickname
string | null
​
connection_id
string | null
​
config
object | null
​
context_access_enabled
boolean | null

Enable access to context variables for this agent

​
context_variables
string[] | null

List of context variable names that this agent can access

Response

Successful Response

The response is of type any.