Creates one organization-owned knowledge-base category with a stable key, icon, ordering position, and localized lifecycle variants. The key and localized category names must remain unique within the organization. Access requires an active organization administrator session or an organization API key with the `knowledge-base:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
/api/kb/categoriesOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"id": "6ecda99e-e055-46bd-b0fb-d33ed475b00b",
"orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",
"key": "billing",
"icon": "💳",
"sortOrder": 10,
"name": "Billing",
"description": "Invoices, payments, and refunds.",
"locale": "en",
"fallbackUsed":
{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"correlationId": "req_01K0MANAGEMENT401"
}
}{
"error": {
"code": "INTEGRATION_MODULE_REQUIRED",
"message": "The automation API module is required.",
"details": {
"module": "automation_api",
"feature": "public_api"
},
"correlationId": "req_01K0MANAGEMENT402"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The caller lacks the required role or API-key scope.",
"correlationId": "req_01K0MANAGEMENT403"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested change conflicts with current resource state.",
"correlationId": "req_01K0MANAGEMENT409"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request payload is invalid.",
"details": {
"field": "name"
},
"correlationId": "req_01K0MANAGEMENT422"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests.",
"correlationId": "req_01K0MANAGEMENT429"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request POST \
'https://api.convor.io/api/kb/categories' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"key": "billing",
"icon": "💳",
"sortOrder": 10,
"translations": [
{
"locale": "en",
"status": "published",
"name": "Billing",
"description": "Invoices, payments, and refunds."
}
]
}'const response = await fetch("https://api.convor.io/api/kb/categories", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"key": "billing",
"icon": "💳",
"sortOrder": 10,
"translations": [
{
"locale": "en",
"status": "published",
"name": "Billing",
"description": "Invoices, payments, and refunds."
}
]
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?
Create a multilingual knowledge-base article
Creates one organization-owned article with localized lifecycle variants, optional category and owner assignments, and stable tags. Referenced categories and operators must belong to the same organization. Published translations are queued for chunking and embedding after persistence. Access requires an active organization administrator session or an organization API key with the `knowledge-base:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
Delete a knowledge-base category
Permanently deletes one organization-owned knowledge-base category. The operation follows the service's article-association rules and returns a conflict instead of silently orphaning protected content. Access requires an active organization administrator session or an organization API key with the `knowledge-base:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.