GET
/
api
/
v1
/
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

200
application/json

The list of AI agents

The response is of type object[].