Skip to main content
POST
/
api
/
v1
/
agents
{
  "fullName": "<string>",
  "welcomeText": "<string>",
  "systemPrompt": "<string>",
  "role": "<string>",
  "description": "<string>",
  "modelId": "<string>",
  "temperature": 0,
  "top_p": 123,
  "top_k": 123,
  "frequency_penalty": 123,
  "isPublic": false,
  "maxTimeoutInSeconds": 123,
  "toolIds": [
    "<string>"
  ],
  "knowledgeStoreId": "<string>",
  "knowledgeStoreParams": {}
}

Authorizations

​
Authorization
string
header
required

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

Body

multipart/form-data
​
fullName
string
required

The full name of the agent

​
welcomeText
string
required

The Welcome message for the agent (2-1000 characters)

​
systemPrompt
string
required

The system prompt for the agent (min 128 characters)

​
role
string
required

The Role of the agent, like Du Telecom customer support

​
description
string
required

The description of the agent

​
modelId
string
required

The ID of the model

​
temperature
number
default:0
required

The temperature for the model (0 to 1)

​
isPublic
boolean
default:false
required

Whether the agent is public or not

​
maxTimeoutInSeconds
number
required

Max timeout for an agent in seconds

​
toolIds
string[]
required

The tool ids

​
knowledgeStoreId
string
required

The knowledge store id

​
knowledgeStoreParams
object
required

The knowledge store id

​
top_p
number

The top_p value for the model

​
top_k
number

The top_k value for the model

​
frequency_penalty
number

The frequency_penalty for the model

​
avatar
file

The avatar file for the agent (optional, max 2MB, image files only)

Response

The agent has been successfully created.

​
fullName
string
required

The full name of the agent

​
welcomeText
string
required

The Welcome message for the agent (2-1000 characters)

​
systemPrompt
string
required

The system prompt for the agent (min 128 characters)

​
role
string
required

The Role of the agent, like Du Telecom customer support

​
description
string
required

The description of the agent

​
modelId
string
required

The ID of the model

​
temperature
number
default:0
required

The temperature for the model (0 to 1)

​
isPublic
boolean
default:false
required

Whether the agent is public or not

​
maxTimeoutInSeconds
number
required

Max timeout for an agent in seconds

​
toolIds
string[]
required

The tool ids

​
knowledgeStoreId
string
required

The knowledge store id

​
knowledgeStoreParams
object
required

The knowledge store id

​
top_p
number

The top_p value for the model

​
top_k
number

The top_k value for the model

​
frequency_penalty
number

The frequency_penalty for the model

​
avatar
file

The avatar file for the agent (optional, max 2MB, image files only)