app.standard-reader.defs

standard-reader.app

Documentation

cursorPageDocuments object

No description available.

Properties

cursor string Optional

No description available.

maxLength: 8192 bytes

items array of refapp.standard-reader.defs#documentView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "app.standard-reader.defs#documentView",
        "type": "ref"
      }
    },
    "cursor": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    }
  }
}

cursorPageProfiles object

No description available.

Properties

cursor string Optional

No description available.

maxLength: 8192 bytes

items array of refapp.standard-reader.defs#profileView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "app.standard-reader.defs#profileView",
        "type": "ref"
      }
    },
    "cursor": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    }
  }
}

cursorPagePublications object

No description available.

Properties

cursor string Optional

No description available.

maxLength: 8192 bytes

items array of refapp.standard-reader.defs#publicationView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "app.standard-reader.defs#publicationView",
        "type": "ref"
      }
    },
    "cursor": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    }
  }
}

documentView object

An article as shown in feed rows and search results (metadata only).

Properties

canonicalUrl string uri Optional

A valid URI.

commentCount integer Required

No description available.

content unknown Optional

Renderable body payload (the content-union of the site.standard.document record). Only populated by getDocument; omitted from feed and search views.

contentFormat string Optional

Explicit content-union $type, used when the body payload lacks one. Only populated by getDocument.

maxLength: 256 bytes

coverImageUrl string uri Optional

A valid URI.

description string Optional

No description available.

maxLength: 4096 bytes

did string did Required

A decentralized identifier (DID).

featured boolean Optional

No description available.

hasRenderableBody boolean Required

No description available.

isRead boolean Required

No description available.

path string Optional

No description available.

maxLength: 2048 bytes

publicationBannerUrl string uri Optional

A valid URI.

publicationIconUrl string uri Optional

A valid URI.

publicationName string Optional

No description available.

maxLength: 128 bytes

publicationOwnerAvatarUrl string uri Optional

A valid URI.

publicationOwnerHandle string Optional

No description available.

maxLength: 128 bytes

publicationTopic string Optional

No description available.

maxLength: 128 bytes

publicationUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

publishedAt string datetime Required

An RFC 3339 formatted timestamp.

recommendCount integer Required

No description available.

searchSnippetHtml string Optional

No description available.

maxLength: 8192 bytes

searchTitleHtml string Optional

No description available.

maxLength: 1024 bytes

tags array of string Optional

No description available.

title string Required

No description available.

maxLength: 512 bytes

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "did",
    "title",
    "publishedAt",
    "recommendCount",
    "commentCount",
    "hasRenderableBody",
    "isRead"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "path": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 128
      },
      "nullable": true
    },
    "title": {
      "type": "string",
      "maxLength": 512
    },
    "isRead": {
      "type": "boolean"
    },
    "content": {
      "type": "unknown",
      "description": "Renderable body payload (the content-union of the site.standard.document record). Only populated by getDocument; omitted from feed and search views."
    },
    "featured": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 4096
    },
    "publishedAt": {
      "type": "string",
      "format": "datetime"
    },
    "canonicalUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "commentCount": {
      "type": "integer"
    },
    "contentFormat": {
      "type": "string",
      "maxLength": 256,
      "description": "Explicit content-union $type, used when the body payload lacks one. Only populated by getDocument."
    },
    "coverImageUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationUri": {
      "type": "string",
      "format": "at-uri",
      "nullable": true
    },
    "recommendCount": {
      "type": "integer"
    },
    "publicationName": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "searchTitleHtml": {
      "type": "string",
      "nullable": true,
      "maxLength": 1024
    },
    "publicationTopic": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "hasRenderableBody": {
      "type": "boolean"
    },
    "searchSnippetHtml": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    },
    "publicationIconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationBannerUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationOwnerHandle": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "publicationOwnerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  },
  "description": "An article as shown in feed rows and search results (metadata only)."
}

listView object

A reader-authored publication list (app.standard-reader.list) with its member publications resolved.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 4096 bytes

name string Required

No description available.

maxLength: 128 bytes

publications array of refapp.standard-reader.defs#publicationView Required

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "name",
    "publications"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string",
      "maxLength": 128
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 4096
    },
    "publications": {
      "type": "array",
      "items": {
        "ref": "app.standard-reader.defs#publicationView",
        "type": "ref"
      }
    }
  },
  "description": "A reader-authored publication list (app.standard-reader.list) with its member publications resolved."
}

profileView object

No description available.

Properties

avatarUrl string uri Optional

A valid URI.

bannerUrl string uri Optional

A valid URI.

description string Optional

No description available.

maxLength: 4096 bytes

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 128 bytes

handle string Optional

No description available.

maxLength: 128 bytes

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "handle": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "avatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "bannerUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 4096
    },
    "displayName": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    }
  }
}

publicationView object

A publication as shown in directory cards and profile headers.

Properties

description string Optional

No description available.

maxLength: 4096 bytes

did string did Required

A decentralized identifier (DID).

documentCount integer Required

No description available.

iconUrl string uri Optional

A valid URI.

lastDocumentAt string datetime Optional

An RFC 3339 formatted timestamp.

name string Required

No description available.

maxLength: 128 bytes

ownerAvatarUrl string uri Optional

