app.bsky.feed.defs

blockedAuthor object

Properties

did string did Required

A decentralized identifier (DID).

viewer ref app.bsky.actor.defs#viewerState Optional

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "viewer": {
      "ref": "app.bsky.actor.defs#viewerState",
      "type": "ref"
    }
  }
}

blockedPost object

Properties

author ref #blockedAuthor Required

No description provided.

blocked boolean Required

No description provided.

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",
    "blocked",
    "author"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "author": {
      "ref": "#blockedAuthor",
      "type": "ref"
    },
    "blocked": {
      "type": "boolean",
      "const": true
    }
  }
}

clickthroughAuthor token

User clicked through to the author of the feed item

Referenceapp.bsky.feed.defs#clickthroughAuthor

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User clicked through to the author of the feed item"
}

clickthroughEmbed token

User clicked through to the embedded content of the feed item

Referenceapp.bsky.feed.defs#clickthroughEmbed

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User clicked through to the embedded content of the feed item"
}

clickthroughItem token

User clicked through to the feed item

Referenceapp.bsky.feed.defs#clickthroughItem

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User clicked through to the feed item"
}

clickthroughReposter token

User clicked through to the reposter of the feed item

Referenceapp.bsky.feed.defs#clickthroughReposter

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User clicked through to the reposter of the feed item"
}

contentModeUnspecified token

Declares the feed generator returns any types of posts.

Referenceapp.bsky.feed.defs#contentModeUnspecified

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Declares the feed generator returns any types of posts."
}

contentModeVideo token

Declares the feed generator returns posts containing app.bsky.embed.video embeds.

Referenceapp.bsky.feed.defs#contentModeVideo

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Declares the feed generator returns posts containing app.bsky.embed.video embeds."
}

feedViewPost object

Properties

feedContext string Optional

Context provided by feed generator that may be passed back alongside interactions.

maxLength: 2000 bytes

post ref #postView Required

No description provided.

reason union Optional

No description provided.

Known types:

#reasonRepost
#reasonPin

reply ref #replyRef Optional

No description provided.

reqId string Optional

Unique identifier per request that may be passed back alongside interactions.

maxLength: 100 bytes

View raw schema

{
  "type": "object",
  "required": [
    "post"
  ],
  "properties": {
    "post": {
      "ref": "#postView",
      "type": "ref"
    },
    "reply": {
      "ref": "#replyRef",
      "type": "ref"
    },
    "reqId": {
      "type": "string",
      "maxLength": 100,
      "description": "Unique identifier per request that may be passed back alongside interactions."
    },
    "reason": {
      "refs": [
        "#reasonRepost",
        "#reasonPin"
      ],
      "type": "union"
    },
    "feedContext": {
      "type": "string",
      "maxLength": 2000,
      "description": "Context provided by feed generator that may be passed back alongside interactions."
    }
  }
}

generatorView object

Properties

acceptsInteractions boolean Optional

No description provided.

avatar string uri Optional

A valid URI.

cid string cid Required

A content identifier (CID) referencing immutable data.

contentMode string Optional

No description provided.

Known values: app.bsky.feed.defs#contentModeUnspecified, app.bsky.feed.defs#contentModeVideo

creator ref app.bsky.actor.defs#profileView Required

No description provided.

description string Optional

No description provided.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

descriptionFacets array of refapp.bsky.richtext.facet Optional

No description provided.

did string did Required

A decentralized identifier (DID).

displayName string Required

No description provided.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

No description provided.

likeCount integer Optional

No description provided.

minimum: 0

uri string at-uri Required

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

viewer ref #generatorViewerState Optional

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "did",
    "creator",
    "displayName",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "viewer": {
      "ref": "#generatorViewerState",
      "type": "ref"
    },
    "creator": {
      "ref": "app.bsky.actor.defs#profileView",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "likeCount": {
      "type": "integer",
      "minimum": 0
    },
    "contentMode": {
      "type": "string",
      "knownValues": [
        "app.bsky.feed.defs#contentModeUnspecified",
        "app.bsky.feed.defs#contentModeVideo"
      ]
    },
    "description": {
      "type": "string",
      "maxLength": 3000,
      "maxGraphemes": 300
    },
    "displayName": {
      "type": "string"
    },
    "descriptionFacets": {
      "type": "array",
      "items": {
        "ref": "app.bsky.richtext.facet",
        "type": "ref"
      }
    },
    "acceptsInteractions": {
      "type": "boolean"
    }
  }
}

generatorViewerState object

Properties

like string at-uri Optional

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

View raw schema

