Skip to main content
GET
/
api
/
agents
/
chats
/
{chat_id}
Get chat details
curl --request GET \
  --url https://interact.turntwo.com/api/agents/chats/{chat_id} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Organization-Id: <api-key>'
{
  "id": "<string>",
  "agent": {
    "id": "<string>",
    "name": "<string>"
  },
  "job": {
    "id": "<string>",
    "name": "<string>"
  },
  "organization": {
    "id": "<string>",
    "name": "<string>"
  },
  "status": "<string>",
  "initiator": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "documents": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "pdfLink": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

API key for authentication

X-Organization-Id
string
header
required

Organization ID associated with the API key

Path Parameters

chat_id
string
required

Chat ID

Response

Successful response

id
string
required

Chat ID

agent
object
required

Agent information

job
object
required

Job information

organization
object
required

Organization information

status
string
required

Chat status

initiator
string
required

Who initiated the chat

createdAt
string<date-time>
required

Chat creation timestamp

documents
object[]
required