Create knowledge base item

Create a new Q&A item in the knowledge base with question, answer, and optional tags.

Authorization

AuthorizationBearer <token>

In: header

Request Body

questionstring

The question being answered

Length1 <= length

answer?string

Plain text answer (optional if answer_md provided)

answer_mdstring

Markdown-formatted answer

Length1 <= length

access_levelstring

Access level for this Q&A item

Value in"public" | "restricted" | "internal" | "requires_nda"

tags?array<string>

Tags for categorization

Items1 <= items

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",
  "tags": [
    "gdpr",
    "data-retention",
    "legal"
  ]
})

fetch("https://app.orbiqhq.com/api/v1/knowledge-base", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  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",  "tags": [    "gdpr",    "data-retention",    "legal"  ]})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

How is this guide?

Create knowledge base item

Authorization

Request Body

Response Body

201

400

401

500