Skip to content
PrefactorPrefactorPrefactor Docs

List knowledgebases

GET
/api/v1/knowledgebase
curl --request GET \
  --url 'https://app.prefactorai.com/api/v1/knowledgebase?account_id=013xrzp12g3nqk8ns6jadrqmpgrjkeny' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
account_id
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny

Account ID (defaults to token’s account)

idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string
status
One of:
string
Allowed values: active archived
Example
active
sorting

Sort order; a field name, optionally prefixed with - for descending (e.g. -id). Supported fields: id, name.

string

Sort order; a field name, optionally prefixed with - for descending (e.g. -id). Supported fields: id, name.

pagination[offset]
integer

Zero-based offset of the first item to return.

pagination[page_size]
integer
>= 1 <= 100

Number of items to return per page (1-100).

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
pagination
required
One of:
PaginationOutput

Pagination information

object
item_count
required

The total number of items

integer
item_end
required

The index of the last item in the page (one-based)

integer
item_start
required

The index of the first item in the page (one-based)

integer
next_page_offset
required
One of:

The offset of the next page (null if last page)

integer
page_count
required

The total number of pages

integer
page_index
required

The index of the current page (one-based)

integer
page_offset
required

The offset of the first item in the page (zero-based)

integer
page_size
required

The number of items per page

integer
previous_page_offset
required
One of:

The offset of the previous page (null if first page)

integer
sorting
required
One of:
Sorting

Sorting information

object
direction

The direction to sort by

string
Allowed values: asc desc
field

The field to sort by (values depend on the type of list)

string
Allowed values: id status started_at finished_at email name external_identifier raised_at cleared_at severity last_active_at last_activity_span_at last_analyzed_at last_used_at inserted_at mode agent_instance_id job_title pending_clickhouse pending_s3 profile_completed_at promo_code purpose row_count size_bytes token_scope total website expires_at path revision_number
nulls

Where to place null values. auto leaves placement to the database default.

string
Allowed values: first last auto
status
required

Response status when the query succeeds

string
Allowed values: success
summaries
required

Knowledgebases visible to the caller for this account

Array<object>
Knowledgebase_Summary

Summary of a knowledgebase for list responses

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
id
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
Example
{
  "pagination": {
    "item_count": 200,
    "item_end": 100,
    "item_start": 91,
    "next_page_offset": 110,
    "page_count": 20,
    "page_index": 10,
    "page_offset": 90,
    "page_size": 10,
    "previous_page_offset": 80
  },
  "sorting": null,
  "status": "success",
  "summaries": [
    {
      "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "active_document_count": 4,
      "description": "Policies and runbooks",
      "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "name": "Engineering notes",
      "revision_number": 3,
      "status": "active",
      "type": "knowledgebase"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/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"
}