API v1 ReferenceKnowledge base
Create knowledge base item
Create a new Q&A item in the knowledge base with question, answer, and optional tags.
AuthorizationBearer <token>
In: header
questionstring
The question being answered
Length
1 <= lengthanswer?string
Plain text answer (optional if answer_md provided)
answer_mdstring
Markdown-formatted answer
Length
1 <= lengthaccess_levelstring
Access level for this Q&A item
Value in
"public" | "restricted" | "internal" | "requires_nda"tags?array<string>
Tags for categorization
Response Body
const body = JSON.stringify({ "question": "What is our data retention policy?", "answer_md": "We retain customer data for **7 years** as required by law.", "access_level": "public"})fetch("https://app.orbiqhq.com/api/v1/knowledge-base", { method: "POST", headers: { "Content-Type": "application/json" }, body}){
"success": true,
"data": {
"qna": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question": "string",
"answer": "string",
"answer_md": "string",
"access_level": "public",
"tags": [
"string"
],
"date_created": "2019-08-24T14:15:22Z",
"date_updated": "2019-08-24T14:15:22Z"
}
}
}{
"error": "Invalid input: question: String must contain at least 1 character(s)"
}Empty
Empty
How is this guide?