Get a chat
GET/v2/chats/:chat_id
Get a chat summary to view what started the chat, but not subsequent turns.
Request
Path Parameters
chat_id stringrequired
Possible values: Value must match regular expression cht_.+$
The ID of the chat.
Responses
- 200
- 403
- 404
A chat.
- application/json
- Schema
- Example (from schema)
Schema
id string
Possible values: Value must match regular expression cht_.+$
ID of the chat.
first_query string
The first query of the chat.
first_answer string
The first answer of the chat.
enabled boolean
Indicates whether this chat is enabled and can have further turns.
created_at date-time
Specifies when this chat was created.
{
"id": "string",
"first_query": "string",
"first_answer": "string",
"enabled": true,
"created_at": "2024-09-05T02:15:29.482Z"
}
Permissions do not allow retrieving the chat.
- application/json
- Schema
- Example (from schema)
Schema
messages message[]
The messages describing why the error occurred.
request_id string
The ID of the request that can be used to help Vectara support debug what went wrong .
{
"messages": [
"Internal server error."
],
"request_id": "string"
}
Corpus or chat not found.
- application/json
- Schema
- Example (from schema)
Schema
id string
The ID cannot found.
messages message[]
request_id string
ID of the request that can be used to help Vectara support debug what went wrong.
{
"id": "string",
"messages": [
"string"
],
"request_id": "string"
}
Loading...