Get knowledgebase document revision details

GET

/api/v1/knowledgebase_document_revision/{knowledgebase_document_revision_id}

const url = 'https://app.prefactorai.com/api/v1/knowledgebase_document_revision/013xrzp12g3nqk8ns6jadrqmpgrjkeny';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

Authorizations

authorization

Parameters

Path Parameters

knowledgebase_document_revision_id

required

KnowledgebaseDocumentRevision_Id

A valid knowledgebase document revision ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

Query Parameters

idempotency_key

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

Responses

200

Success

application/json

object

details

required

KnowledgebaseDocumentRevision_Details

Full details of a knowledgebase document revision

object

change_kind

required

The change this revision records

string

Allowed values: create update rename archive unarchive

content

required

Document content after this revision

string

content_sha256

required

SHA-256 of the content after this revision, as lowercase hex

string

content_type

required

MIME type of the document after this revision

string

Allowed values: text/markdown text/plain application/json application/yaml text/csv

created_by_admin_user_id

required

One of:

AdminUser_Id
Null

AdminUser_Id

A valid admin user ID

string

created_by_api_token_id

required

One of:

ApiToken_Id
Null

ApiToken_Id

A valid API token ID

string

required

KnowledgebaseDocumentRevision_Id

A valid knowledgebase document revision ID

string

inserted_at

required

When the revision was created

string format: date-time

knowledgebase_document_id

required

KnowledgebaseDocument_Id

A valid knowledgebase document ID

string

knowledgebase_revision_number

required

Knowledgebase revision number this change belongs to

integer

>= 1

path

required

Document path after this revision

string

revision_number

required

Revision number of this document, starting at 1

integer

>= 1

size_bytes

required

Size of the content in bytes after this revision

integer

type

required

Type of resource (always ‘knowledgebase_document_revision’)

string

Allowed values: knowledgebase_document_revision

status

required

Response status when the query succeeds

string

Allowed values: success

Example

{
  "details": {
    "change_kind": "create",
    "content": "# Setup",
    "content_sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
    "content_type": "text/markdown",
    "created_by_admin_user_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "created_by_api_token_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "inserted_at": "2024-01-01T00:00:00Z",
    "knowledgebase_document_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "knowledgebase_revision_number": 4,
    "path": "guides/setup.md",
    "revision_number": 2,
    "size_bytes": 128,
    "type": "knowledgebase_document_revision"
  },
  "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"
}