ChatService

POST /v1/list-conversations

List all the conversations in a specific corpus. This data enables developers to monitor chatbot interactions and understand how users engage with the data. Pagination lets developers navigate through large datasets.

Some tips for this API:

This operation authenticates with either an API Key or OAuth 2.0 (in a JWT "Bearer Token"). You can find details of how to set up an API key or use OAuth 2.0 here.

Request

Base URL
https://api.vectara.io
Auth
- API key in header x-api-key
- or OAuth 2
  Client credentials
  Token URLhttps://vectara-prod-YOUR_VECTARA_CUSTOMER_ID.auth.us-west-2.amazoncognito.com/oauth2/token
TypeScript
https://skmtc.dev/vectara/apis/vectara-rest-api/docs/v1/list-conversations/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

customer-idinteger required

Enter the Customer ID to use for the request.

timeoutstring

(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.

Request body

numResultsinteger

Maximum number of conversations to return per page.

pageKeystring byte

A key that is passed in to retrieve a specific page of results. Leave empty to retrieve the first page. Subsequent page request should use the page key returned in previous response, and all other fields are ignored.

Response

A successful response.

pageKeystring byte

A key that is passed in to retrieve a specific page of results. Pass this as is in to the next request to retrieve the next page of results.

Changes

No recorded changes to this operation across all 3 revisions of this API.