Skip to main content
Version: 2.0

Create Chat Turn API Definition

The Create Chat Turn API allows you to create a new turn in a chat. Each conversation consists of a series of turn objects, which represent the sequence of message and response pairs that make up the dialog.

Create Chat Turn Request and Response​

To create a chat turn, send a POST request to /v2/chats/{chat_id}/turns, where {chat_id} is the unique identifier of the chat which you want to add the turn. The request contains the following properties:

  • query - (Required) Specifies the chat message or question for the new turn.
  • stream_response - Indicates whether the response should be streamed in real-time. The default value is false.
  • search - (Required) Specifies the search parameters for retrieving relevant information from the corpora.
  • generation - (Required) Specifies the generation parameters for the chat response.
  • chat.store - Indicates whether to store the request message and response message. The default value is true.

The response returns assigned turn_id, the generated answer, answer_language, and the search_results used by the chat model.

REST 2.0 URL​

Create Chat Turn Endpoint Address​

Vectara exposes an HTTP endpoint at the following URL to create a chat turns:
https://api.vectara.io/v2/chats/:chat_id/turns

The API Reference shows the full Create Chat Turn REST definition.