Skip to content
PrefactorPrefactorPrefactor Docs

Get knowledgebase revision details

GET
/api/v1/knowledgebase_revision/{knowledgebase_revision_id}
curl --request GET \
  --url https://app.prefactorai.com/api/v1/knowledgebase_revision/013xrzp12g3nqk8ns6jadrqmpgrjkeny \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
knowledgebase_revision_id
required
KnowledgebaseRevision_Id

A valid knowledgebase revision ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny

Query Parameters

Section titled “Query Parameters”
idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
details
required
KnowledgebaseRevision_Details

Full details of a knowledgebase revision

object
created_by_admin_user_id
required
One of:
AdminUser_Id

A valid admin user ID

string
created_by_api_token_id
required
One of:
ApiToken_Id

A valid API token ID

string
current
required

Whether this is the revision agents read. Agents read the current revision, which is always the latest revision.

boolean
document_count
required

Number of active documents after this revision

integer
id
required
KnowledgebaseRevision_Id

A valid knowledgebase revision ID

string
inserted_at
required

When the revision was created

string format: date-time
knowledgebase_id
required
Knowledgebase_Id

A valid knowledgebase ID

string
revision_number
required

Revision number. It starts at 0 when the knowledgebase is created and increases by one for each document change

integer
total_size_bytes
required

Total size in bytes of active documents after this revision

integer
type
required

Type of resource (always ‘knowledgebase_revision’)

string
Allowed values: knowledgebase_revision
status
required

Response status when the query succeeds

string
Allowed values: success
Example
{
  "details": {
    "created_by_admin_user_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "created_by_api_token_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "current": true,
    "document_count": 2,
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "inserted_at": "2024-01-01T00:00:00Z",
    "knowledgebase_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "revision_number": 3,
    "total_size_bytes": 128,
    "type": "knowledgebase_revision"
  },
  "status": "success"
}

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"
}