GET
/
api
/
v1
/
agents
Get agents
curl --request GET \
  --url https://api.elemente.ai/api/v1/agents \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "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

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

page
number

The page number to return

limit
number

The maximum number of agents to return

Response

The list of AI agents

id
string
required

The id of the agent

Example:

"1234567890"

name
string | null
required

The name of the agent

Example:

"John Doe"

email
string | null
required

The email of the agent

Example:

"john.doe@example.com"

language
string | null
required

The language of the agent

Example:

"en-US"

active
boolean | null
required

The active status of the agent

Example:

true

voiceSpeed
number | null
required

The voice speed of the agent

Example:

1.5

voiceId
string | null
required

The voice id of the agent

Example:

"1234567890"

capabilities
string[] | null
required

The capabilities of the agent

Example:
["capability1", "capability2"]
jobDescriptions
string | null
required

The job descriptions of the agent

Example:

"Job description 1"

roleText
string | null
required

The role text of the agent

Example:

"Role text 1"

actions
string[] | null
required

The actions of the agent

Example:
[
{
"id": "1234567890",
"name": "Action 1",
"action": "action1",
"parameters": {}
}
]
skills
string[] | null
required

The skills of the agent

Example:
[
{
"id": "1234567890",
"name": "Skill 1",
"description": "Description of the skill 1",
"language": "en-US",
"active": true
}
]
phone
string | null
required

The phone number of the agent

Example:

"+1234567890"

updatedAt
string<date-time> | null
required

The updatedAt date of the agent

Example:

"2022-01-01T00:00:00.000Z"

createdAt
string<date-time> | null
required

The createdAt date of the agent

Example:

"2022-01-01T00:00:00.000Z"