A valid URI.

ownerHandle string Optional

No description available.

maxLength: 128 bytes

searchNameHtml string Optional

No description available.

maxLength: 512 bytes

searchSnippetHtml string Optional

No description available.

maxLength: 8192 bytes

subscriberCount integer Required

No description available.

topic string Optional

No description available.

maxLength: 128 bytes

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

url string uri Required

A valid URI.

verified boolean Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "did",
    "name",
    "url",
    "subscriberCount",
    "documentCount"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string",
      "maxLength": 128
    },
    "topic": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "iconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "verified": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 4096
    },
    "ownerHandle": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "documentCount": {
      "type": "integer"
    },
    "lastDocumentAt": {
      "type": "string",
      "format": "datetime",
      "nullable": true
    },
    "ownerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "searchNameHtml": {
      "type": "string",
      "nullable": true,
      "maxLength": 512
    },
    "subscriberCount": {
      "type": "integer"
    },
    "searchSnippetHtml": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    }
  },
  "description": "A publication as shown in directory cards and profile headers."
}

resolveViewArticle object

No description available.

Properties

authorAvatarUrl string uri Optional

A valid URI.

authorHandle string Optional

No description available.

maxLength: 128 bytes

authorName string Optional

No description available.

maxLength: 128 bytes

canonicalUrl string uri Optional

A valid URI.

commentCount integer Required

No description available.

documentUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

isBookmarked boolean Optional

No description available.

isFollowing boolean Optional

No description available.

isRead boolean Optional

No description available.

kind string Required

No description available.

maxLength: 64 bytes

publicationHandle string Optional

No description available.

maxLength: 128 bytes

publicationIconUrl string uri Optional

A valid URI.

publicationName string Optional

No description available.

maxLength: 128 bytes

publicationOwnerAvatarUrl string uri Optional

A valid URI.

publicationReaderUrl string uri Optional

A valid URI.

publicationSubscriberCount integer Optional

No description available.

publicationUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

publishedAt string datetime Optional

An RFC 3339 formatted timestamp.

readerUrl string uri Required

A valid URI.

readingMinutes integer Optional

No description available.

recommendCount integer Required

No description available.

title string Required

No description available.

maxLength: 512 bytes

View raw schema

{
  "type": "object",
  "required": [
    "kind",
    "documentUri",
    "title",
    "readerUrl",
    "recommendCount",
    "commentCount"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "article",
      "maxLength": 64
    },
    "title": {
      "type": "string",
      "maxLength": 512
    },
    "isRead": {
      "type": "boolean"
    },
    "readerUrl": {
      "type": "string",
      "format": "uri"
    },
    "authorName": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "documentUri": {
      "type": "string",
      "format": "at-uri"
    },
    "isFollowing": {
      "type": "boolean"
    },
    "publishedAt": {
      "type": "string",
      "format": "datetime",
      "nullable": true
    },
    "authorHandle": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "canonicalUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "commentCount": {
      "type": "integer"
    },
    "isBookmarked": {
      "type": "boolean"
    },
    "publicationUri": {
      "type": "string",
      "format": "at-uri",
      "nullable": true
    },
    "readingMinutes": {
      "type": "integer",
      "nullable": true
    },
    "recommendCount": {
      "type": "integer"
    },
    "authorAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationName": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "publicationHandle": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "publicationIconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationReaderUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationOwnerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationSubscriberCount": {
      "type": "integer",
      "nullable": true
    }
  }
}

resolveViewPublication object

No description available.

Properties

description string Optional

No description available.

maxLength: 4096 bytes

handle string Optional

No description available.

maxLength: 128 bytes

iconUrl string uri Optional

A valid URI.

isFollowing boolean Optional

No description available.

kind string Required

No description available.

maxLength: 64 bytes

name string Required

No description available.

maxLength: 128 bytes

ownerAvatarUrl string uri Optional

A valid URI.

publicationUri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

readerUrl string uri Required

A valid URI.

siteUrl string uri Optional

A valid URI.

subscriberCount integer Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "kind",
    "publicationUri",
    "name",
    "readerUrl"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "publication",
      "maxLength": 64
    },
    "name": {
      "type": "string",
      "maxLength": 128
    },
    "handle": {
      "type": "string",
      "nullable": true,
      "maxLength": 128
    },
    "iconUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "siteUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "readerUrl": {
      "type": "string",
      "format": "uri"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 4096
    },
    "isFollowing": {
      "type": "boolean"
    },
    "ownerAvatarUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "publicationUri": {
      "type": "string",
      "format": "at-uri"
    },
    "subscriberCount": {
      "type": "integer",
      "nullable": true
    }
  }
}

resolveViewReaderLink object

No description available.

Properties

kind string Required

No description available.

maxLength: 64 bytes

readerUrl string uri Required

A valid URI.

maxLength: 2048 bytes

View raw schema

{
  "type": "object",
  "required": [
    "kind",
    "readerUrl"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "reader-link",
      "maxLength": 64
    },
    "readerUrl": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048
    }
  }
}

resolveViewUnknown object

No description available.

Properties

kind string Required

No description available.

maxLength: 64 bytes

View raw schema

{
  "type": "object",
  "required": [
    "kind"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "unknown",
      "maxLength": 64
    }
  }
}