site.standard.document
#contributor
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| did | string (did) | - | ✅ | - |
| displayName | string | - | ❌ | - |
| role | string | - | ❌ | - |
#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 |
|---|---|---|---|---|
| bskyPostRef | com.atproto.repo.strongRef | - | ❌ | - |
| content | union of | - | ❌ | - |
| contributors | array of #contributor | - | ❌ | - |
| coverImage | blob | - | ❌ | Image to used for thumbnail or cover image. Less than 1MB is size. |
| description | string | - | ❌ | A brief description or excerpt from the document. |
| labels | union of com.atproto.label.defs#selfLabels | - | ❌ | - |
| links | union of | - | ❌ | - |
| path | string | - | ❌ | Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash. |
| publishedAt | string (datetime) | - | ✅ | Timestamp of the documents publish time. |
| 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. |
| textContent | string | - | ❌ | Plaintext representation of the documents contents. Should not contain markdown or other formatting. |
| title | string | - | ✅ | Title of the document. |
| updatedAt | string (datetime) | - | ❌ | Timestamp of the documents last edit. |
Output
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| ref | com.atproto.repo.strongRef | - | ✅ | - |