site.standard.document

#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.

Property	Type	Known Values	Required	Description
path	string	-	❌	Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash.
site	string (uri)	-	✅	Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes.
tags	array of string	-	❌	Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.
links	union of	-	❌	-
title	string	-	✅	Title of the document.
labels	union of com.atproto.label.defs#selfLabels	-	❌	-
content	union of	-	❌	-
updatedAt	string (datetime)	-	❌	Timestamp of the documents last edit.
coverImage	blob	-	❌	Image to used for thumbnail or cover image. Less than 1MB is size.
bskyPostRef	com.atproto.repo.strongRef	-	❌	-
description	string	-	❌	A brief description or excerpt from the document.
publishedAt	string (datetime)	-	✅	Timestamp of the documents publish time.
textContent	string	-	❌	Plaintext representation of the documents contents. Should not contain markdown or other formatting.
contributors	array of #contributor	-	❌	-

Output

Property	Type	Known Values	Required	Description
ref	com.atproto.repo.strongRef	-	✅	-

#contributor

Property	Type	Known Values	Required	Description
did	string (did)	-	✅	-
role	string	-	❌	-
displayName	string	-	❌	-