Skip to main content
POST
/
api
/
v1
/
agents
Create agent
curl --request POST \
  --url https://api.elemente.ai/api/v1/agents \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentType": "AI",
  "roleText": "Customer Support",
  "capabilities": [],
  "inboundCapability": "answer",
  "jobDescriptions": "Customer Support",
  "baseInstructions": "Welcome to our customer support!",
  "temperature": "0.7",
  "modelProvider": "OpenAI",
  "modelName": "gpt-4o",
  "actions": [
    "<string>"
  ],
  "leadQualification": "<string>",
  "globalActions": [
    "<string>"
  ],
  "skillId": "Customer Support Representative",
  "skills": [
    "<string>"
  ],
  "language": "en-US",
  "voiceStability": 0.5,
  "voiceSpeed": 1.5,
  "voiceId": "1234567890",
  "optimizeStreamingLatency": true,
  "sendFillerWords": false,
  "sendInitialMessage": true,
  "fillerWords": [
    "Got it.",
    "Understood",
    "Awesome"
  ],
  "cutoffResponses": [
    "Can you repeat that?",
    "Sorry, I didn'\''t get that.",
    "I didn'\''t understand that.",
    "Can you talk a little bit slow?"
  ],
  "enableCutoffResponses": true,
  "endCallOnGoodBye": true,
  "goodByePhrases": [
    "Goodbye",
    "Talk to you later"
  ],
  "allowedIdleTime": 10,
  "checkHumanPresence": true,
  "checkHumanPresenceCount": 5,
  "allowInterruption": true,
  "interruptionSensitivity": "high",
  "functionality": "interactive",
  "interactionSettings": {
    "channel": "call",
    "direction": "outbound",
    "inbound": true,
    "outbound": true
  },
  "name": "John Doe",
  "nickname": "John Seller",
  "lastname": "Doe",
  "imageURL": "https://example.com/image.jpg",
  "phone": "+1234567890",
  "isInbound": false,
  "workspace": false
}'
{
  "id": "1234567890",
  "name": "John Doe",
  "email": "[email protected]",
  "language": "en-US",
  "active": true,
  "voiceSpeed": 1.5,
  "voiceId": "1234567890",
  "capabilities": [
    "capability1",
    "capability2"
  ],
  "jobDescriptions": "Job description 1",
  "roleText": "Role text 1",
  "actions": [
    {
      "id": "1234567890",
      "name": "Action 1",
      "action": "action1",
      "parameters": {}
    }
  ],
  "skills": [
    {
      "id": "1234567890",
      "name": "Skill 1",
      "description": "Description of the skill 1",
      "language": "en-US",
      "active": true
    }
  ],
  "phone": "+1234567890",
  "updatedAt": "2022-01-01T00:00:00.000Z",
  "createdAt": "2022-01-01T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
leadQualification
string
required
​
functionality
string
required
Example:
​
lastname
string | null
required
Example:
​
imageURL
string | null
required
Example:
​
phone
string | null
required
Example:
​
isInbound
boolean | null
required
Example:
​
workspace
string | null
required
Example:
​
agentType
string
Example:
​
roleText
string | null
Example:
​
capabilities
string[] | null
Example:
​
inboundCapability
string | null
Example:
​
jobDescriptions
string | null
Example:
​
baseInstructions
string | null
Example:
​
temperature
number
Example:
​
modelProvider
string
Example:
​
modelName
string
Example:
​
actions
string[]
​
globalActions
string[]
​
skillId
string
Example:
​
skills
string[]
​
language
string | null
Example:
​
voiceStability
number | null
Example:
​
voiceSpeed
number | null
Example:
​
voiceId
string | null
Example:
​
optimizeStreamingLatency
boolean
Example:
​
sendFillerWords
boolean
Example:
​
sendInitialMessage
boolean
Example:
​
fillerWords
string[]
Example:
​
cutoffResponses
string[]
Example:
​
enableCutoffResponses
boolean
Example:
​
endCallOnGoodBye
boolean
Example:
​
goodByePhrases
string[]
Example:
​
allowedIdleTime
number
Example:
​
checkHumanPresence
boolean
Example:
​
checkHumanPresenceCount
number
Example:
​
allowInterruption
boolean
Example:
​
interruptionSensitivity
string
Example:
​
interactionSettings
object
​
name
string
Example:
​
nickname
string
Example:

Response

​
id
string
required
Example:
​
name
string | null
required
Example:
​
email
string | null
required
Example:
​
language
string | null
required
Example:
​
active
boolean | null
required
Example:
​
voiceSpeed
number | null
required
Example:
​
voiceId
string | null
required
Example:
​
capabilities
string[] | null
required
Example:
​
jobDescriptions
string | null
required
Example:
​
roleText
string | null
required
Example:
​
actions
string[] | null
required
Example:
​
skills
string[] | null
required
Example:
​
phone
string | null
required
Example:
​
updatedAt
string<date-time> | null
required
Example:
​
createdAt
string<date-time> | null
required
Example: