APIs related

These APIs enable collaborative document review within Guardian policies. Users can create discussion threads on policy documents, post messages, attach encrypted files, and inspect document relationships and schemas — all scoped to a specific policy and document.

Authentication: All endpoints require a Bearer token (Authorization: Bearer <token>). Obtain a token via POST /api/v1/accounts/login.


Endpoint Index

Policy Comments (/api/v1/policy-comments)

Method
Endpoint
Description
Auth Required

GET

/policy-comments/{policyId}/{documentId}/users

Returns users with access to the document

Yes

GET

/policy-comments/{policyId}/{documentId}/relationships

Returns documents linked to the target document

Yes

GET

/policy-comments/{policyId}/{documentId}/schemas

Returns schemas applicable to the target document

Yes

GET

/policy-comments/{policyId}/{documentId}/discussions

Returns discussion threads for the target document

Yes

POST

/policy-comments/{policyId}/{documentId}/discussions

Creates a new discussion thread

Yes

POST

/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments

Creates a new message in a discussion

Yes

POST

/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/search

Returns paginated messages for a discussion

Yes

GET

/policy-comments/{policyId}/{documentId}/comments/count

Returns the total message count for a document

Yes

POST

/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/file

Encrypts and uploads a file to IPFS

Yes

GET

/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/file/{cid}

Retrieves and decrypts a file from IPFS

Yes

GET

/policy-comments/{policyId}/{documentId}/keys

Returns private keys for the target document

Yes

Policy Repository (/api/v1/policy-repository)

Method
Endpoint
Description
Auth Required

GET

/policy-repository/{policyId}/users

Returns user names present in the policy

Yes

GET

/policy-repository/{policyId}/schemas

Returns schemas present in the policy

Yes

GET

/policy-repository/{policyId}/documents

Returns paginated documents in the policy

Yes


Endpoints

Policy Comments

Policy Repository

Last updated

Was this helpful?