Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Chats

Get a turn

Returns a specific turn from a chat. A turn is a message and response pair from the conversation.

get/v2/chats/{chat_id}/turns/{turn_id}

Path parameters

chat_idstring required

The ID of the chat.

turn_idstring required

The ID of the turn.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The turn.

idstring required

The ID of the turn.

chat_idstring

The ID of the chat the turn resides in.

querystring

The query made to produce this turn.

answerstring

The response to the query.

enabledboolean

Indicates whether the turn is enabled and shown in future turns of the chat.

created_atstring date-time

Specifies when the turn was created.

Example response

{
  "id": "trn_987654321",
  "chat_id": "cht_123456789",
  "query": "How do you turn this widget?",
  "answer": "The widget turns counter clockwise.",
  "enabled": true
}