Skip to main content
POST
Create a new bookmark

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$

Body

application/json

Represents a user bookmark for saving references to chats, reports, models, and governed reports

bookmarkType
enum<string>
required

The type of object being bookmarked

Available options:
CHAT,
REPORT,
MODEL,
GOVERNED_REPORT
objectId
string
required

The fully-qualified identifier of the bookmarked object. Required shape per type:

  • CHAT{workspaceName}/{chatDocumentPath} (1+ slash)
  • REPORT{workspaceName}/{reportDocumentPath} (1+ slash)
  • MODEL{projectName}/{packageName}/{modelPath} (2+ slashes)
  • GOVERNED_REPORT{projectName}/{packageName}/{reportPath} (2+ slashes)

Response

Bookmark created successfully

Represents a user bookmark for saving references to chats, reports, models, and governed reports

bookmarkType
enum<string>
required

The type of object being bookmarked

Available options:
CHAT,
REPORT,
MODEL,
GOVERNED_REPORT
objectId
string
required

The fully-qualified identifier of the bookmarked object. Required shape per type:

  • CHAT{workspaceName}/{chatDocumentPath} (1+ slash)
  • REPORT{workspaceName}/{reportDocumentPath} (1+ slash)
  • MODEL{projectName}/{packageName}/{modelPath} (2+ slashes)
  • GOVERNED_REPORT{projectName}/{packageName}/{reportPath} (2+ slashes)
organizationName
string
read-only

The organization name this bookmark belongs to

userName
string
read-only

The username of the user who owns the bookmark

createdAt
string<date-time>
read-only

ISO 8601 timestamp indicating when the bookmark was created