PATCH
/
agents
/
{id}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
description
string
required
modelName
enum<string>
Available options:
gpt_3_5_turbo,
gpt_3_5_turbo_16k,
gpt_4,
gpt_4_32k
temperature
number

Temperature of the model (min 0.0, max 1.0)

systemPrompt
string

Agent system prompt

userPrompt
string

Agent user prompt

promptType
enum<string>

(DEPRECATED in favor of systemPrompt and userPrompt) Set the prompt type for this query

Available options:
raw,
customer_support
promptTemplate
string

(DEPRECATED in favor of systemPrompt and userPrompt) Set the prompt template for this query

visibility
enum<string>
Available options:
public,
private

Response

200 - application/json
id
string
name
string
description
string
modelName
enum<string>
Available options:
gpt_3_5_turbo,
gpt_3_5_turbo_16k,
gpt_4,
gpt_4_32k
temperature
number

Temperature of the model (min 0.0, max 1.0)

visibility
enum<string>
Available options:
public,
private
systemPrompt
string

Agent system prompt

userPrompt
string

Agent user prompt

promptType
enum<string>
deprecated

(DEPRECATED in favor of systemPrompt and userPrompt) Set the prompt type for this query

Available options:
raw,
customer_support
promptTemplate
string
deprecated

(DEPRECATED in favor of systemPrompt and userPrompt) Set the prompt template for this query

Was this page helpful?

Agent - GetAgent - Delete