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.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

A chat.

application/json

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.

Example (from schema)

{
  "id": "string",
  "first_query": "string",
  "first_answer": "string",
  "enabled": true,
  "created_at": "2024-10-29T01:49:06.230Z"
}

403

Permissions do not allow retrieving the chat.

application/json

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.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

404

Corpus or chat not found.

application/json

Schema

Schema

id string

The ID cannot be found.

messages message[]
request_id string

ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Loading...