Skip to main content
GET
/
v3
/
conversations
List Equos conversations.
curl --request GET \
  --url https://api.equos.ai/v3/conversations \
  --header 'x-api-key: <api-key>'
{
  "skip": 123,
  "take": 123,
  "total": 123,
  "conversations": [
    {
      "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>",
      "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"
    }
  ]
}

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
conversations
object[]
required