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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

ID of the AI Employee

Body

application/json · object

Response

Success

​
id
string
​
name
string
​
description
string
​
modelName
enum<string>
Available options:
gpt_4o_mini_2024_07_18,
gpt_4o_2024_11_20,
gemini_flash_2_0,
gemini_flash_2_5,
gemini_pro_2_5,
claude_3_5_haiku,
claude_3_5_sonnet,
mixtral_8x7b,
mixtral_8x22b,
dolphin_mixtral_8x7b
​
temperature
number

Temperature of the model (min 0.0, max 1.0)

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

AI Employee System Prompt

​
userPrompt
string

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