Update a knowledge base item

PATCH

/api/v1/knowledge_base_items/{id}

Approving and unapproving are ordinary field updates — PATCH the aasm_state. Values outside the user-selectable set are ignored.

Authorizations

bearerAuth

Path Parameters

NameType

required

string

The record’s prefixed ID

Request Body^required

application/json

object

knowledge_base_item

required

object

question

string

answer

string

aasm_state

string

Allowed values: new needs_input approved

Approve/unapprove; ignored unless user-selectable

applicable

boolean

rationale

string

category_id

integer

Numeric ID of a category (see category.id on the item)

auto_answer

boolean

answer_detail_level

string

default: normal

Allowed values: low normal high

The integer index (0, 1, 2) is also accepted

Responses

200

The updated item

Response body

application/json

object

string

web_link

string format: uri

The item’s page in the web app

question

string

answer

string | null

state

string

Allowed values: new ready_to_answer applicability_checked references_fetched needs_input auto_answered approved

Lifecycle state. approved items are used to answer questionnaires.

applicable

boolean | null

Whether the question applies to your organisation

rationale

string | null

auto_answer

boolean

Whether the AI may answer or re-answer this item

answer_detail_level

string

Allowed values: low normal high

confidence

string | null

0–1, encoded as a decimal string

confidence_as_words

string

Allowed values: Excellent Very good Good Ok Low

language

string

framework

string | null

Allowed values: nist-csf-2.0 hecvat-3.06 hecvat-4.1 rh-1.0 cjis-5 cjis-6

requires_attention

boolean

The confidence rating flagged points a human should review

category

object

integer

Numeric category ID, as accepted by category_id

name

string

area

string | null

created_at

string format: date-time

updated_at

string format: date-time

403

Insufficient scope, role, or credits

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

404

No such record in this account

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

422

The record could not be saved

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request PATCH \
  --url https://app.responsehub.io/api/v1/knowledge_base_items/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "knowledge_base_item": { "question": "example", "answer": "example", "aasm_state": "new", "applicable": true, "rationale": "example", "category_id": 1, "auto_answer": true, "answer_detail_level": "low" } }'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/knowledge_base_items/example")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{ \"knowledge_base_item\": { \"question\": \"example\", \"answer\": \"example\", \"aasm_state\": \"new\", \"applicable\": true, \"rationale\": \"example\", \"category_id\": 1, \"auto_answer\": true, \"answer_detail_level\": \"low\" } }"

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://app.responsehub.io/api/v1/knowledge_base_items/example', [
  'body' => '{ "knowledge_base_item": { "question": "example", "answer": "example", "aasm_state": "new", "applicable": true, "rationale": "example", "category_id": 1, "auto_answer": true, "answer_detail_level": "low" } }',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/knowledge_base_items/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"knowledge_base_item":{"question":"example","answer":"example","aasm_state":"new","applicable":true,"rationale":"example","category_id":1,"auto_answer":true,"answer_detail_level":"low"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/knowledge_base_items/example"

  payload := strings.NewReader("{ \"knowledge_base_item\": { \"question\": \"example\", \"answer\": \"example\", \"aasm_state\": \"new\", \"applicable\": true, \"rationale\": \"example\", \"category_id\": 1, \"auto_answer\": true, \"answer_detail_level\": \"low\" } }")

  req, _ := http.NewRequest("PATCH", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Request body example

Example^generated

{
  "knowledge_base_item": {
    "question": "example",
    "answer": "example",
    "aasm_state": "new",
    "applicable": true,
    "rationale": "example",
    "category_id": 1,
    "auto_answer": true,
    "answer_detail_level": "low"
  }
}

200example

Example^generated

{
  "id": "kbi_1a2b",
  "web_link": "https://example.com",
  "question": "example",
  "answer": "example",
  "state": "new",
  "applicable": true,
  "rationale": "example",
  "auto_answer": true,
  "answer_detail_level": "low",
  "confidence": "0.85",
  "confidence_as_words": "Excellent",
  "language": "english",
  "framework": "nist-csf-2.0",
  "requires_attention": true,
  "category": {
    "id": 1,
    "name": "example",
    "area": "example"
  },
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z"
}

403example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

404example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

422example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

Update a knowledge base item

Authorizations

Path Parameters

Request Bodyrequired

Responses

200

403

404

422

Request Body^required