Record containing a bookmarked item, or 'clip'.
any
Any valid record key
Properties
createdAt
string
datetime
Required
Client-declared timestamp when the bookmark is created
description
string
Required
A description of the bookmark's content. This should be ripped from the URL metadata and be static for all records using the URL.
maxLength: 40960 bytesmaxGraphemes: 4096 graphemeslanguages
array
of
string
language
Optional
Indicates human language of the given URL
maxLength: 5 itemsnotes
string
Optional
User-written notes for the bookmark. Public and personal.
maxLength: 100000 bytesmaxGraphemes: 10000 graphemestags
array
of
ref
com.atproto.repo.strongRef
Optional
An array of tags. A format of solely alphanumeric characters and dashes should be used.
title
string
Required
The title of the bookmark. If left empty, reuse the URL.
maxLength: 20480 bytesmaxGraphemes: 2048 graphemesunlisted
boolean
Required
Whether the bookmark can be used for feed indexing and aggregation
falseunread
boolean
Optional
Whether the bookmark has been read by the user
trueurl
string
uri
Required
The URL of the bookmark. Cannot be left empty or be modified after creation.
maxLength: 20000 bytesmaxGraphemes: 2000 graphemesView raw schema
{
"key": "any",
"type": "record",
"record": {
"type": "object",
"required": [
"url",
"title",
"description",
"unlisted",
"createdAt"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 20000,
"description": "The URL of the bookmark. Cannot be left empty or be modified after creation.",
"maxGraphemes": 2000
},
"tags": {
"type": "array",
"items": {
"ref": "com.atproto.repo.strongRef",
"type": "ref"
},
"description": "An array of tags. A format of solely alphanumeric characters and dashes should be used."
},
"notes": {
"type": "string",
"maxLength": 100000,
"description": "User-written notes for the bookmark. Public and personal.",
"maxGraphemes": 10000
},
"title": {
"type": "string",
"maxLength": 20480,
"description": "The title of the bookmark. If left empty, reuse the URL.",
"maxGraphemes": 2048
},
"unread": {
"type": "boolean",
"default": true,
"description": "Whether the bookmark has been read by the user"
},
"unlisted": {
"type": "boolean",
"default": false,
"description": "Whether the bookmark can be used for feed indexing and aggregation"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "Client-declared timestamp when the bookmark is created"
},
"languages": {
"type": "array",
"items": {
"type": "string",
"format": "language"
},
"maxLength": 5,
"description": "Indicates human language of the given URL"
},
"description": {
"type": "string",
"maxLength": 40960,
"description": "A description of the bookmark's content. This should be ripped from the URL metadata and be static for all records using the URL.",
"maxGraphemes": 4096
}
}
},
"description": "Record containing a bookmarked item, or 'clip'."
}