so.sprk.actor.defs

sprk.so

Documentation

contentLabelPref object

No description available.

Properties

label string Required

No description available.

labelerDid string did Optional

Which labeler does this preference apply to? If undefined, applies globally.

visibility string Required

No description available.

Known values: ignore, show, warn, hide
View raw schema 
{
  "type": "object",
  "required": [
    "label",
    "visibility"
  ],
  "properties": {
    "label": {
      "type": "string"
    },
    "labelerDid": {
      "type": "string",
      "format": "did",
      "description": "Which labeler does this preference apply to? If undefined, applies globally."
    },
    "visibility": {
      "type": "string",
      "knownValues": [
        "ignore",
        "show",
        "warn",
        "hide"
      ]
    }
  }
}
feedViewPref object

No description available.

Properties

feed string Required

The URI of the feed, or an identifier which describes the feed.

hideQuotePosts boolean Optional

Hide quote posts in the feed.

hideReplies boolean Optional

Hide replies in the feed.

hideRepliesByLikeCount integer Optional

Hide replies in the feed if they do not have this number of likes.

hideRepliesByUnfollowed boolean Optional

Hide replies in the feed if they are not by followed users.

hideReposts boolean Optional

Hide reposts in the feed.

View raw schema 
{
  "type": "object",
  "required": [
    "feed"
  ],
  "properties": {
    "feed": {
      "type": "string",
      "description": "The URI of the feed, or an identifier which describes the feed."
    },
    "hideReplies": {
      "type": "boolean",
      "description": "Hide replies in the feed."
    },
    "hideReposts": {
      "type": "boolean",
      "description": "Hide reposts in the feed."
    },
    "hideQuotePosts": {
      "type": "boolean",
      "description": "Hide quote posts in the feed."
    },
    "hideRepliesByLikeCount": {
      "type": "integer",
      "description": "Hide replies in the feed if they do not have this number of likes."
    },
    "hideRepliesByUnfollowed": {
      "type": "boolean",
      "default": true,
      "description": "Hide replies in the feed if they are not by followed users."
    }
  }
}
hiddenPostsPref object

No description available.

Properties

items array of stringat-uri Required

A list of URIs of posts the account owner has hidden.

View raw schema 
{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      },
      "description": "A list of URIs of posts the account owner has hidden."
    }
  }
}
interestsPref object

No description available.

Properties

tags array of string Required

A list of tags which describe the account owner's interests gathered during onboarding.

maxLength: 100 items
View raw schema 
{
  "type": "object",
  "required": [
    "tags"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 640,
        "maxGraphemes": 64
      },
      "maxLength": 100,
      "description": "A list of tags which describe the account owner's interests gathered during onboarding."
    }
  }
}
knownFollowers object

The subject's followers whom you also follow

Properties

count integer Required

No description available.

followers array of ref#profileViewBasic Required

No description available.

maxLength: 5 itemsminLength: 0 items
View raw schema 
{
  "type": "object",
  "required": [
    "count",
    "followers"
  ],
  "properties": {
    "count": {
      "type": "integer"
    },
    "followers": {
      "type": "array",
      "items": {
        "ref": "#profileViewBasic",
        "type": "ref"
      },
      "maxLength": 5,
      "minLength": 0
    }
  },
  "description": "The subject's followers whom you also follow"
}
labelerPrefItem 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"
    }
  }
}
labelersPref object

No description available.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "labelers"
  ],
  "properties": {
    "labelers": {
      "type": "array",
      "items": {
        "ref": "#labelerPrefItem",
        "type": "ref"
      }
    }
  }
}
mutedWord object

A word that the account owner has muted.

Properties

actorTarget string Optional

Groups of users to apply the muted word to. If undefined, applies to all users.

Known values: all, exclude-following
expiresAt string datetime Optional

The date and time at which the muted word will expire and no longer be applied.

id string Optional

No description available.

value string Required

The muted word itself.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
View raw schema 
{
  "type": "object",
  "required": [
    "value",
    "targets"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "value": {
      "type": "string",
      "maxLength": 10000,
      "description": "The muted word itself.",
      "maxGraphemes": 1000
    },
    "targets": {
      "type": "array",
      "items": {
        "ref": "so.sprk.actor.defs#mutedWordTarget",
        "type": "ref"
      },
      "description": "The intended targets of the muted word."
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "The date and time at which the muted word will expire and no longer be applied."
    },
    "actorTarget": {
      "type": "string",
      "default": "all",
      "description": "Groups of users to apply the muted word to. If undefined, applies to all users.",
      "knownValues": [
        "all",
        "exclude-following"
      ]
    }
  },
  "description": "A word that the account owner has muted."
}
mutedWordTarget string

No description available.

