Check for similar FAQs without creating one

POST/api/v1/knowledge/faqs/check

Requires an Organization API key with the member capability.

Authorization

apiKey

AuthorizationBearer <token>

In: header

Request Body

application/json

question*string

Length1 <= length <= 1000

collectionId?string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/knowledge/faqs/check" \  -H "Content-Type: application/json" \  -d '{    "question": "string"  }'

{  "data": [    {      "documentId": "string",      "sourceId": "string",      "question": "string",      "answerPreview": "string",      "similarity": 0    }  ]}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

Check for similar FAQs without creating one

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`