Skip to main content

site.standard.document

#contributor

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
displayNamestring--
rolestring--

#main

Properties

A document record representing a published article, blog post, or other content. Documents can belong to a publication or exist independently.

Use com.atproto.repo.createRecord to create a record.

PropertyTypeKnown ValuesRequiredDescription
bskyPostRefcom.atproto.repo.strongRef--
contentunion of
--
contributorsarray of #contributor--
coverImageblob-Image to used for thumbnail or cover image. Less than 1MB is size.
descriptionstring-A brief description or excerpt from the document.
labelsunion of
com.atproto.label.defs#selfLabels
--
linksunion of
--
pathstring-Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash.
publishedAtstring (datetime)-Timestamp of the documents publish time.
sitestring (uri)-Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes.
tagsarray of string-Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.
textContentstring-Plaintext representation of the documents contents. Should not contain markdown or other formatting.
titlestring-Title of the document.
updatedAtstring (datetime)-Timestamp of the documents last edit.

Output

PropertyTypeKnown ValuesRequiredDescription
refcom.atproto.repo.strongRef--