Creating an FAQ

This API is used to enter questions, similar questions, and answers to create a single FAQ.

POST /v1/koosearch/repos/{repo_id}/faqs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repo_id	Yes	String	Knowledge base ID. The value is a string of 1 to 64 characters and can contain only digits, letters, hyphens (-), and underscores (_). How to obtain: Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication." Constraints: N/A.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
question	Yes	String	Question.
answer	Yes	String	Answer.
repo_id	Yes	String	Knowledge base ID. How to obtain: Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database.
question1	No	String	Similar questions
question2	No	String	Similar questions
question3	No	String	Similar questions
question4	No	String	Similar questions
category	No	String	Directory, which is a single value and corresponds to the leaf node in the directory tree.
tags	No	String	Tag list. Separate multiple tags by commas (,). Notes: A document can have one or more tags. It is recommended that the tag value be case insensitive. Do not use reserved characters (+ - = && \|\| > <!). Otherwise, you will need to escape them in queries. ( ) { } [ ] ^ " ~ ? : \ /*. The tag list must be replaced as a whole. Partial update is not supported.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
faq_id	String	ID of the created FAQ.

None

Status code: 200

Creation succeeded.

{
  "faq_id" : "64b4a1bc-3e60-43dd-981c-d24828ddc8ac"
}

Status Code	Description
200	Creation succeeded.

Parent topic: FAQ Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.