Create knowledge base item

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

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

question*string

The question being answered

Length1 <= length

answer?string

Plain text answer (optional if answer_md provided)

answer_md*string

Markdown-formatted answer

Length1 <= length

access_level*string

Access level for this Q&A item

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

tags?array<>

Tags for categorization

Items1 <= items

Response Body

`application/json`

curl -X POST "https://app.orbiqhq.com/api/v1/knowledge-base" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
    ]
  }'

curl -X POST "https://app.orbiqhq.com/api/v1/knowledge-base" \  -H "Content-Type: application/json" \  -d '{    "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"    ]  }'

{
  "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

201application/json

400application/json

401

500

`application/json`

`application/json`