Skip to main content

Read Conversations API Definition

The Read Conversations API retrieves detailed information about specific conversations and chat interactions. This information enables developers to analyze the flow of user chats and understand the context of interactions, which helps in refining chatbot responses. You can read up to 100 conversations.

The conversation_id specifies the ID of the conversation that you want to read, and it retrieves the Conversation object. This object has an id and turn object which includes the id of the turn, conversationId, the query text, answer, and whether the turn is enabled.

tip

Check out our interactive API Playground that lets you experiment with this REST endpoint to read conversations in the chat history corpus.

REST Example

Read Conversations Endpoint Address

Vectara exposes an HTTP endpoint at the following URL to read conversations in the chat history corpus:
https://api.vectara.io/v1/read-conversations

The API Playground shows the full Read Conversations REST definition.

gRPC Example

You can find the full Read Conversations gRPC definition at chat.proto.