GET
/
agents
/
{id}
curl --request GET \
  --url https://api.chatvolt.ai/agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "modelName": "gpt_4_o",
  "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_4_o,
gpt_4o_medium,
gpt_4o_extended,
gpt_4o_mini,
gpt_4o_mini_medium,
gpt_4o_mini_extended,
gpt_o1,
gpt_o1_mini,
gpt_o1_mini_medium,
gemini_pro,
gemini_pro_vision,
gemini_pro_1_5,
gemini_flash_1_5,
gemini_flash_1_5_8b,
gemma_2_9b,
gemma_2_27b,
llama_3_8b_instruct,
llama_3_70b_instruct,
llama_3_405b_instruct,
llama_3_11b_vision,
llama_3_90b_vision,
command_r,
openchat_8b,
claude_3_haiku,
claude_3_sonnet,
claude_3_opus,
mistral_7b_instruct,
mixtral_8x7b,
mixtral_8x22b,
mistral_large,
mistral_nemo,
dolphin_mixtral_8x7b,
mythomax_l2_13b,
wizardlm_2,
phi_3_medium,
phi_3_mini,
deepseek_coder,
sabia_3,
grok_2,
perplexity_llama_8b_online,
perplexity_llama_70b_online,
groq_gemma2_7b,
groq_gemma2_9b,
groq_llama3_8b_tools,
groq_llama3_70b_tools,
groq_llama3_1b,
groq_llama3_3b,
groq_llama3_11b,
groq_llama3_90b,
groq_mixtral_8x7b
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