Skip to main content
GET
/
v3
/
characters
List Equos Characters.
curl --request GET \
  --url https://api.equos.ai/v3/characters \
  --header 'x-api-key: <api-key>'
{
  "skip": 123,
  "take": 123,
  "total": 123,
  "characters": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "livekitIdentity": "<string>",
      "search": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "client": "<string>",
      "elevenlabsAgentId": "<string>",
      "faceId": "<string>",
      "voiceId": "<string>",
      "brainId": "<string>",
      "knowledgeBaseId": "<string>",
      "face": {
        "id": "<string>",
        "identity": "tommy",
        "organizationId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "client": "<string>",
        "description": "<string>",
        "thumbnailUrl": "<string>",
        "referenceImgUrl": "<string>"
      },
      "voice": {
        "id": "<string>",
        "organizationId": "<string>",
        "identity": "Puck",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "client": "<string>",
        "instructions": "<string>"
      },
      "brain": {
        "id": "<string>",
        "organizationId": "<string>",
        "instructions": "<string>",
        "greetingMessage": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "client": "<string>"
      },
      "knowledgeBase": {
        "id": "<string>",
        "organizationId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "documents": [
          {
            "id": "<string>",
            "knowledgeBaseId": "<string>",
            "name": "<string>",
            "description": "<string>",
            "size": 123,
            "status": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "client": "<string>"
      }
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

take
number
default:20
Required range: x <= 50
skip
number
default:0
Required range: x >= 0
client
string

Response

200 - application/json
skip
number
required
take
number
required
total
number
required
characters
object[]
required