Skip to main content
POST
/
api
/
v2
/
agents
Create a new agent
curl --request POST \
  --url https://dev-chat-engine.actualize.ae/api/v2/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'fullName=<string>' \
  --form 'description=<string>' \
  --form 'role=<string>' \
  --form voiceEnabled=false \
  --form 'specialInstructions=Please generate responses in a conversational and friendly manner.' \
  --form 'language=<string>' \
  --form 'knowledgeStoreId=<string>' \
  --form 'tools={
  "toolId": "<string>",
  "toolDescription": "<string>"
}' \
  --form 'modelId=<string>' \
  --form 'sttModelId=<string>' \
  --form 'ttsModelId=<string>'
{
  "fullName": "<string>",
  "description": "<string>",
  "role": "<string>",
  "voiceEnabled": false,
  "specialInstructions": "Please generate responses in a conversational and friendly manner.",
  "language": "<string>",
  "knowledgeStoreId": "<string>",
  "tools": [
    {
      "toolId": "<string>",
      "toolDescription": "<string>"
    }
  ],
  "modelId": "<string>",
  "sttModelId": "<string>",
  "ttsModelId": "<string>"
}

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

Full name of the agent

description
string
required

Description of the agent

role
string
required

Role of the agent

language
string
required

Language

knowledgeStoreId
string
required

Knowledge store ID

tools
object[]
required

Tools

voiceEnabled
boolean
default:false

To enable voice feature for an agent

specialInstructions
string

Special instructions

Example:

"Please generate responses in a conversational and friendly manner."

modelId
string

The ID of the model

sttModelId
string

The ID of the STT model

ttsModelId
string

The ID of the TTS model

Response

The agent has been successfully created.

fullName
string
required

Full name of the agent

description
string
required

Description of the agent

role
string
required

Role of the agent

language
string
required

Language

knowledgeStoreId
string
required

Knowledge store ID

tools
object[]
required

Tools

voiceEnabled
boolean
default:false

To enable voice feature for an agent

specialInstructions
string

Special instructions

Example:

"Please generate responses in a conversational and friendly manner."

modelId
string

The ID of the model

sttModelId
string

The ID of the STT model

ttsModelId
string

The ID of the TTS model