{
  "type": "object",
  "properties": {
    "like": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

interaction object

Properties

event string Optional

No description provided.

Known values: app.bsky.feed.defs#requestLess, app.bsky.feed.defs#requestMore, app.bsky.feed.defs#clickthroughItem, app.bsky.feed.defs#clickthroughAuthor, app.bsky.feed.defs#clickthroughReposter, app.bsky.feed.defs#clickthroughEmbed, app.bsky.feed.defs#interactionSeen, app.bsky.feed.defs#interactionLike, app.bsky.feed.defs#interactionRepost, app.bsky.feed.defs#interactionReply, app.bsky.feed.defs#interactionQuote, app.bsky.feed.defs#interactionShare

feedContext string Optional

Context on a feed item that was originally supplied by the feed generator on getFeedSkeleton.

maxLength: 2000 bytes

item string at-uri Optional

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

reqId string Optional

Unique identifier per request that may be passed back alongside interactions.

maxLength: 100 bytes

View raw schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": "string",
      "format": "at-uri"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "app.bsky.feed.defs#requestLess",
        "app.bsky.feed.defs#requestMore",
        "app.bsky.feed.defs#clickthroughItem",
        "app.bsky.feed.defs#clickthroughAuthor",
        "app.bsky.feed.defs#clickthroughReposter",
        "app.bsky.feed.defs#clickthroughEmbed",
        "app.bsky.feed.defs#interactionSeen",
        "app.bsky.feed.defs#interactionLike",
        "app.bsky.feed.defs#interactionRepost",
        "app.bsky.feed.defs#interactionReply",
        "app.bsky.feed.defs#interactionQuote",
        "app.bsky.feed.defs#interactionShare"
      ]
    },
    "reqId": {
      "type": "string",
      "maxLength": 100,
      "description": "Unique identifier per request that may be passed back alongside interactions."
    },
    "feedContext": {
      "type": "string",
      "maxLength": 2000,
      "description": "Context on a feed item that was originally supplied by the feed generator on getFeedSkeleton."
    }
  }
}

interactionLike token

User liked the feed item

Referenceapp.bsky.feed.defs#interactionLike

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User liked the feed item"
}

interactionQuote token

User quoted the feed item

Referenceapp.bsky.feed.defs#interactionQuote

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User quoted the feed item"
}

interactionReply token

User replied to the feed item

Referenceapp.bsky.feed.defs#interactionReply

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User replied to the feed item"
}

interactionRepost token

User reposted the feed item

Referenceapp.bsky.feed.defs#interactionRepost

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User reposted the feed item"
}

interactionSeen token

Feed item was seen by user

Referenceapp.bsky.feed.defs#interactionSeen

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Feed item was seen by user"
}

interactionShare token

User shared the feed item

Referenceapp.bsky.feed.defs#interactionShare

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "User shared the feed item"
}

notFoundPost object

Properties

notFound boolean Required

No description provided.

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",
    "notFound"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "notFound": {
      "type": "boolean",
      "const": true
    }
  }
}

postView object

Properties

author ref app.bsky.actor.defs#profileViewBasic Required

No description provided.

bookmarkCount integer Optional

No description provided.

cid string cid Required

A content identifier (CID) referencing immutable data.

debug unknown Optional

Debug information for internal development

embed union Optional

No description provided.

Known types:

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

No description provided.

likeCount integer Optional

No description provided.

quoteCount integer Optional

No description provided.

record unknown Required

No description provided.

replyCount integer Optional

No description provided.

repostCount integer Optional

No description provided.

threadgate ref #threadgateView Optional

No description provided.

uri string at-uri Required

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

viewer ref #viewerState Optional

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "record",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "debug": {
      "type": "unknown",
      "description": "Debug information for internal development"
    },
    "embed": {
      "refs": [
        "app.bsky.embed.images#view",
        "app.bsky.embed.video#view",
        "app.bsky.embed.external#view",
        "app.bsky.embed.record#view",
        "app.bsky.embed.recordWithMedia#view"
      ],
      "type": "union"
    },
    "author": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "record": {
      "type": "unknown"
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "likeCount": {
      "type": "integer"
    },
    "quoteCount": {
      "type": "integer"
    },
    "replyCount": {
      "type": "integer"
    },
    "threadgate": {
      "ref": "#threadgateView",
      "type": "ref"
    },
    "repostCount": {
      "type": "integer"
    },
    "bookmarkCount": {
      "type": "integer"
    }
  }
}

reasonPin object

This object has no properties defined.

View raw schema

{
  "type": "object",
  "properties": {}
}

reasonRepost object

Properties

by ref app.bsky.actor.defs#profileViewBasic Required

No description provided.

cid string cid Optional

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

uri string at-uri Optional

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

View raw schema

