API v1 ReferenceKnowledge base
Create knowledge base item
Create a new base-locale Q&A item in the knowledge base with question, answer, access level, and optional tags. Localized versions can be added after…
Create a new base-locale Q&A item in the knowledge base with question, answer, access level, and optional tags. Localized versions can be added after creation through the item detail endpoint.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/knowledge-base" \ -H "Content-Type: application/json" \ -d '{ "question": "What is our data retention policy?", "answer": "We retain customer data for **7 years** as required by law.", "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": "kb-123",
"question": "What data do you collect?",
"answer": "We collect only necessary personal information as outlined in our privacy policy.",
"access_level": "public",
"tags": [
"privacy"
]
}
}
}{
"error": "Invalid input: question: String must contain at least 1 character(s)"
}Empty
{
"error": "You don't have permission to create knowledge base items"
}{
"error": "A similar question already exists in the knowledge base"
}Empty
How is this guide?