Delete a knowledgebase

DELETE

/api/v1/knowledgebase/{knowledgebase_id}

const url = 'https://app.prefactorai.com/api/v1/knowledgebase/013xrzp12g3nqk8ns6jadrqmpgrjkeny';
const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: 'null'
};

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

curl --request DELETE \
  --url https://app.prefactorai.com/api/v1/knowledgebase/013xrzp12g3nqk8ns6jadrqmpgrjkeny \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data null

Authorizations

authorization

Parameters

Path Parameters

knowledgebase_id

required

Knowledgebase_Id

A valid knowledgebase ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

Request Body

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

Responses

200

Success

application/json

object

details

required

Knowledgebase_Details

Full details of a knowledgebase

object

account_id

required

Account_Id

A valid account ID

string

active_document_count

required

Number of active documents

integer

description

required

One of:

string
Null

string

required

Knowledgebase_Id

A valid knowledgebase ID

string

name

required

Knowledgebase name

string

revision_number

required

Number of the revision agents read. It starts at 0 when the knowledgebase is created and increases by one for each document change. Agents read the revision with this number, which is always the latest revision.

integer

status

required

Whether this knowledgebase is active or archived

string

Allowed values: active archived

type

required

Type of resource (always ‘knowledgebase’)

string

Allowed values: knowledgebase

status

required

Response status when the operation succeeds

string

Allowed values: success

Example

{
  "details": {
    "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "active_document_count": 4,
    "description": "Policies and runbooks",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "name": "Engineering notes",
    "revision_number": 3,
    "status": "active",
    "type": "knowledgebase"
  },
  "status": "success"
}

default

Error

application/json

One of:

object

code

required

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_state alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used temporarily_unavailable conflict

message

required

string

status

required

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}