Approve a pending KB entry
POST /api/kb-entries/{entryId}/approve
Approves a knowledge base entry that awaits review, with status pending_review or proposed. An approved entry is used by the assistant when it answers matching questions. The edits in the body are approved in place of the entry’s own fields, and the fields not sent stay as they are. A proposal that changes an existing entry is applied to that entry, which takes the proposal’s answer, and the proposal’s topics when it has any, with the edits in place of the ones sent, and keeps its own question. Approving an entry that is already approved answers with it unchanged.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The unique identifier of the KB entry to approve.
Request Body
Section titled “Request Body ”Optional. Edits to an entry that awaits review (proposed or pending_review), approved in place of the entry’s own fields; the fields not sent stay as they are. On a proposal that changes an existing entry, that entry takes the proposal’s answer, and the proposal’s topics when it has any, with the edits in place of the ones sent, and keeps its own question.
object
The question to approve, in place of the entry’s own. An existing entry that a proposal changes keeps its question.
The answer to approve, in place of the entry’s own.
The topics to approve, in place of the entry’s own.
After a 409, the publishedVersionId of the returned currentTarget: the version of the existing entry the proposal is approved onto.
Responses
Section titled “ Responses ”The approved entry. For a proposal that changes an existing entry, the entry it changed.
A knowledge base (KB) entry is a question-answer pair that the AI uses to respond to customer inquiries. Entries can be created manually, imported via the API, or proposed automatically by the learning loop after resolved conversations. Proposed entries require human approval before the AI can use them.
object
Unique identifier for the KB entry.
Example
kb1a2b3c-5678-9abc-def0-1234567890abThe tenant this entry belongs to.
Example
a0b1c2d3-4567-89ab-cdef-0123456789abThe workspace this entry is scoped to. The AI only uses entries from the workspace that matches the conversation.
Example
w1a2b3c4-5678-9abc-def0-1234567890abThe question or topic this entry addresses. This is what the AI matches against when a customer asks something.
Example
What are your delivery times to Germany?The answer the AI should use when this entry is matched. Can include specific details, links, and instructions.
Example
Standard delivery to Germany takes 3-5 business days. Express delivery (next business day) is available for an additional fee of EUR 12.50.Tags that categorize this entry. Used for filtering and to help the AI determine relevance.
Example
[ "shipping", "delivery", "germany"]How the entry came to be. manual is an entry written by a person, approved when it is created. extracted is a proposal the learning loop drafted from a resolved conversation. The API stores the value sent, and an entry created with a value other than manual starts as pending_review.
Example
manualConfidence score between 0 and 1, set by the learning loop when proposing entries. Higher values indicate the AI is more confident the entry is accurate. Null for manually created entries.
Example
0.92Where the entry stands. approved: in use, the assistant draws on it. pending_review: created for review, through the API with a sourceType other than manual; it is not used until it is approved. proposed: drafted by oHallo, for example by the learning loop from a resolved conversation; it is not used until it is approved, and a proposal that changes an existing entry is applied to that entry when it is approved. rejected: declined in review. archived: no longer in use, kept for the record.
Example
approvedNumber of times this entry has been referenced by the AI when responding to conversations.
Example
47Timestamp of the last time the AI referenced this entry. Null if never used.
Example
2026-03-25T14:20:00.000ZTimestamp when the entry was created.
Example
2026-02-01T12:00:00.000ZTimestamp when the entry was last updated.
Example
2026-03-15T10:30:00.000ZThe entry was rejected before this approval (error: Entry is no longer awaiting review).
Standard error response returned by all endpoints on failure.
object
A human-readable error message describing what went wrong.
Example
Conversation not foundA machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.
Example
key_lockOn a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.
Example
[ "mcp:write"]On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.
Example
11223344-5566-4788-99aa-bbccddeeff00On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.
On the same 422: the tool names the connection does not declare.
Example
[ "get_orders"]On the same 422: the tools the connection declares.
Example
[ "get_order", "search_orders"]No KB entry exists with the given ID in the authenticated tenant.
Standard error response returned by all endpoints on failure.
object
A human-readable error message describing what went wrong.
Example
Conversation not foundA machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.
Example
key_lockOn a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.
Example
[ "mcp:write"]On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.
Example
11223344-5566-4788-99aa-bbccddeeff00On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.
On the same 422: the tool names the connection does not declare.
Example
[ "get_orders"]On the same 422: the tools the connection declares.
Example
[ "get_order", "search_orders"]The existing entry this proposal changes was edited after the proposal was written. The body carries currentTarget, the entry as it stands. To approve the proposal onto it, send the approval again with expectedTargetVersionId set to currentTarget.publishedVersionId. A 409 with code duplicate_question means the approval would give the entry a question another entry of the workspace has; entryId names that entry.
Standard error response returned by all endpoints on failure.
object
A human-readable error message describing what went wrong.
Example
Conversation not foundA machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.
Example
key_lockOn a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.
Example
[ "mcp:write"]On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.
Example
11223344-5566-4788-99aa-bbccddeeff00On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.
On the same 422: the tool names the connection does not declare.
Example
[ "get_orders"]On the same 422: the tools the connection declares.
Example
[ "get_order", "search_orders"]