{
  "type": "object",
  "required": [
    "by",
    "indexedAt"
  ],
  "properties": {
    "by": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

replyRef object

Properties

grandparentAuthor ref app.bsky.actor.defs#profileViewBasic Optional

When parent is a reply to another post, this is the author of that post.

parent union Required

No description provided.

Known types:

#postView
#notFoundPost
#blockedPost

root union Required

No description provided.

Known types:

#postView
#notFoundPost
#blockedPost

View raw schema

{
  "type": "object",
  "required": [
    "root",
    "parent"
  ],
  "properties": {
    "root": {
      "refs": [
        "#postView",
        "#notFoundPost",
        "#blockedPost"
      ],
      "type": "union"
    },
    "parent": {
      "refs": [
        "#postView",
        "#notFoundPost",
        "#blockedPost"
      ],
      "type": "union"
    },
    "grandparentAuthor": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref",
      "description": "When parent is a reply to another post, this is the author of that post."
    }
  }
}

requestLess token

Request that less content like the given feed item be shown in the feed

Referenceapp.bsky.feed.defs#requestLess

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Request that less content like the given feed item be shown in the feed"
}

requestMore token

Request that more content like the given feed item be shown in the feed

Referenceapp.bsky.feed.defs#requestMore

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "Request that more content like the given feed item be shown in the feed"
}

skeletonFeedPost object

Properties

feedContext string Optional

Context that will be passed through to client and may be passed to feed generator back alongside interactions.

maxLength: 2000 bytes

post string at-uri Required

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

reason union Optional

No description provided.

Known types:

#skeletonReasonRepost
#skeletonReasonPin

View raw schema

{
  "type": "object",
  "required": [
    "post"
  ],
  "properties": {
    "post": {
      "type": "string",
      "format": "at-uri"
    },
    "reason": {
      "refs": [
        "#skeletonReasonRepost",
        "#skeletonReasonPin"
      ],
      "type": "union"
    },
    "feedContext": {
      "type": "string",
      "maxLength": 2000,
      "description": "Context that will be passed through to client and may be passed to feed generator back alongside interactions."
    }
  }
}

skeletonReasonPin object

This object has no properties defined.

View raw schema

{
  "type": "object",
  "properties": {}
}

skeletonReasonRepost object

Properties

repost 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": [
    "repost"
  ],
  "properties": {
    "repost": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

threadContext object

Metadata about this post within the context of the thread it is in.

Properties

rootAuthorLike string at-uri Optional

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

View raw schema

{
  "type": "object",
  "properties": {
    "rootAuthorLike": {
      "type": "string",
      "format": "at-uri"
    }
  },
  "description": "Metadata about this post within the context of the thread it is in."
}

threadViewPost object

Properties

parent union Optional

No description provided.

Known types:

#threadViewPost
#notFoundPost
#blockedPost

post ref #postView Required

No description provided.

replies array of union Optional

No description provided.

Known types:

#threadViewPost
#notFoundPost
#blockedPost

threadContext ref #threadContext Optional

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "post"
  ],
  "properties": {
    "post": {
      "ref": "#postView",
      "type": "ref"
    },
    "parent": {
      "refs": [
        "#threadViewPost",
        "#notFoundPost",
        "#blockedPost"
      ],
      "type": "union"
    },
    "replies": {
      "type": "array",
      "items": {
        "refs": [
          "#threadViewPost",
          "#notFoundPost",
          "#blockedPost"
        ],
        "type": "union"
      }
    },
    "threadContext": {
      "ref": "#threadContext",
      "type": "ref"
    }
  }
}

threadgateView object

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

lists array of refapp.bsky.graph.defs#listViewBasic Optional

No description provided.

record unknown Optional

No description provided.

uri string at-uri Optional

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

View raw schema

{
  "type": "object",
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "lists": {
      "type": "array",
      "items": {
        "ref": "app.bsky.graph.defs#listViewBasic",
        "type": "ref"
      }
    },
    "record": {
      "type": "unknown"
    }
  }
}

viewerState object

Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.

Properties

bookmarked boolean Optional

No description provided.

embeddingDisabled boolean Optional

No description provided.

like string at-uri Optional

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

pinned boolean Optional

No description provided.

replyDisabled boolean Optional

No description provided.

repost string at-uri Optional

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

threadMuted boolean Optional

No description provided.

View raw schema

{
  "type": "object",
  "properties": {
    "like": {
      "type": "string",
      "format": "at-uri"
    },
    "pinned": {
      "type": "boolean"
    },
    "repost": {
      "type": "string",
      "format": "at-uri"
    },
    "bookmarked": {
      "type": "boolean"
    },
    "threadMuted": {
      "type": "boolean"
    },
    "replyDisabled": {
      "type": "boolean"
    },
    "embeddingDisabled": {
      "type": "boolean"
    }
  },
  "description": "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests."
}

app.bsky.feed.defs

Documentation

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties