Answer question based on Knowledge Articles and other Documents

get

https://api.cuein.ai/answers/v1/answer

Query Params

question

string

Question to be answered

customerId

string

Customer making the request

tenantId

string

Identifier for the tenant/client whose documents will be used for answering the question

sessionId

string

Unique identifier for the chat session in which the question was asked

documentType

string

enum

Defaults to public

Type of document to be used for search

Allowed:

filter

object

Key-Value pairs to be used as filters. All filters will be treated as AND. Ex. ?filter[filter_1]=val_1,val_2&filter[filter_2]=val_3,val_4.

numDocuments

number

Number of Documents to use as context when generating an Answer (min 1, max 10, default 3)

userType

string

enum

Type of user making the request

Allowed:

userName

string

Name of user making the request

Responses

400

Invalid Tenant

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation