API Documentation
Agent
Create agent
POST
/
api
/
v1
/
agents
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": "john.doe@example.com",
"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
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
Input data for creating an AI agent
The body is of type object
.
Response
201
application/json
The created AI agent
The response is of type object
.
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": "john.doe@example.com",
"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"
}