Skip to main content
POST
/
v3
/
conversations
Start an Equos avatar sesssion.
curl --request POST \
  --url https://api.equos.ai/v3/conversations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "characterId": "<string>",
  "client": "<string>",
  "maxSeconds": 123,
  "promptCtx": "<string>",
  "promptTemplateVars": {}
}
'
{
  "conversation": {
    "id": "<string>",
    "name": "<string>",
    "status": "running",
    "charge": true,
    "chargeBySecond": 123,
    "maxSeconds": 123,
    "startedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "characterId": "<string>",
    "organizationId": "<string>",
    "character": {
      "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>"
      }
    },
    "client": "<string>",
    "room": "<string>",
    "serverUrl": "<string>",
    "remoteAgentName": "<string>",
    "remoteAgentIdentity": "<string>",
    "consumerName": "<string>",
    "consumerIdentity": "<string>",
    "promptCtx": "<string>",
    "promptTemplateVars": {},
    "transcript": [
      {
        "id": "<string>",
        "author": "user",
        "content": "<string>",
        "recordedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "timeline": [
      {
        "type": "<string>",
        "recordedAt": "<string>",
        "author": "<string>",
        "content": "<string>"
      }
    ],
    "joinedAt": "2023-11-07T05:31:56Z",
    "endedAt": "2023-11-07T05:31:56Z"
  },
  "remoteAgentAccessToken": "<string>",
  "consumerAccessToken": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
characterId
string
required
client
string | null
host
object
remoteAgent
object
consumer
object
maxSeconds
number | null
promptCtx
string | null
promptTemplateVars
object

Response

201 - application/json
conversation
object
required
remoteAgentAccessToken
string | null
consumerAccessToken
string | null