GET
/
agents
/
{id}
curl --request GET \
  --url https://app.maximai.biz/agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "modelName": "gpt_3_5_turbo",
  "temperature": 123,
  "visibility": "public",
  "systemPrompt": "<string>",
  "userPrompt": "<string>",
  "promptType": "raw",
  "promptTemplate": "<string>"
}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

ID of the Agent

Body

application/json · object

The body is of type object.

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 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

Was this page helpful?

Agent - CreateAgent - Update