The chat endpoint allows you to converse with your collection allowing it to respond based on information from your resources added to the collection via the WetroCloud API.

​
Required Parameters

FieldDescription
collection_idCollection Id.
messageMessage currently being sent to collection
chat_historyHistory of chat between user and system

​
Request Example

curl --request POST \

    --url https://api.wetrocloud.com/v1/collection/chat/ \

    --header 'Authorization: Token <api-key>' \

    --header 'Content-Type: multipart/form-data' \

    --form 'collection_id=<collection_id>' \

    --form 'message=Tell me more' \

    --form 'chat_history=[{"role":"user","content":"What is this all about?"}, {"role":"system","content":"This is about Queen Elizabeth_II of England"}]' \

​
Response Example:

{

  "response": "The sales for Q1 increased by 20% compared to last year, with online channels contributing significantly.",

  "tokens": 120,

  "success": true

}
FieldDescription
responseConversational response to the message.
tokensNumber of tokens used for processing.
successIndicates whether the query was successful.