Skip to main content
GET
/
v1
/
orgs
/
{org_id}
/
knowledge
/
documents
/
{document_id}
/
bookmark
Get Document Bookmark
curl --request GET \
  --url https://api.letpiper.com/v1/orgs/{org_id}/knowledge/documents/{document_id}/bookmark \
  --header 'Authorization: Bearer <token>'
{
  "bookmarkMode": "none",
  "usageDescription": "<string>",
  "agentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

org_id
string<uuid>
required
document_id
string<uuid>
required

Response

Successful Response

Response showing document bookmark info.

bookmarkMode
enum<string>
required
Available options:
none,
all,
specific
usageDescription
string | null
agentIds
string<uuid>[] | null