Create a multilingual knowledge-base article
Creates a knowledge-base article with localized lifecycle variants, optional category and owner assignments, and stable tags.
/api/kb/articlesCreates a knowledge-base article with localized lifecycle variants, optional category and owner assignments, and stable tags. Referenced categories and operators must belong to the authenticated organization. Published translations are queued for chunking and embedding after the article is stored.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
knowledge-base:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "b9a6e922-23ed-4dde-99e8-76d0cf2a0038", "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5", "categoryId": "6ecda99e-e055-46bd-b0fb-d33ed475b00b", "tags": [ "billing", "refund" ], "title": "How refunds work", "slug": "how-refunds-work", "content": "Refunds are reviewed and returned to the original payment method.", "status": "published", "locale": "en", "fallbackUsed": false, "translations": [ { "id": "a5bd4fbf-3bc3-414a-87ca-dd3f96098ea3", "locale": "en", "status": "published", "sourceLocale": null, "machineTranslatedAt": null, "reviewedAt": null, "reviewedBy": null, "handoffMessage": "Example customer-support message.", "handoffOfflineMessage": "Example customer-support message.", "title": "How refunds work", "slug": "how-refunds-work", "content": "Refunds are reviewed and returned to the original payment method.", "createdAt": "2026-08-03T18:00:00.000Z", "updatedAt": "2026-08-03T18:00:00.000Z" } ], "deletedAt": null, "createdAt": "2026-08-03T18:00:00.000Z", "updatedAt": "2026-08-03T18:00:00.000Z", "ownerOperatorId": "3f042a6a-579c-4c21-9fd4-c3a8323d5caf", "ownerName": "Alex Morgan", "topicHandling": "answer", "topicPriority": null, "conversationTag": "billing", "feedback": { "helpfulCount": 1, "notHelpfulCount": 1, "feedbackCount": 1, "helpfulnessPercent": 1 }}Request examples
curl
curl --request POST \
'https://api.convor.io/api/kb/articles' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"categoryId": "6ecda99e-e055-46bd-b0fb-d33ed475b00b",
"ownerOperatorId": "3f042a6a-579c-4c21-9fd4-c3a8323d5caf",
"tags": [
"billing",
"refund"
],
"translations": [
{
"locale": "en",
"status": "published",
"title": "How refunds work",
"slug": "how-refunds-work",
"content": "Refunds are reviewed and returned to the original payment method."
}
]
}'JavaScript
const response = await fetch("https://api.convor.io/api/kb/articles", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"categoryId": "6ecda99e-e055-46bd-b0fb-d33ed475b00b",
"ownerOperatorId": "3f042a6a-579c-4c21-9fd4-c3a8323d5caf",
"tags": [
"billing",
"refund"
],
"translations": [
{
"locale": "en",
"status": "published",
"title": "How refunds work",
"slug": "how-refunds-work",
"content": "Refunds are reviewed and returned to the original payment method."
}
]
}),
});
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?