so.sprk.feed.defs

sprk.so

Documentation

blockedAuthor object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "viewer": {
      "ref": "so.sprk.actor.defs#viewerState",
      "type": "ref"
    }
  }
}
blockedPost object

No description available.

Properties

blocked boolean 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",
    "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

Referenceso.sprk.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

Referenceso.sprk.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

Referenceso.sprk.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

Referenceso.sprk.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"
}
feedViewPost object

No description available.

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

View raw schema 
{
  "type": "object",
  "required": [
    "post"
  ],
  "properties": {
    "post": {
      "ref": "#postView",
      "type": "ref"
    },
    "feedContext": {
      "type": "string",
      "maxLength": 2000,
      "description": "Context provided by feed generator that may be passed back alongside interactions."
    }
  }
}
generatorView object

No description available.

Properties

acceptsInteractions boolean Optional

No description available.

avatar string uri Optional

A valid URI.

cid string cid Required

A content identifier (CID) referencing immutable data.

description string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
did string did Required

A decentralized identifier (DID).

displayName string Required

No description available.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

likeCount integer Optional

No description available.

minimum: 0
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",
    "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": "so.sprk.actor.defs#profileView",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "likeCount": {
      "type": "integer",
      "minimum": 0
    },
    "description": {
      "type": "string",
      "maxLength": 3000,
      "maxGraphemes": 300
    },
    "displayName": {
      "type": "string"
    },
    "descriptionFacets": {
      "type": "array",
      "items": {
        "ref": "so.sprk.richtext.facet",
        "type": "ref"
      }
    },
    "acceptsInteractions": {
      "type": "boolean"
    }
  }
}
generatorViewerState object

No description available.

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

No description available.

Properties

event string Optional

No description available.

Known values: so.sprk.feed.defs#requestLess, so.sprk.feed.defs#requestMore, so.sprk.feed.defs#clickthroughItem, so.sprk.feed.defs#clickthroughAuthor, so.sprk.feed.defs#clickthroughReposter, so.sprk.feed.defs#clickthroughEmbed, so.sprk.feed.defs#interactionSeen, so.sprk.feed.defs#interactionLike, so.sprk.feed.defs#interactionRepost, so.sprk.feed.defs#interactionReply, so.sprk.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).

View raw schema 
{
  "type": "object",
  "properties": {
    "item": {
      "type": "string",
      "format": "at-uri"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "so.sprk.feed.defs#requestLess",
        "so.sprk.feed.defs#requestMore",
        "so.sprk.feed.defs#clickthroughItem",
        "so.sprk.feed.defs#clickthroughAuthor",
        "so.sprk.feed.defs#clickthroughReposter",
        "so.sprk.feed.defs#clickthroughEmbed",
        "so.sprk.feed.defs#interactionSeen",
        "so.sprk.feed.defs#interactionLike",
        "so.sprk.feed.defs#interactionRepost",
        "so.sprk.feed.defs#interactionReply",
        "so.sprk.feed.defs#interactionShare"
      ]
    },
    "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

Referenceso.sprk.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"
}
interactionReply token

User replied to the feed item

Referenceso.sprk.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

Referenceso.sprk.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

Referenceso.sprk.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

Referenceso.sprk.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"
}
knownLike object

No description available.

Properties

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": "so.sprk.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
knownReply object

No description available.

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

text string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
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": "so.sprk.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "text": {
      "type": "string",
      "maxLength": 3000,
      "maxGraphemes": 300
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
knownRepost object

No description available.

Properties

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": "so.sprk.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
notFoundPost object

No description available.

Properties

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

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

likeCount integer Optional

No description available.

record unknown Required

No description available.

replyCount integer Optional

No description available.

repostCount integer Optional

No description available.

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

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "record",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "media": {
      "refs": [
        "so.sprk.media.images#view",
        "so.sprk.media.video#view"
      ],
      "type": "union"
    },
    "sound": {
      "ref": "so.sprk.sound.defs#audioView",
      "type": "ref"
    },
    "author": {
      "ref": "so.sprk.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"
    },
    "replyCount": {
      "type": "integer"
    },
    "threadgate": {
      "ref": "#threadgateView",
      "type": "ref"
    },
    "repostCount": {
      "type": "integer"
    }
  }
}
replyRef object

No description available.

Properties

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

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

likeCount integer Optional

No description available.

record unknown Required

No description available.

replyCount integer Optional

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",
    "cid",
    "author",
    "record",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "media": {
      "refs": [
        "so.sprk.media.image#view"
      ],
      "type": "union"
    },
    "author": {
      "ref": "so.sprk.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "record": {
      "type": "unknown"
    },
    "viewer": {
      "ref": "#replyViewerState",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "likeCount": {
      "type": "integer"
    },
    "replyCount": {
      "type": "integer"
    }
  }
}
replyViewerState object

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

Properties

embeddingDisabled boolean Optional

No description available.

like string at-uri Optional

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

replyDisabled boolean Optional

No description available.

threadMuted boolean Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "like": {
      "type": "string",
      "format": "at-uri"
    },
    "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."
}
requestLess token

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

Referenceso.sprk.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

Referenceso.sprk.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

No description available.

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

View raw schema 
{
  "type": "object",
  "required": [
    "post"
  ],
  "properties": {
    "post": {
      "type": "string",
      "format": "at-uri"
    },
    "feedContext": {
      "type": "string",
      "maxLength": 2000,
      "description": "Context that will be passed through to client and may be passed to feed generator back alongside interactions."
    }
  }
}
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

No description available.

Properties

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

No description available.

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

record unknown Optional

No description available.

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"
    },
    "record": {
      "type": "unknown"
    }
  }
}
viewerState object

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

Properties

embeddingDisabled boolean Optional

No description available.

like string at-uri Optional

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

replyDisabled boolean Optional

No description available.

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

View raw schema 
{
  "type": "object",
  "properties": {
    "like": {
      "type": "string",
      "format": "at-uri"
    },
    "repost": {
      "type": "string",
      "format": "at-uri"
    },
    "threadMuted": {
      "type": "boolean"
    },
    "replyDisabled": {
      "type": "boolean"
    },
    "embeddingDisabled": {
      "type": "boolean"
    },
    "knownInteractions": {
      "type": "array",
      "items": {
        "refs": [
          "#knownRepost",
          "#knownLike",
          "#knownReply"
        ],
        "type": "union"
      }
    }
  },
  "description": "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests."
}

Lexicon Garden

@