Skip to main content
GET
/
v3
/
conversations
/
{id}
Get Equos conversation by id.
curl --request GET \
  --url https://api.equos.ai/v3/conversations/{id} \
  --header 'x-api-key: <api-key>'
{
  "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

Path Parameters

id
string
required

Equos conversation id.

Response

200 - application/json
id
string
required
name
string
required
status
enum<string>
required
Available options:
running,
blocked,
ended,
error
charge
boolean
required
chargeBySecond
number
required
maxSeconds
number
required
startedAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
characterId
string
required
organizationId
string
required
client
string | null
room
string | null
serverUrl
string | null
remoteAgentName
string | null
remoteAgentIdentity
string | null
consumerName
string | null
consumerIdentity
string | null
promptCtx
string | null
promptTemplateVars
object
transcript
object[] | null
deprecated
timeline
object[] | null
joinedAt
string<date-time> | null
endedAt
string<date-time> | null