ConstraintsmaxLength: 640 bytes, maxGraphemes: 64 graphemes
Known Values (other values may be valid)
content tag
View raw schema 
{
  "type": "string",
  "maxLength": 640,
  "knownValues": [
    "content",
    "tag"
  ],
  "maxGraphemes": 64
}
mutedWordsPref object

No description available.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "so.sprk.actor.defs#mutedWord",
        "type": "ref"
      },
      "description": "A list of words the account owner has muted."
    }
  }
}
personalDetailsPref object

No description available.

Properties

birthDate string datetime Optional

The birth date of account owner.

View raw schema 
{
  "type": "object",
  "properties": {
    "birthDate": {
      "type": "string",
      "format": "datetime",
      "description": "The birth date of account owner."
    }
  }
}
preferences array

No description available.

View raw schema 
{
  "type": "array",
  "items": {
    "refs": [
      "#contentLabelPref",
      "#savedFeedsPref",
      "#personalDetailsPref",
      "#feedViewPref",
      "#threadViewPref",
      "#interestsPref",
      "#mutedWordsPref",
      "#hiddenPostsPref",
      "#labelersPref"
    ],
    "type": "union"
  }
}
profileAssociated object

No description available.

Properties

feedgens integer Optional

No description available.

labeler boolean Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "chat": {
      "ref": "#profileAssociatedChat",
      "type": "ref"
    },
    "labeler": {
      "type": "boolean"
    },
    "feedgens": {
      "type": "integer"
    }
  }
}
profileAssociatedChat object

No description available.

Properties

allowIncoming string Required

No description available.

Known values: all, none, following
View raw schema 
{
  "type": "object",
  "required": [
    "allowIncoming"
  ],
  "properties": {
    "allowIncoming": {
      "type": "string",
      "knownValues": [
        "all",
        "none",
        "following"
      ]
    }
  }
}
profileView object

No description available.

Properties

avatar string uri Optional

A valid URI.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes
did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

viewer ref #viewerState Optional

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "stories": {
      "type": "array",
      "items": {
        "ref": "so.sprk.story.defs#storyView",
        "type": "ref"
      },
      "description": "Recent stories from this profile author."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "associated": {
      "ref": "#profileAssociated",
      "type": "ref"
    },
    "description": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    }
  }
}
profileViewBasic object

No description available.

Properties

avatar string uri Optional

A valid URI.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

viewer ref #viewerState Optional

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "stories": {
      "type": "array",
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "description": "Recent stories from this profile author."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "associated": {
      "ref": "#profileAssociated",
      "type": "ref"
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    }
  }
}
profileViewDetailed object

No description available.

Properties

avatar string uri Optional

A valid URI.

banner string uri Optional

A valid URI.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes
did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
followersCount integer Optional

No description available.

followsCount integer Optional

No description available.

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

postsCount integer Optional

No description available.

viewer ref #viewerState Optional

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "banner": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "stories": {
      "type": "array",
      "items": {
        "ref": "so.sprk.story.defs#storyView",
        "type": "ref"
      },
      "description": "Recent stories from this profile author."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "associated": {
      "ref": "#profileAssociated",
      "type": "ref"
    },
    "pinnedPost": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    },
    "postsCount": {
      "type": "integer"
    },
    "description": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "followsCount": {
      "type": "integer"
    },
    "followersCount": {
      "type": "integer"
    }
  }
}
savedFeed object

No description available.

Properties

id string Required

No description available.

pinned boolean Required

No description available.

type string Required

No description available.

Known values: feed, timeline
value string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "type",
    "value",
    "pinned"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "knownValues": [
        "feed",
        "timeline"
      ]
    },
    "value": {
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    }
  }
}
savedFeedsPref object

No description available.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "so.sprk.actor.defs#savedFeed",
        "type": "ref"
      }
    }
  }
}
threadViewPref object

No description available.

Properties

sort string Optional

Sorting mode for threads.

Known values: oldest, newest, most-likes, random, hotness
View raw schema 
{
  "type": "object",
  "properties": {
    "sort": {
      "type": "string",
      "description": "Sorting mode for threads.",
      "knownValues": [
        "oldest",
        "newest",
        "most-likes",
        "random",
        "hotness"
      ]
    }
  }
}
viewerState object

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

Properties

blockedBy boolean Optional

No description available.

blocking string at-uri Optional

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

followedBy string at-uri Optional

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

following string at-uri Optional

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

muted boolean Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "muted": {
      "type": "boolean"
    },
    "blocking": {
      "type": "string",
      "format": "at-uri"
    },
    "blockedBy": {
      "type": "boolean"
    },
    "following": {
      "type": "string",
      "format": "at-uri"
    },
    "followedBy": {
      "type": "string",
      "format": "at-uri"
    },
    "knownFollowers": {
      "ref": "#knownFollowers",
      "type": "ref"
    }
  },
  "description": "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests."
}

Lexicon Garden

@