add @bsky.app/sdk + @atproto/lex, vendor lexicons, codegen via lex cli

This commit is contained in:
Samuel Newman
2026-07-15 16:06:20 +03:00
parent 17c1ee4869
commit 15e232749a
306 changed files with 22544 additions and 2 deletions
+3
View File
@@ -117,6 +117,9 @@ src/locale/locales/**/messages.js
src/locale/locales/**/messages.mjs
src/locale/locales/**/messages.ts
# generated lexicon schemas (pnpm lexicons:generate)
src/lexicons/
# local builds
*.apk
*.aab
+1
View File
@@ -62,6 +62,7 @@
"bskyogcard/**",
"src/locale/locales/_build/**",
"src/locale/locales/**/*.js",
"src/lexicons/**",
"*.e2e.ts",
"*.e2e.tsx",
"eslint.config.mjs",
+1
View File
@@ -18,6 +18,7 @@
android
ios
src/locale/locales
src/lexicons
lib/react-compiler-runtime
bskyweb/static
coverage
+1480
View File
File diff suppressed because it is too large Load Diff
+868
View File
@@ -0,0 +1,868 @@
{
"lexicon": 1,
"id": "app.bsky.actor.defs",
"defs": {
"profileViewBasic": {
"type": "object",
"required": ["did", "handle"],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"handle": {
"type": "string",
"format": "handle"
},
"displayName": {
"type": "string",
"maxGraphemes": 64,
"maxLength": 640
},
"pronouns": {
"type": "string"
},
"avatar": {
"type": "string",
"format": "uri"
},
"associated": {
"type": "ref",
"ref": "#profileAssociated"
},
"viewer": {
"type": "ref",
"ref": "#viewerState"
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"verification": {
"type": "ref",
"ref": "#verificationState"
},
"status": {
"type": "ref",
"ref": "#statusView"
},
"debug": {
"type": "unknown",
"description": "Debug information for internal development"
}
}
},
"profileView": {
"type": "object",
"required": ["did", "handle"],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"handle": {
"type": "string",
"format": "handle"
},
"displayName": {
"type": "string",
"maxGraphemes": 64,
"maxLength": 640
},
"pronouns": {
"type": "string"
},
"description": {
"type": "string",
"maxGraphemes": 256,
"maxLength": 2560
},
"avatar": {
"type": "string",
"format": "uri"
},
"associated": {
"type": "ref",
"ref": "#profileAssociated"
},
"indexedAt": {
"type": "string",
"format": "datetime"
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"viewer": {
"type": "ref",
"ref": "#viewerState"
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"verification": {
"type": "ref",
"ref": "#verificationState"
},
"status": {
"type": "ref",
"ref": "#statusView"
},
"debug": {
"type": "unknown",
"description": "Debug information for internal development"
}
}
},
"profileViewDetailed": {
"type": "object",
"required": ["did", "handle"],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"handle": {
"type": "string",
"format": "handle"
},
"displayName": {
"type": "string",
"maxGraphemes": 64,
"maxLength": 640
},
"description": {
"type": "string",
"maxGraphemes": 256,
"maxLength": 2560
},
"pronouns": {
"type": "string"
},
"website": {
"type": "string",
"format": "uri"
},
"avatar": {
"type": "string",
"format": "uri"
},
"banner": {
"type": "string",
"format": "uri"
},
"followersCount": {
"type": "integer"
},
"followsCount": {
"type": "integer"
},
"postsCount": {
"type": "integer"
},
"associated": {
"type": "ref",
"ref": "#profileAssociated"
},
"joinedViaStarterPack": {
"type": "ref",
"ref": "app.bsky.graph.defs#starterPackViewBasic"
},
"indexedAt": {
"type": "string",
"format": "datetime"
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"viewer": {
"type": "ref",
"ref": "#viewerState"
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"pinnedPost": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"verification": {
"type": "ref",
"ref": "#verificationState"
},
"status": {
"type": "ref",
"ref": "#statusView"
},
"debug": {
"type": "unknown",
"description": "Debug information for internal development"
}
}
},
"profileAssociated": {
"type": "object",
"properties": {
"lists": {
"type": "integer"
},
"feedgens": {
"type": "integer"
},
"starterPacks": {
"type": "integer"
},
"labeler": {
"type": "boolean"
},
"chat": {
"type": "ref",
"ref": "#profileAssociatedChat"
},
"activitySubscription": {
"type": "ref",
"ref": "#profileAssociatedActivitySubscription"
},
"germ": {
"type": "ref",
"ref": "#profileAssociatedGerm"
}
}
},
"profileAssociatedChat": {
"type": "object",
"required": ["allowIncoming"],
"properties": {
"allowIncoming": {
"type": "string",
"knownValues": ["all", "none", "following"]
},
"allowGroupInvites": {
"type": "string",
"knownValues": ["all", "none", "following"]
}
}
},
"profileAssociatedGerm": {
"type": "object",
"required": ["showButtonTo", "messageMeUrl"],
"properties": {
"messageMeUrl": {
"type": "string",
"format": "uri"
},
"showButtonTo": {
"type": "string",
"knownValues": ["usersIFollow", "everyone"]
}
}
},
"profileAssociatedActivitySubscription": {
"type": "object",
"required": ["allowSubscriptions"],
"properties": {
"allowSubscriptions": {
"type": "string",
"knownValues": ["followers", "mutuals", "none"]
}
}
},
"viewerState": {
"type": "object",
"description": "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.",
"properties": {
"muted": {
"type": "boolean"
},
"mutedByList": {
"type": "ref",
"ref": "app.bsky.graph.defs#listViewBasic"
},
"blockedBy": {
"type": "boolean"
},
"blocking": {
"type": "string",
"format": "at-uri"
},
"blockingByList": {
"type": "ref",
"ref": "app.bsky.graph.defs#listViewBasic"
},
"following": {
"type": "string",
"format": "at-uri"
},
"followedBy": {
"type": "string",
"format": "at-uri"
},
"knownFollowers": {
"description": "This property is present only in selected cases, as an optimization.",
"type": "ref",
"ref": "#knownFollowers"
},
"activitySubscription": {
"description": "This property is present only in selected cases, as an optimization.",
"type": "ref",
"ref": "app.bsky.notification.defs#activitySubscription"
}
}
},
"knownFollowers": {
"type": "object",
"description": "The subject's followers whom you also follow",
"required": ["count", "followers"],
"properties": {
"count": {
"type": "integer"
},
"followers": {
"type": "array",
"minLength": 0,
"maxLength": 5,
"items": {
"type": "ref",
"ref": "#profileViewBasic"
}
}
}
},
"verificationState": {
"type": "object",
"description": "Represents the verification information about the user this object is attached to.",
"required": ["verifications", "verifiedStatus", "trustedVerifierStatus"],
"properties": {
"verifications": {
"type": "array",
"description": "All verifications issued by trusted verifiers on behalf of this user. Verifications by untrusted verifiers are not included.",
"items": {
"type": "ref",
"ref": "#verificationView"
}
},
"verifiedStatus": {
"type": "string",
"description": "The user's status as a verified account.",
"knownValues": ["valid", "invalid", "none"]
},
"trustedVerifierStatus": {
"type": "string",
"description": "The user's status as a trusted verifier.",
"knownValues": ["valid", "invalid", "none"]
}
}
},
"verificationView": {
"type": "object",
"description": "An individual verification for an associated subject.",
"required": ["issuer", "uri", "isValid", "createdAt"],
"properties": {
"issuer": {
"type": "string",
"description": "The user who issued this verification.",
"format": "did"
},
"issuerDisplayName": {
"type": "string",
"description": "The display name of the issuer."
},
"issuerHandle": {
"type": "string",
"description": "The handle of the issuer.",
"format": "handle"
},
"uri": {
"type": "string",
"description": "The AT-URI of the verification record.",
"format": "at-uri"
},
"isValid": {
"type": "boolean",
"description": "True if the verification passes validation, otherwise false."
},
"createdAt": {
"type": "string",
"description": "Timestamp when the verification was created.",
"format": "datetime"
}
}
},
"preferences": {
"type": "array",
"items": {
"type": "union",
"refs": [
"#adultContentPref",
"#contentLabelPref",
"#savedFeedsPref",
"#savedFeedsPrefV2",
"#personalDetailsPref",
"#declaredAgePref",
"#feedViewPref",
"#threadViewPref",
"#interestsPref",
"#mutedWordsPref",
"#hiddenPostsPref",
"#bskyAppStatePref",
"#labelersPref",
"#postInteractionSettingsPref",
"#verificationPrefs",
"#liveEventPreferences"
]
}
},
"adultContentPref": {
"type": "object",
"required": ["enabled"],
"properties": {
"enabled": {
"type": "boolean",
"default": false
}
}
},
"contentLabelPref": {
"type": "object",
"required": ["label", "visibility"],
"properties": {
"labelerDid": {
"type": "string",
"description": "Which labeler does this preference apply to? If undefined, applies globally.",
"format": "did"
},
"label": {
"type": "string"
},
"visibility": {
"type": "string",
"knownValues": ["ignore", "show", "warn", "hide"]
}
}
},
"savedFeed": {
"type": "object",
"required": ["id", "type", "value", "pinned"],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"knownValues": ["feed", "list", "timeline"]
},
"value": {
"type": "string"
},
"pinned": {
"type": "boolean"
}
}
},
"savedFeedsPrefV2": {
"type": "object",
"required": ["items"],
"properties": {
"items": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#savedFeed"
}
}
}
},
"savedFeedsPref": {
"type": "object",
"required": ["pinned", "saved"],
"properties": {
"pinned": {
"type": "array",
"items": {
"type": "string",
"format": "at-uri"
}
},
"saved": {
"type": "array",
"items": {
"type": "string",
"format": "at-uri"
}
},
"timelineIndex": {
"type": "integer"
}
}
},
"personalDetailsPref": {
"type": "object",
"properties": {
"birthDate": {
"type": "string",
"format": "datetime",
"description": "The birth date of account owner."
}
}
},
"declaredAgePref": {
"type": "object",
"description": "Read-only preference containing value(s) inferred from the user's declared birthdate. Absence of this preference object in the response indicates that the user has not made a declaration.",
"properties": {
"isOverAge13": {
"type": "boolean",
"description": "Indicates if the user has declared that they are over 13 years of age."
},
"isOverAge16": {
"type": "boolean",
"description": "Indicates if the user has declared that they are over 16 years of age."
},
"isOverAge18": {
"type": "boolean",
"description": "Indicates if the user has declared that they are over 18 years of age."
}
}
},
"feedViewPref": {
"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."
},
"hideRepliesByUnfollowed": {
"type": "boolean",
"description": "Hide replies in the feed if they are not by followed users.",
"default": true
},
"hideRepliesByLikeCount": {
"type": "integer",
"description": "Hide replies in the feed if they do not have this number of likes."
},
"hideReposts": {
"type": "boolean",
"description": "Hide reposts in the feed."
},
"hideQuotePosts": {
"type": "boolean",
"description": "Hide quote posts in the feed."
}
}
},
"threadViewPref": {
"type": "object",
"properties": {
"sort": {
"type": "string",
"description": "Sorting mode for threads.",
"knownValues": ["oldest", "newest", "most-likes", "random", "hotness"]
}
}
},
"interestsPref": {
"type": "object",
"required": ["tags"],
"properties": {
"tags": {
"type": "array",
"maxLength": 100,
"items": {
"type": "string",
"maxLength": 640,
"maxGraphemes": 64
},
"description": "A list of tags which describe the account owner's interests gathered during onboarding."
}
}
},
"mutedWordTarget": {
"type": "string",
"knownValues": ["content", "tag"],
"maxLength": 640,
"maxGraphemes": 64
},
"mutedWord": {
"type": "object",
"description": "A word that the account owner has muted.",
"required": ["value", "targets"],
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "string",
"description": "The muted word itself.",
"maxLength": 10000,
"maxGraphemes": 1000
},
"targets": {
"type": "array",
"description": "The intended targets of the muted word.",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#mutedWordTarget"
}
},
"actorTarget": {
"type": "string",
"description": "Groups of users to apply the muted word to. If undefined, applies to all users.",
"knownValues": ["all", "exclude-following"],
"default": "all"
},
"expiresAt": {
"type": "string",
"format": "datetime",
"description": "The date and time at which the muted word will expire and no longer be applied."
}
}
},
"mutedWordsPref": {
"type": "object",
"required": ["items"],
"properties": {
"items": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#mutedWord"
},
"description": "A list of words the account owner has muted."
}
}
},
"hiddenPostsPref": {
"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."
}
}
},
"labelersPref": {
"type": "object",
"required": ["labelers"],
"properties": {
"labelers": {
"type": "array",
"items": {
"type": "ref",
"ref": "#labelerPrefItem"
}
}
}
},
"labelerPrefItem": {
"type": "object",
"required": ["did"],
"properties": {
"did": {
"type": "string",
"format": "did"
}
}
},
"bskyAppStatePref": {
"description": "A grab bag of state that's specific to the bsky.app program. Third-party apps shouldn't use this.",
"type": "object",
"properties": {
"activeProgressGuide": {
"type": "ref",
"ref": "#bskyAppProgressGuide"
},
"isBetaUser": {
"description": "Indicates if the user is participating in the beta features program.",
"type": "boolean"
},
"queuedNudges": {
"description": "An array of tokens which identify nudges (modals, popups, tours, highlight dots) that should be shown to the user.",
"type": "array",
"maxLength": 1000,
"items": {
"type": "string",
"maxLength": 100
}
},
"nuxs": {
"description": "Storage for NUXs the user has encountered.",
"type": "array",
"maxLength": 100,
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#nux"
}
}
}
},
"bskyAppProgressGuide": {
"description": "If set, an active progress guide. Once completed, can be set to undefined. Should have unspecced fields tracking progress.",
"type": "object",
"required": ["guide"],
"properties": {
"guide": {
"type": "string",
"maxLength": 100
}
}
},
"nux": {
"type": "object",
"description": "A new user experiences (NUX) storage object",
"required": ["id", "completed"],
"properties": {
"id": {
"type": "string",
"maxLength": 100
},
"completed": {
"type": "boolean",
"default": false
},
"data": {
"description": "Arbitrary data for the NUX. The structure is defined by the NUX itself. Limited to 300 characters.",
"type": "string",
"maxLength": 3000,
"maxGraphemes": 300
},
"expiresAt": {
"type": "string",
"format": "datetime",
"description": "The date and time at which the NUX will expire and should be considered completed."
}
}
},
"verificationPrefs": {
"type": "object",
"description": "Preferences for how verified accounts appear in the app.",
"required": [],
"properties": {
"hideBadges": {
"description": "Hide the blue check badges for verified accounts and trusted verifiers.",
"type": "boolean",
"default": false
}
}
},
"liveEventPreferences": {
"type": "object",
"description": "Preferences for live events.",
"properties": {
"hiddenFeedIds": {
"description": "A list of feed IDs that the user has hidden from live events.",
"type": "array",
"items": {
"type": "string"
}
},
"hideAllFeeds": {
"description": "Whether to hide all feeds from live events.",
"type": "boolean",
"default": false
}
}
},
"postInteractionSettingsPref": {
"type": "object",
"description": "Default post interaction settings for the account. These values should be applied as default values when creating new posts. These refs should mirror the threadgate and postgate records exactly.",
"required": [],
"properties": {
"threadgateAllowRules": {
"description": "Matches threadgate record. List of rules defining who can reply to this users posts. If value is an empty array, no one can reply. If value is undefined, anyone can reply.",
"type": "array",
"maxLength": 5,
"items": {
"type": "union",
"refs": [
"app.bsky.feed.threadgate#mentionRule",
"app.bsky.feed.threadgate#followerRule",
"app.bsky.feed.threadgate#followingRule",
"app.bsky.feed.threadgate#listRule"
]
}
},
"postgateEmbeddingRules": {
"description": "Matches postgate record. List of rules defining who can embed this users posts. If value is an empty array or is undefined, no particular rules apply and anyone can embed.",
"type": "array",
"maxLength": 5,
"items": {
"type": "union",
"refs": ["app.bsky.feed.postgate#disableRule"]
}
}
}
},
"statusView": {
"type": "object",
"required": ["status", "record"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"status": {
"type": "string",
"description": "The status for the account.",
"knownValues": ["app.bsky.actor.status#live"]
},
"record": {
"type": "unknown"
},
"embed": {
"type": "union",
"description": "An optional embed associated with the status.",
"refs": ["app.bsky.embed.external#view"]
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"expiresAt": {
"type": "string",
"description": "The date when this status will expire. The application might choose to no longer return the status after expiration.",
"format": "datetime"
},
"isActive": {
"type": "boolean",
"description": "True if the status is not expired, false if it is expired. Only present if expiration was set."
},
"isDisabled": {
"type": "boolean",
"description": "True if the user's go-live access has been disabled by a moderator, false otherwise."
}
}
}
}
}
@@ -0,0 +1,27 @@
{
"lexicon": 1,
"id": "app.bsky.actor.getPreferences",
"defs": {
"main": {
"type": "query",
"description": "Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.",
"parameters": {
"type": "params",
"properties": {}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["preferences"],
"properties": {
"preferences": {
"type": "ref",
"ref": "app.bsky.actor.defs#preferences"
}
}
}
}
}
}
}
+28
View File
@@ -0,0 +1,28 @@
{
"lexicon": 1,
"id": "app.bsky.actor.getProfile",
"defs": {
"main": {
"type": "query",
"description": "Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier",
"description": "Handle or DID of account to fetch profile of."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewDetailed"
}
}
}
}
}
+40
View File
@@ -0,0 +1,40 @@
{
"lexicon": 1,
"id": "app.bsky.actor.getProfiles",
"defs": {
"main": {
"type": "query",
"description": "Get detailed profile views of multiple actors.",
"parameters": {
"type": "params",
"required": ["actors"],
"properties": {
"actors": {
"type": "array",
"items": {
"type": "string",
"format": "at-identifier"
},
"maxLength": 25
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["profiles"],
"properties": {
"profiles": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewDetailed"
}
}
}
}
}
}
}
}
@@ -0,0 +1,51 @@
{
"lexicon": 1,
"id": "app.bsky.actor.getSuggestions",
"defs": {
"main": {
"type": "query",
"description": "Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["actors"],
"properties": {
"cursor": {
"type": "string"
},
"actors": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
},
"recId": {
"type": "integer",
"description": "DEPRECATED: use recIdStr instead."
},
"recIdStr": {
"type": "string",
"description": "Snowflake for this recommendation, use when submitting recommendation events."
}
}
}
}
}
}
}
+66
View File
@@ -0,0 +1,66 @@
{
"lexicon": 1,
"id": "app.bsky.actor.profile",
"defs": {
"main": {
"type": "record",
"description": "A declaration of a Bluesky account profile.",
"key": "literal:self",
"record": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"maxGraphemes": 64,
"maxLength": 640
},
"description": {
"type": "string",
"description": "Free-form profile description text.",
"maxGraphemes": 256,
"maxLength": 2560
},
"pronouns": {
"type": "string",
"description": "Free-form pronouns text.",
"maxGraphemes": 20,
"maxLength": 200
},
"website": {
"type": "string",
"format": "uri"
},
"avatar": {
"type": "blob",
"description": "Small image to be displayed next to posts from account. AKA, 'profile picture'",
"accept": ["image/png", "image/jpeg"],
"maxSize": 1000000
},
"banner": {
"type": "blob",
"description": "Larger horizontal image to display behind profile view.",
"accept": ["image/png", "image/jpeg"],
"maxSize": 1000000
},
"labels": {
"type": "union",
"description": "Self-label values, specific to the Bluesky application, on the overall account.",
"refs": ["com.atproto.label.defs#selfLabels"]
},
"joinedViaStarterPack": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"pinnedPost": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"createdAt": {
"type": "string",
"format": "datetime"
}
}
}
}
}
}
@@ -0,0 +1,23 @@
{
"lexicon": 1,
"id": "app.bsky.actor.putPreferences",
"defs": {
"main": {
"type": "procedure",
"description": "Set the private preferences attached to the account.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["preferences"],
"properties": {
"preferences": {
"type": "ref",
"ref": "app.bsky.actor.defs#preferences"
}
}
}
}
}
}
}
+51
View File
@@ -0,0 +1,51 @@
{
"lexicon": 1,
"id": "app.bsky.actor.searchActors",
"defs": {
"main": {
"type": "query",
"description": "Find actors (profiles) matching search criteria. Does not require auth.",
"parameters": {
"type": "params",
"properties": {
"term": {
"type": "string",
"description": "DEPRECATED: use 'q' instead."
},
"q": {
"type": "string",
"description": "Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["actors"],
"properties": {
"cursor": {
"type": "string"
},
"actors": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
}
}
}
@@ -0,0 +1,45 @@
{
"lexicon": 1,
"id": "app.bsky.actor.searchActorsTypeahead",
"defs": {
"main": {
"type": "query",
"description": "Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.",
"parameters": {
"type": "params",
"properties": {
"term": {
"type": "string",
"description": "DEPRECATED: use 'q' instead."
},
"q": {
"type": "string",
"description": "Search query prefix; not a full query string."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 10
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["actors"],
"properties": {
"actors": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic"
}
}
}
}
}
}
}
}
+40
View File
@@ -0,0 +1,40 @@
{
"lexicon": 1,
"id": "app.bsky.actor.status",
"defs": {
"main": {
"type": "record",
"description": "A declaration of a Bluesky account status.",
"key": "literal:self",
"record": {
"type": "object",
"required": ["status", "createdAt"],
"properties": {
"status": {
"type": "string",
"description": "The status for the account.",
"knownValues": ["app.bsky.actor.status#live"]
},
"embed": {
"type": "union",
"description": "An optional embed associated with the status.",
"refs": ["app.bsky.embed.external"]
},
"durationMinutes": {
"type": "integer",
"description": "The duration of the status in minutes. Applications can choose to impose minimum and maximum limits.",
"minimum": 1
},
"createdAt": {
"type": "string",
"format": "datetime"
}
}
}
},
"live": {
"type": "token",
"description": "Advertises an account as currently offering live content."
}
}
}
+56
View File
@@ -0,0 +1,56 @@
{
"lexicon": 1,
"id": "app.bsky.ageassurance.begin",
"defs": {
"main": {
"type": "procedure",
"description": "Initiate Age Assurance for an account.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["email", "language", "countryCode"],
"properties": {
"email": {
"type": "string",
"description": "The user's email address to receive Age Assurance instructions."
},
"language": {
"type": "string",
"description": "The user's preferred language for communication during the Age Assurance process."
},
"countryCode": {
"type": "string",
"description": "An ISO 3166-1 alpha-2 code of the user's location."
},
"regionCode": {
"type": "string",
"description": "An optional ISO 3166-2 code of the user's region or state within the country."
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#state"
}
},
"errors": [
{
"name": "InvalidEmail"
},
{
"name": "DidTooLong"
},
{
"name": "InvalidInitiation"
},
{
"name": "RegionNotSupported"
}
]
}
}
}
+263
View File
@@ -0,0 +1,263 @@
{
"lexicon": 1,
"id": "app.bsky.ageassurance.defs",
"defs": {
"access": {
"description": "The access level granted based on Age Assurance data we've processed.",
"type": "string",
"knownValues": ["unknown", "none", "safe", "full"]
},
"status": {
"type": "string",
"description": "The status of the Age Assurance process.",
"knownValues": ["unknown", "pending", "assured", "blocked"]
},
"state": {
"type": "object",
"description": "The user's computed Age Assurance state.",
"required": ["status", "access"],
"properties": {
"lastInitiatedAt": {
"type": "string",
"format": "datetime",
"description": "The timestamp when this state was last updated."
},
"status": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#status"
},
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"stateMetadata": {
"type": "object",
"description": "Additional metadata needed to compute Age Assurance state client-side.",
"required": [],
"properties": {
"accountCreatedAt": {
"type": "string",
"format": "datetime",
"description": "The account creation timestamp."
}
}
},
"config": {
"type": "object",
"description": "",
"required": ["regions"],
"properties": {
"regions": {
"type": "array",
"description": "The per-region Age Assurance configuration.",
"items": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#configRegion"
}
}
}
},
"configRegion": {
"type": "object",
"description": "The Age Assurance configuration for a specific region.",
"required": ["countryCode", "minAccessAge", "rules"],
"properties": {
"countryCode": {
"type": "string",
"description": "The ISO 3166-1 alpha-2 country code this configuration applies to."
},
"regionCode": {
"type": "string",
"description": "The ISO 3166-2 region code this configuration applies to. If omitted, the configuration applies to the entire country."
},
"minAccessAge": {
"type": "integer",
"description": "The minimum age (as a whole integer) required to use Bluesky in this region."
},
"additionalVerificationMethods": {
"type": "array",
"description": "Verification methods permitted in this region in addition to the third-party (KWS) flow, which is always supported. `device` permits using the native on-device age APIs (e.g. Apple Declared Age Range, Google Play Age Signals).",
"items": {
"type": "string",
"knownValues": ["device"]
}
},
"rules": {
"type": "array",
"description": "The ordered list of Age Assurance rules that apply to this region. Rules should be applied in order, and the first matching rule determines the access level granted. The rules array should always include a default rule as the last item.",
"items": {
"type": "union",
"refs": [
"#configRegionRuleDefault",
"#configRegionRuleIfDeclaredOverAge",
"#configRegionRuleIfDeclaredUnderAge",
"#configRegionRuleIfAssuredOverAge",
"#configRegionRuleIfAssuredUnderAge",
"#configRegionRuleIfAccountNewerThan",
"#configRegionRuleIfAccountOlderThan"
]
}
}
}
},
"configRegionRuleDefault": {
"type": "object",
"description": "Age Assurance rule that applies by default.",
"required": ["access"],
"properties": {
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"configRegionRuleIfDeclaredOverAge": {
"type": "object",
"description": "Age Assurance rule that applies if the user has declared themselves equal-to or over a certain age.",
"required": ["age", "access"],
"properties": {
"age": {
"type": "integer",
"description": "The age threshold as a whole integer."
},
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"configRegionRuleIfDeclaredUnderAge": {
"type": "object",
"description": "Age Assurance rule that applies if the user has declared themselves under a certain age.",
"required": ["age", "access"],
"properties": {
"age": {
"type": "integer",
"description": "The age threshold as a whole integer."
},
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"configRegionRuleIfAssuredOverAge": {
"type": "object",
"description": "Age Assurance rule that applies if the user has been assured to be equal-to or over a certain age.",
"required": ["age", "access"],
"properties": {
"age": {
"type": "integer",
"description": "The age threshold as a whole integer."
},
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"configRegionRuleIfAssuredUnderAge": {
"type": "object",
"description": "Age Assurance rule that applies if the user has been assured to be under a certain age.",
"required": ["age", "access"],
"properties": {
"age": {
"type": "integer",
"description": "The age threshold as a whole integer."
},
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"configRegionRuleIfAccountNewerThan": {
"type": "object",
"description": "Age Assurance rule that applies if the account is equal-to or newer than a certain date.",
"required": ["date", "access"],
"properties": {
"date": {
"type": "string",
"format": "datetime",
"description": "The date threshold as a datetime string."
},
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"configRegionRuleIfAccountOlderThan": {
"type": "object",
"description": "Age Assurance rule that applies if the account is older than a certain date.",
"required": ["date", "access"],
"properties": {
"date": {
"type": "string",
"format": "datetime",
"description": "The date threshold as a datetime string."
},
"access": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#access"
}
}
},
"event": {
"type": "object",
"description": "Object used to store Age Assurance data in stash.",
"required": ["createdAt", "status", "access", "attemptId", "countryCode"],
"properties": {
"createdAt": {
"type": "string",
"format": "datetime",
"description": "The date and time of this write operation."
},
"attemptId": {
"type": "string",
"description": "The unique identifier for this instance of the Age Assurance flow, in UUID format."
},
"status": {
"type": "string",
"description": "The status of the Age Assurance process.",
"knownValues": ["unknown", "pending", "assured", "blocked"]
},
"access": {
"description": "The access level granted based on Age Assurance data we've processed.",
"type": "string",
"knownValues": ["unknown", "none", "safe", "full"]
},
"countryCode": {
"type": "string",
"description": "The ISO 3166-1 alpha-2 country code provided when beginning the Age Assurance flow."
},
"regionCode": {
"type": "string",
"description": "The ISO 3166-2 region code provided when beginning the Age Assurance flow."
},
"email": {
"type": "string",
"description": "The email used for Age Assurance."
},
"initIp": {
"type": "string",
"description": "The IP address used when initiating the Age Assurance flow."
},
"initUa": {
"type": "string",
"description": "The user agent used when initiating the Age Assurance flow."
},
"completeIp": {
"type": "string",
"description": "The IP address used when completing the Age Assurance flow."
},
"completeUa": {
"type": "string",
"description": "The user agent used when completing the Age Assurance flow."
}
}
}
}
}
@@ -0,0 +1,17 @@
{
"lexicon": 1,
"id": "app.bsky.ageassurance.getConfig",
"defs": {
"main": {
"type": "query",
"description": "Returns Age Assurance configuration for use on the client.",
"output": {
"encoding": "application/json",
"schema": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#config"
}
}
}
}
}
@@ -0,0 +1,39 @@
{
"lexicon": 1,
"id": "app.bsky.ageassurance.getState",
"defs": {
"main": {
"type": "query",
"description": "Returns server-computed Age Assurance state, if available, and any additional metadata needed to compute Age Assurance state client-side.",
"parameters": {
"type": "params",
"required": ["countryCode"],
"properties": {
"countryCode": {
"type": "string"
},
"regionCode": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["state", "metadata"],
"properties": {
"state": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#state"
},
"metadata": {
"type": "ref",
"ref": "app.bsky.ageassurance.defs#stateMetadata"
}
}
}
}
}
}
}
+35
View File
@@ -0,0 +1,35 @@
{
"lexicon": 1,
"id": "app.bsky.authCreatePosts",
"defs": {
"main": {
"type": "permission-set",
"title": "Create Bluesky Posts",
"title:lang": {},
"detail": "Can not update or delete posts.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "rpc",
"inheritAud": true,
"lxm": [
"app.bsky.video.uploadVideo",
"app.bsky.video.getJobStatus",
"app.bsky.video.getUploadLimits"
]
},
{
"type": "permission",
"resource": "repo",
"action": ["create"],
"collection": [
"app.bsky.feed.post",
"app.bsky.feed.postgate",
"app.bsky.feed.threadgate"
]
}
]
}
}
}
+27
View File
@@ -0,0 +1,27 @@
{
"lexicon": 1,
"id": "app.bsky.authDeleteContent",
"defs": {
"main": {
"type": "permission-set",
"title": "Delete Bluesky Content",
"title:lang": {},
"detail": "Clean up public account history: posts, reposts, and likes.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "repo",
"action": ["delete"],
"collection": [
"app.bsky.feed.like",
"app.bsky.feed.post",
"app.bsky.feed.postgate",
"app.bsky.feed.repost",
"app.bsky.feed.threadgate"
]
}
]
}
}
}
+137
View File
@@ -0,0 +1,137 @@
{
"lexicon": 1,
"id": "app.bsky.authFullApp",
"defs": {
"main": {
"type": "permission-set",
"title": "Full Bluesky Social App Permissions",
"title:lang": {},
"detail": "Manage all public content and interactions, private preferences and subscriptions, and other Bluesky-specific app features and data.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "rpc",
"inheritAud": true,
"lxm": [
"app.bsky.actor.getPreferences",
"app.bsky.actor.getProfile",
"app.bsky.actor.getProfiles",
"app.bsky.actor.getSuggestions",
"app.bsky.actor.putPreferences",
"app.bsky.actor.searchActors",
"app.bsky.actor.searchActorsTypeahead",
"app.bsky.bookmark.createBookmark",
"app.bsky.bookmark.deleteBookmark",
"app.bsky.bookmark.getBookmarks",
"app.bsky.contact.dismissMatch",
"app.bsky.contact.getMatches",
"app.bsky.contact.getSyncStatus",
"app.bsky.contact.importContacts",
"app.bsky.contact.removeData",
"app.bsky.contact.startPhoneVerification",
"app.bsky.contact.verifyPhone",
"app.bsky.feed.describeFeedGenerator",
"app.bsky.feed.getActorFeeds",
"app.bsky.feed.getActorLikes",
"app.bsky.feed.getAuthorFeed",
"app.bsky.feed.getFeed",
"app.bsky.feed.getFeedGenerator",
"app.bsky.feed.getFeedGenerators",
"app.bsky.feed.getFeedSkeleton",
"app.bsky.feed.getLikes",
"app.bsky.feed.getListFeed",
"app.bsky.feed.getPostThread",
"app.bsky.feed.getPosts",
"app.bsky.feed.getQuotes",
"app.bsky.feed.getRepostedBy",
"app.bsky.feed.getSuggestedFeeds",
"app.bsky.feed.getTimeline",
"app.bsky.feed.searchPosts",
"app.bsky.feed.searchPostsV2",
"app.bsky.feed.sendInteractions",
"app.bsky.graph.getActorStarterPacks",
"app.bsky.graph.getBlocks",
"app.bsky.graph.getFollowers",
"app.bsky.graph.getFollows",
"app.bsky.graph.getKnownFollowers",
"app.bsky.graph.getList",
"app.bsky.graph.getListBlocks",
"app.bsky.graph.getListMutes",
"app.bsky.graph.getLists",
"app.bsky.graph.getListsWithMembership",
"app.bsky.graph.getMutes",
"app.bsky.graph.getRelationships",
"app.bsky.graph.getStarterPack",
"app.bsky.graph.getStarterPacks",
"app.bsky.graph.getStarterPacksWithMembership",
"app.bsky.graph.getSuggestedFollowsByActor",
"app.bsky.graph.muteActor",
"app.bsky.graph.muteActorList",
"app.bsky.graph.muteThread",
"app.bsky.graph.searchStarterPacks",
"app.bsky.graph.unmuteActor",
"app.bsky.graph.unmuteActorList",
"app.bsky.graph.unmuteThread",
"app.bsky.labeler.getServices",
"app.bsky.notification.getPreferences",
"app.bsky.notification.getUnreadCount",
"app.bsky.notification.listActivitySubscriptions",
"app.bsky.notification.listNotifications",
"app.bsky.notification.putActivitySubscription",
"app.bsky.notification.putPreferences",
"app.bsky.notification.putPreferencesV2",
"app.bsky.notification.registerPush",
"app.bsky.notification.unregisterPush",
"app.bsky.notification.updateSeen",
"app.bsky.unspecced.getAgeAssuranceState",
"app.bsky.unspecced.getConfig",
"app.bsky.unspecced.getOnboardingSuggestedStarterPacks",
"app.bsky.unspecced.getPopularFeedGenerators",
"app.bsky.unspecced.getPostThreadOtherV2",
"app.bsky.unspecced.getPostThreadV2",
"app.bsky.unspecced.getSuggestedFeeds",
"app.bsky.unspecced.getSuggestedFeedsSkeleton",
"app.bsky.unspecced.getSuggestedStarterPacks",
"app.bsky.unspecced.getSuggestedStarterPacksSkeleton",
"app.bsky.unspecced.getSuggestedUsers",
"app.bsky.unspecced.getSuggestedUsersSkeleton",
"app.bsky.unspecced.getSuggestionsSkeleton",
"app.bsky.unspecced.getTaggedSuggestions",
"app.bsky.unspecced.getTrendingTopics",
"app.bsky.unspecced.getTrends",
"app.bsky.unspecced.getTrendsSkeleton",
"app.bsky.unspecced.initAgeAssurance",
"app.bsky.unspecced.searchActorsSkeleton",
"app.bsky.unspecced.searchPostsSkeleton",
"app.bsky.unspecced.searchStarterPacksSkeleton",
"app.bsky.video.getJobStatus",
"app.bsky.video.getUploadLimits",
"app.bsky.video.uploadVideo"
]
},
{
"type": "permission",
"resource": "repo",
"action": ["create", "update", "delete"],
"collection": [
"app.bsky.actor.profile",
"app.bsky.actor.status",
"app.bsky.feed.like",
"app.bsky.feed.post",
"app.bsky.feed.postgate",
"app.bsky.feed.repost",
"app.bsky.feed.threadgate",
"app.bsky.graph.block",
"app.bsky.graph.follow",
"app.bsky.graph.list",
"app.bsky.graph.listblock",
"app.bsky.graph.listitem",
"app.bsky.graph.starterpack",
"app.bsky.notification.declaration"
]
}
]
}
}
}
@@ -0,0 +1,21 @@
{
"lexicon": 1,
"id": "app.bsky.authManageFeedDeclarations",
"defs": {
"main": {
"type": "permission-set",
"title": "Manage Hosted Feeds",
"title:lang": {},
"detail": "Configure feed generator declaration records.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "repo",
"action": ["create", "update", "delete"],
"collection": ["app.bsky.feed.generator"]
}
]
}
}
}
@@ -0,0 +1,21 @@
{
"lexicon": 1,
"id": "app.bsky.authManageLabelerService",
"defs": {
"main": {
"type": "permission-set",
"title": "Manage Hosted Labeling Service",
"title:lang": {},
"detail": "Configure labeler declaration records.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "repo",
"action": ["create", "update", "delete"],
"collection": ["app.bsky.labeler.service"]
}
]
}
}
}
@@ -0,0 +1,36 @@
{
"lexicon": 1,
"id": "app.bsky.authManageModeration",
"defs": {
"main": {
"type": "permission-set",
"title": "Manage Personal Moderation",
"title:lang": {},
"detail": "Control over blocks, mutes, mod lists, mod services, and preferences.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "rpc",
"inheritAud": true,
"lxm": [
"app.bsky.actor.getPreferences",
"app.bsky.actor.putPreferences",
"app.bsky.graph.muteActor",
"app.bsky.graph.muteActorList",
"app.bsky.graph.muteThread",
"app.bsky.graph.unmuteActor",
"app.bsky.graph.unmuteActorList",
"app.bsky.graph.unmuteThread"
]
},
{
"type": "permission",
"resource": "repo",
"action": ["create", "update", "delete"],
"collection": ["app.bsky.graph.block", "app.bsky.graph.listblock"]
}
]
}
}
}
@@ -0,0 +1,32 @@
{
"lexicon": 1,
"id": "app.bsky.authManageNotifications",
"defs": {
"main": {
"type": "permission-set",
"title": "Manage Bluesky Notifications",
"title:lang": {},
"detail": "View and configure notifications for the Bluesky app.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "rpc",
"inheritAud": true,
"lxm": [
"app.bsky.notification.getPreferences",
"app.bsky.notification.getUnreadCount",
"app.bsky.notification.listActivitySubscriptions",
"app.bsky.notification.listNotifications",
"app.bsky.notification.putActivitySubscription",
"app.bsky.notification.putPreferences",
"app.bsky.notification.putPreferencesV2",
"app.bsky.notification.registerPush",
"app.bsky.notification.unregisterPush",
"app.bsky.notification.updateSeen"
]
}
]
}
}
}
+25
View File
@@ -0,0 +1,25 @@
{
"lexicon": 1,
"id": "app.bsky.authManageProfile",
"defs": {
"main": {
"type": "permission-set",
"title": "Manage Bluesky Profile",
"title:lang": {},
"detail": "Update profile data, as well as status and public chat visibility.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "repo",
"action": ["create", "update", "delete"],
"collection": [
"app.bsky.actor.profile",
"app.bsky.actor.status",
"app.bsky.notification.declaration"
]
}
]
}
}
}
+90
View File
@@ -0,0 +1,90 @@
{
"lexicon": 1,
"id": "app.bsky.authViewAll",
"defs": {
"main": {
"type": "permission-set",
"title": "Read-only access to all content",
"title:lang": {},
"detail": "View Bluesky network content from account perspective, and read all notifications and preferences.",
"detail:lang": {},
"permissions": [
{
"type": "permission",
"resource": "rpc",
"inheritAud": true,
"lxm": [
"app.bsky.actor.getPreferences",
"app.bsky.actor.getProfile",
"app.bsky.actor.getProfiles",
"app.bsky.actor.getSuggestions",
"app.bsky.actor.searchActors",
"app.bsky.actor.searchActorsTypeahead",
"app.bsky.bookmark.getBookmarks",
"app.bsky.feed.describeFeedGenerator",
"app.bsky.feed.getActorFeeds",
"app.bsky.feed.getActorLikes",
"app.bsky.feed.getAuthorFeed",
"app.bsky.feed.getFeed",
"app.bsky.feed.getFeedGenerator",
"app.bsky.feed.getFeedGenerators",
"app.bsky.feed.getFeedSkeleton",
"app.bsky.feed.getLikes",
"app.bsky.feed.getListFeed",
"app.bsky.feed.getPostThread",
"app.bsky.feed.getPosts",
"app.bsky.feed.getQuotes",
"app.bsky.feed.getRepostedBy",
"app.bsky.feed.getSuggestedFeeds",
"app.bsky.feed.getTimeline",
"app.bsky.feed.searchPosts",
"app.bsky.feed.searchPostsV2",
"app.bsky.graph.getActorStarterPacks",
"app.bsky.graph.getBlocks",
"app.bsky.graph.getFollowers",
"app.bsky.graph.getFollows",
"app.bsky.graph.getKnownFollowers",
"app.bsky.graph.getListBlocks",
"app.bsky.graph.getListMutes",
"app.bsky.graph.getLists",
"app.bsky.graph.getListsWithMembership",
"app.bsky.graph.getMutes",
"app.bsky.graph.getRelationships",
"app.bsky.graph.getStarterPack",
"app.bsky.graph.getStarterPacks",
"app.bsky.graph.getStarterPacksWithMembership",
"app.bsky.graph.getSuggestedFollowsByActor",
"app.bsky.graph.searchStarterPacks",
"app.bsky.labeler.getServices",
"app.bsky.notification.getPreferences",
"app.bsky.notification.getUnreadCount",
"app.bsky.notification.listActivitySubscriptions",
"app.bsky.notification.listNotifications",
"app.bsky.notification.updateSeen",
"app.bsky.unspecced.getAgeAssuranceState",
"app.bsky.unspecced.getConfig",
"app.bsky.unspecced.getOnboardingSuggestedStarterPacks",
"app.bsky.unspecced.getPopularFeedGenerators",
"app.bsky.unspecced.getPostThreadOtherV2",
"app.bsky.unspecced.getPostThreadV2",
"app.bsky.unspecced.getSuggestedFeeds",
"app.bsky.unspecced.getSuggestedFeedsSkeleton",
"app.bsky.unspecced.getSuggestedStarterPacks",
"app.bsky.unspecced.getSuggestedStarterPacksSkeleton",
"app.bsky.unspecced.getSuggestedUsers",
"app.bsky.unspecced.getSuggestedUsersSkeleton",
"app.bsky.unspecced.getSuggestionsSkeleton",
"app.bsky.unspecced.getTaggedSuggestions",
"app.bsky.unspecced.getTrendingTopics",
"app.bsky.unspecced.getTrends",
"app.bsky.unspecced.getTrendsSkeleton",
"app.bsky.unspecced.searchActorsSkeleton",
"app.bsky.unspecced.searchPostsSkeleton",
"app.bsky.unspecced.searchStarterPacksSkeleton",
"app.bsky.video.getUploadLimits"
]
}
]
}
}
}
@@ -0,0 +1,33 @@
{
"lexicon": 1,
"id": "app.bsky.bookmark.createBookmark",
"defs": {
"main": {
"type": "procedure",
"description": "Creates a private bookmark for the specified record. Currently, only `app.bsky.feed.post` records are supported. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["uri", "cid"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
}
}
}
},
"errors": [
{
"name": "UnsupportedCollection",
"description": "The URI to be bookmarked is for an unsupported collection."
}
]
}
}
}
+41
View File
@@ -0,0 +1,41 @@
{
"lexicon": 1,
"id": "app.bsky.bookmark.defs",
"defs": {
"bookmark": {
"description": "Object used to store bookmark data in stash.",
"type": "object",
"required": ["subject"],
"properties": {
"subject": {
"description": "A strong ref to the record to be bookmarked. Currently, only `app.bsky.feed.post` records are supported.",
"type": "ref",
"ref": "com.atproto.repo.strongRef"
}
}
},
"bookmarkView": {
"type": "object",
"required": ["subject", "item"],
"properties": {
"subject": {
"description": "A strong ref to the bookmarked record.",
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"item": {
"type": "union",
"refs": [
"app.bsky.feed.defs#blockedPost",
"app.bsky.feed.defs#notFoundPost",
"app.bsky.feed.defs#postView"
]
}
}
}
}
}
@@ -0,0 +1,29 @@
{
"lexicon": 1,
"id": "app.bsky.bookmark.deleteBookmark",
"defs": {
"main": {
"type": "procedure",
"description": "Deletes a private bookmark for the specified record. Currently, only `app.bsky.feed.post` records are supported. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
}
}
}
},
"errors": [
{
"name": "UnsupportedCollection",
"description": "The URI to be bookmarked is for an unsupported collection."
}
]
}
}
}
@@ -0,0 +1,43 @@
{
"lexicon": 1,
"id": "app.bsky.bookmark.getBookmarks",
"defs": {
"main": {
"type": "query",
"description": "Gets views of records bookmarked by the authenticated user. Requires authentication.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["bookmarks"],
"properties": {
"cursor": {
"type": "string"
},
"bookmarks": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.bookmark.defs#bookmarkView"
}
}
}
}
}
}
}
}
+57
View File
@@ -0,0 +1,57 @@
{
"lexicon": 1,
"id": "app.bsky.contact.defs",
"defs": {
"matchAndContactIndex": {
"description": "Associates a profile with the positional index of the contact import input in the call to `app.bsky.contact.importContacts`, so clients can know which phone caused a particular match.",
"type": "object",
"required": ["match", "contactIndex"],
"properties": {
"match": {
"description": "Profile of the matched user.",
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
},
"contactIndex": {
"description": "The index of this match in the import contact input.",
"type": "integer",
"minimum": 0,
"maximum": 999
}
}
},
"syncStatus": {
"type": "object",
"required": ["syncedAt", "matchesCount"],
"properties": {
"syncedAt": {
"description": "Last date when contacts where imported.",
"type": "string",
"format": "datetime"
},
"matchesCount": {
"description": "Number of existing contact matches resulting of the user imports and of their imported contacts having imported the user. Matches stop being counted when the user either follows the matched contact or dismisses the match.",
"type": "integer",
"minimum": 0
}
}
},
"notification": {
"description": "A stash object to be sent via bsync representing a notification to be created.",
"type": "object",
"required": ["from", "to"],
"properties": {
"from": {
"description": "The DID of who this notification comes from.",
"type": "string",
"format": "did"
},
"to": {
"description": "The DID of who this notification should go to.",
"type": "string",
"format": "did"
}
}
}
}
}
@@ -0,0 +1,39 @@
{
"lexicon": 1,
"id": "app.bsky.contact.dismissMatch",
"defs": {
"main": {
"type": "procedure",
"description": "Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["subject"],
"properties": {
"subject": {
"description": "The subject's DID to dismiss the match with.",
"type": "string",
"format": "did"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {}
}
},
"errors": [
{
"name": "InvalidDid"
},
{
"name": "InternalError"
}
]
}
}
}
+57
View File
@@ -0,0 +1,57 @@
{
"lexicon": 1,
"id": "app.bsky.contact.getMatches",
"defs": {
"main": {
"type": "query",
"description": "Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["matches"],
"properties": {
"cursor": {
"type": "string"
},
"matches": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
},
"errors": [
{
"name": "InvalidDid"
},
{
"name": "InvalidLimit"
},
{
"name": "InvalidCursor"
},
{
"name": "InternalError"
}
]
}
}
}
@@ -0,0 +1,35 @@
{
"lexicon": 1,
"id": "app.bsky.contact.getSyncStatus",
"defs": {
"main": {
"type": "query",
"description": "Gets the user's current contact import status. Requires authentication.",
"parameters": {
"type": "params",
"properties": {}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {
"syncStatus": {
"description": "If present, indicates the user has imported their contacts. If not present, indicates the user never used the feature or called `app.bsky.contact.removeData` and didn't import again since.",
"type": "ref",
"ref": "app.bsky.contact.defs#syncStatus"
}
}
}
},
"errors": [
{
"name": "InvalidDid"
},
{
"name": "InternalError"
}
]
}
}
}
@@ -0,0 +1,66 @@
{
"lexicon": 1,
"id": "app.bsky.contact.importContacts",
"defs": {
"main": {
"type": "procedure",
"description": "Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["token", "contacts"],
"properties": {
"token": {
"description": "JWT to authenticate the call. Use the JWT received as a response to the call to `app.bsky.contact.verifyPhone`.",
"type": "string"
},
"contacts": {
"description": "List of phone numbers in global E.164 format (e.g., '+12125550123'). Phone numbers that cannot be normalized into a valid phone number will be discarded. Should not repeat the 'phone' input used in `app.bsky.contact.verifyPhone`.",
"type": "array",
"items": {
"type": "string"
},
"minLength": 1,
"maxLength": 1000
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["matchesAndContactIndexes"],
"properties": {
"matchesAndContactIndexes": {
"description": "The users that matched during import and their indexes on the input contacts, so the client can correlate with its local list.",
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.contact.defs#matchAndContactIndex"
}
}
}
}
},
"errors": [
{
"name": "InvalidDid"
},
{
"name": "InvalidContacts"
},
{
"name": "TooManyContacts"
},
{
"name": "InvalidToken"
},
{
"name": "InternalError"
}
]
}
}
}
+32
View File
@@ -0,0 +1,32 @@
{
"lexicon": 1,
"id": "app.bsky.contact.removeData",
"defs": {
"main": {
"type": "procedure",
"description": "Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {}
}
},
"errors": [
{
"name": "InvalidDid"
},
{
"name": "InternalError"
}
]
}
}
}
@@ -0,0 +1,36 @@
{
"lexicon": 1,
"id": "app.bsky.contact.sendNotification",
"defs": {
"main": {
"type": "procedure",
"description": "System endpoint to send notifications related to contact imports. Requires role authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["from", "to"],
"properties": {
"from": {
"description": "The DID of who this notification comes from.",
"type": "string",
"format": "did"
},
"to": {
"description": "The DID of who this notification should go to.",
"type": "string",
"format": "did"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {}
}
}
}
}
}
@@ -0,0 +1,44 @@
{
"lexicon": 1,
"id": "app.bsky.contact.startPhoneVerification",
"defs": {
"main": {
"type": "procedure",
"description": "Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to `app.bsky.contact.verifyPhone`. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["phone"],
"properties": {
"phone": {
"description": "The phone number to receive the code via SMS.",
"type": "string"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {}
}
},
"errors": [
{
"name": "RateLimitExceeded"
},
{
"name": "InvalidDid"
},
{
"name": "InvalidPhone"
},
{
"name": "InternalError"
}
]
}
}
}
@@ -0,0 +1,57 @@
{
"lexicon": 1,
"id": "app.bsky.contact.verifyPhone",
"defs": {
"main": {
"type": "procedure",
"description": "Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["phone", "code"],
"properties": {
"phone": {
"description": "The phone number to verify. Should be the same as the one passed to `app.bsky.contact.startPhoneVerification`.",
"type": "string"
},
"code": {
"description": "The code received via SMS as a result of the call to `app.bsky.contact.startPhoneVerification`.",
"type": "string"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["token"],
"properties": {
"token": {
"description": "JWT to be used in a call to `app.bsky.contact.importContacts`. It is only valid for a single call.",
"type": "string"
}
}
}
},
"errors": [
{
"name": "RateLimitExceeded"
},
{
"name": "InvalidDid"
},
{
"name": "InvalidPhone"
},
{
"name": "InvalidCode"
},
{
"name": "InternalError"
}
]
}
}
}
+42
View File
@@ -0,0 +1,42 @@
{
"lexicon": 1,
"id": "app.bsky.draft.createDraft",
"defs": {
"main": {
"type": "procedure",
"description": "Inserts a draft using private storage (stash). An upper limit of drafts might be enforced. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["draft"],
"properties": {
"draft": {
"type": "ref",
"ref": "app.bsky.draft.defs#draft"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"description": "The ID of the created draft."
}
}
}
},
"errors": [
{
"name": "DraftLimitReached",
"description": "Trying to insert a new draft when the limit was already reached."
}
]
}
}
}
+262
View File
@@ -0,0 +1,262 @@
{
"lexicon": 1,
"id": "app.bsky.draft.defs",
"defs": {
"draftWithId": {
"description": "A draft with an identifier, used to store drafts in private storage (stash).",
"type": "object",
"required": ["id", "draft"],
"properties": {
"id": {
"description": "A TID to be used as a draft identifier.",
"type": "string",
"format": "tid"
},
"draft": {
"type": "ref",
"ref": "#draft"
}
}
},
"draft": {
"description": "A draft containing an array of draft posts.",
"type": "object",
"required": ["posts"],
"properties": {
"deviceId": {
"type": "string",
"description": "UUIDv4 identifier of the device that created this draft.",
"maxLength": 100
},
"deviceName": {
"type": "string",
"description": "The device and/or platform on which the draft was created.",
"maxLength": 100
},
"posts": {
"description": "Array of draft posts that compose this draft.",
"type": "array",
"minLength": 1,
"maxLength": 100,
"items": {
"type": "ref",
"ref": "#draftPost"
}
},
"langs": {
"type": "array",
"description": "Indicates human language of posts primary text content.",
"maxLength": 3,
"items": {
"type": "string",
"format": "language"
}
},
"postgateEmbeddingRules": {
"description": "Embedding rules for the postgates to be created when this draft is published.",
"type": "array",
"maxLength": 5,
"items": {
"type": "union",
"refs": ["app.bsky.feed.postgate#disableRule"]
}
},
"threadgateAllow": {
"description": "Allow-rules for the threadgate to be created when this draft is published.",
"type": "array",
"maxLength": 5,
"items": {
"type": "union",
"refs": [
"app.bsky.feed.threadgate#mentionRule",
"app.bsky.feed.threadgate#followerRule",
"app.bsky.feed.threadgate#followingRule",
"app.bsky.feed.threadgate#listRule"
]
}
}
}
},
"draftPost": {
"description": "One of the posts that compose a draft.",
"type": "object",
"required": ["text"],
"properties": {
"text": {
"type": "string",
"maxLength": 10000,
"maxGraphemes": 1000,
"description": "The primary post content. It has a higher limit than post contents to allow storing a larger text that can later be refined into smaller posts."
},
"labels": {
"type": "union",
"description": "Self-label values for this post. Effectively content warnings.",
"refs": ["com.atproto.label.defs#selfLabels"]
},
"embedImages": {
"type": "array",
"items": {
"type": "ref",
"ref": "#draftEmbedImage"
},
"maxLength": 4
},
"embedGallery": {
"type": "ref",
"ref": "#draftEmbedGallery"
},
"embedVideos": {
"type": "array",
"items": {
"type": "ref",
"ref": "#draftEmbedVideo"
},
"maxLength": 1
},
"embedExternals": {
"type": "array",
"items": {
"type": "ref",
"ref": "#draftEmbedExternal"
},
"maxLength": 1
},
"embedRecords": {
"type": "array",
"items": {
"type": "ref",
"ref": "#draftEmbedRecord"
},
"maxLength": 1
}
}
},
"draftView": {
"description": "View to present drafts data to users.",
"type": "object",
"required": ["id", "draft", "createdAt", "updatedAt"],
"properties": {
"id": {
"description": "A TID to be used as a draft identifier.",
"type": "string",
"format": "tid"
},
"draft": {
"type": "ref",
"ref": "#draft"
},
"createdAt": {
"description": "The time the draft was created.",
"type": "string",
"format": "datetime"
},
"updatedAt": {
"description": "The time the draft was last updated.",
"type": "string",
"format": "datetime"
}
}
},
"draftEmbedLocalRef": {
"type": "object",
"required": ["path"],
"properties": {
"path": {
"type": "string",
"description": "Local, on-device ref to file to be embedded. Embeds are currently device-bound for drafts.",
"minLength": 1,
"maxLength": 1024
}
}
},
"draftEmbedCaption": {
"type": "object",
"required": ["lang", "content"],
"properties": {
"lang": {
"type": "string",
"format": "language"
},
"content": {
"type": "string",
"maxLength": 10000
}
}
},
"draftEmbedGallery": {
"type": "object",
"required": ["items"],
"properties": {
"items": {
"type": "ref",
"ref": "#draftEmbedGalleryItems"
}
}
},
"draftEmbedGalleryItems": {
"type": "array",
"items": {
"type": "union",
"refs": ["#draftEmbedImage"]
},
"maxLength": 20,
"description": "The schema-level maxLength of 20 is a future-proof ceiling. Clients should currently enforce a soft limit of 10 items in authoring UIs."
},
"draftEmbedImage": {
"type": "object",
"required": ["localRef"],
"properties": {
"localRef": {
"type": "ref",
"ref": "#draftEmbedLocalRef"
},
"alt": {
"type": "string",
"maxGraphemes": 2000
}
}
},
"draftEmbedVideo": {
"type": "object",
"required": ["localRef"],
"properties": {
"localRef": {
"type": "ref",
"ref": "#draftEmbedLocalRef"
},
"alt": {
"type": "string",
"maxGraphemes": 2000
},
"captions": {
"type": "array",
"items": {
"type": "ref",
"ref": "#draftEmbedCaption"
},
"maxLength": 20
}
}
},
"draftEmbedExternal": {
"type": "object",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"format": "uri"
}
}
},
"draftEmbedRecord": {
"type": "object",
"required": ["record"],
"properties": {
"record": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
}
}
}
}
}
+23
View File
@@ -0,0 +1,23 @@
{
"lexicon": 1,
"id": "app.bsky.draft.deleteDraft",
"defs": {
"main": {
"type": "procedure",
"description": "Deletes a draft by ID. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["id"],
"properties": {
"id": {
"type": "string",
"format": "tid"
}
}
}
}
}
}
}
+43
View File
@@ -0,0 +1,43 @@
{
"lexicon": 1,
"id": "app.bsky.draft.getDrafts",
"defs": {
"main": {
"type": "query",
"description": "Gets views of user drafts. Requires authentication.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["drafts"],
"properties": {
"cursor": {
"type": "string"
},
"drafts": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.draft.defs#draftView"
}
}
}
}
}
}
}
}
+23
View File
@@ -0,0 +1,23 @@
{
"lexicon": 1,
"id": "app.bsky.draft.updateDraft",
"defs": {
"main": {
"type": "procedure",
"description": "Updates a draft using private storage (stash). If the draft ID points to a non-existing ID, the update will be silently ignored. This is done because updates don't enforce draft limit, so it accepts all writes, but will ignore invalid ones. Requires authentication.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["draft"],
"properties": {
"draft": {
"type": "ref",
"ref": "app.bsky.draft.defs#draftWithId"
}
}
}
}
}
}
}
+21
View File
@@ -0,0 +1,21 @@
{
"lexicon": 1,
"id": "app.bsky.embed.defs",
"defs": {
"aspectRatio": {
"type": "object",
"description": "width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.",
"required": ["width", "height"],
"properties": {
"width": {
"type": "integer",
"minimum": 1
},
"height": {
"type": "integer",
"minimum": 1
}
}
}
}
}
+188
View File
@@ -0,0 +1,188 @@
{
"lexicon": 1,
"id": "app.bsky.embed.external",
"defs": {
"main": {
"type": "object",
"description": "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).",
"required": ["external"],
"properties": {
"external": {
"type": "ref",
"ref": "#external"
}
}
},
"external": {
"type": "object",
"required": ["uri", "title", "description"],
"properties": {
"uri": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"thumb": {
"type": "blob",
"accept": ["image/*"],
"maxSize": 1000000
},
"associatedRefs": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"description": "StrongRefs (uri+cid) of the Atmosphere records that backed this view."
}
}
},
"view": {
"type": "object",
"required": ["external"],
"properties": {
"external": {
"type": "ref",
"ref": "#viewExternal"
}
}
},
"viewExternal": {
"type": "object",
"required": ["uri", "title", "description"],
"properties": {
"uri": {
"type": "string",
"format": "uri"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"thumb": {
"type": "string",
"format": "uri"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "When the external content was created, if available. Example: a publication date, for an article."
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "When the external content was updated, if available."
},
"readingTime": {
"type": "integer",
"description": "Estimated reading time in minutes, if applicable and available."
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"source": {
"type": "ref",
"ref": "#viewExternalSource"
},
"associatedRefs": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"description": "StrongRefs (uri+cid) of the Atmosphere records that backed this view."
},
"associatedProfiles": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic"
},
"description": "Profiles of the owners of the Atmosphere records that backed this view."
}
}
},
"viewExternalSource": {
"type": "object",
"description": "The source of an external embed, such as a standard.site publication.",
"required": ["uri", "title"],
"properties": {
"uri": {
"type": "string",
"format": "uri",
"description": "URI of the source, if available. Example: the https:// URL of a site.standard.publication record."
},
"icon": {
"type": "string",
"format": "uri",
"description": "Fully-qualified URL where an icon representing the source can be fetched. For example, CDN location provided by the App View."
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"theme": {
"type": "ref",
"ref": "#viewExternalSourceTheme"
}
}
},
"viewExternalSourceTheme": {
"type": "object",
"description": "The theme colors of an external source, such as a site.standard.publication. These colors may be used when rendering an embed from that source.",
"properties": {
"backgroundRGB": {
"type": "ref",
"ref": "#colorRGB"
},
"foregroundRGB": {
"type": "ref",
"ref": "#colorRGB"
},
"accentRGB": {
"type": "ref",
"ref": "#colorRGB"
},
"accentForegroundRGB": {
"type": "ref",
"ref": "#colorRGB"
}
}
},
"colorRGB": {
"type": "object",
"description": "RGB color definition, inspired by site.standard.theme.color#rgb",
"required": ["r", "g", "b"],
"properties": {
"r": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"g": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"b": {
"type": "integer",
"minimum": 0,
"maximum": 255
}
}
}
}
}
+79
View File
@@ -0,0 +1,79 @@
{
"lexicon": 1,
"id": "app.bsky.embed.gallery",
"description": "An assortment of media embedded in a Bluesky record (eg, a post).",
"defs": {
"main": {
"type": "object",
"required": ["items"],
"properties": {
"items": {
"type": "array",
"maxLength": 20,
"description": "The schema-level maxLength of 20 is a future-proof ceiling. Clients should currently enforce a soft limit of 10 items in authoring UIs.",
"items": {
"type": "union",
"refs": ["#image"],
"description": "The media items in the gallery. Each item may be of a different type, but all types must be supported by the client."
}
}
}
},
"image": {
"type": "object",
"required": ["image", "alt", "aspectRatio"],
"properties": {
"image": {
"type": "blob",
"accept": ["image/*"],
"maxSize": 2000000
},
"alt": {
"type": "string",
"description": "Alt text description of the image, for accessibility."
},
"aspectRatio": {
"type": "ref",
"ref": "app.bsky.embed.defs#aspectRatio"
}
}
},
"view": {
"type": "object",
"required": ["items"],
"properties": {
"items": {
"type": "array",
"items": {
"type": "union",
"refs": ["#viewImage"]
}
}
}
},
"viewImage": {
"type": "object",
"required": ["thumbnail", "fullsize", "alt", "aspectRatio"],
"properties": {
"thumbnail": {
"type": "string",
"format": "uri",
"description": "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View."
},
"fullsize": {
"type": "string",
"format": "uri",
"description": "Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View."
},
"alt": {
"type": "string",
"description": "Alt text description of the image, for accessibility."
},
"aspectRatio": {
"type": "ref",
"ref": "app.bsky.embed.defs#aspectRatio"
}
}
}
}
}
@@ -0,0 +1,58 @@
{
"lexicon": 1,
"id": "app.bsky.embed.getEmbedExternalView",
"defs": {
"main": {
"type": "query",
"description": "Resolve one or more AT-URIs into the data needed to render an enhanced external embed. Returns `associatedRefs` (strongRefs to embed into a post's external.associatedRefs), the raw `associatedRecords`, and a hydrated `view`. The response is empty (`{}`) when no records were resolvable, or when validation determined the resolved records don't actually back the requested URL; clients should fall back to their own link-card rendering in that case and skip writing strongRefs to the post.",
"parameters": {
"type": "params",
"required": ["url", "uris"],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The canonical web URL the embed represents (typically the URL the user pasted into the composer). Used as the returned view's `uri`. May be used for validation in the future."
},
"uris": {
"type": "array",
"description": "AT-URIs of any Atmosphere records that can be resolved and used to construct #externalView views. Example: a site.standard.document and optionally its associated site.standard.publication.",
"items": {
"type": "string",
"format": "at-uri"
},
"maxLength": 4
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {
"view": {
"type": "ref",
"ref": "app.bsky.embed.external#view",
"description": "Hydrated view of the embed. Present only when the resolved records back the requested URL and supply enough information to populate the required `viewExternal` fields. Omitted alongside the rest of the response when no records resolved or validation failed."
},
"associatedRefs": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"description": "StrongRefs (URI+CID) of the Atmosphere records that backed this view, suitable for embedding into a post's external.associatedRefs."
},
"associatedRecords": {
"type": "array",
"items": {
"type": "unknown",
"description": "The raw record data of the Atmosphere records that backed this view. This is returned for convenience, to avoid the need for the client to separately fetch the record data for the associatedRefs. Example: the site.standard.document and site.standard.publication records that backed this view."
}
}
}
}
}
}
}
}
+79
View File
@@ -0,0 +1,79 @@
{
"lexicon": 1,
"id": "app.bsky.embed.images",
"description": "A set of images embedded in a Bluesky record (eg, a post).",
"defs": {
"main": {
"type": "object",
"required": ["images"],
"properties": {
"images": {
"type": "array",
"items": {
"type": "ref",
"ref": "#image"
},
"maxLength": 4
}
}
},
"image": {
"type": "object",
"required": ["image", "alt"],
"properties": {
"image": {
"type": "blob",
"description": "The raw image file. May be up to 2 MB, formerly limited to 1 MB.",
"accept": ["image/*"],
"maxSize": 2000000
},
"alt": {
"type": "string",
"description": "Alt text description of the image, for accessibility."
},
"aspectRatio": {
"type": "ref",
"ref": "app.bsky.embed.defs#aspectRatio"
}
}
},
"view": {
"type": "object",
"required": ["images"],
"properties": {
"images": {
"type": "array",
"items": {
"type": "ref",
"ref": "#viewImage"
},
"maxLength": 4
}
}
},
"viewImage": {
"type": "object",
"required": ["thumb", "fullsize", "alt"],
"properties": {
"thumb": {
"type": "string",
"format": "uri",
"description": "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View."
},
"fullsize": {
"type": "string",
"format": "uri",
"description": "Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View."
},
"alt": {
"type": "string",
"description": "Alt text description of the image, for accessibility."
},
"aspectRatio": {
"type": "ref",
"ref": "app.bsky.embed.defs#aspectRatio"
}
}
}
}
}
+141
View File
@@ -0,0 +1,141 @@
{
"lexicon": 1,
"id": "app.bsky.embed.record",
"description": "A representation of a record embedded in a Bluesky record (eg, a post). For example, a quote-post, or sharing a feed generator record.",
"defs": {
"main": {
"type": "object",
"required": ["record"],
"properties": {
"record": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
}
}
},
"view": {
"type": "object",
"required": ["record"],
"properties": {
"record": {
"type": "union",
"refs": [
"#viewRecord",
"#viewNotFound",
"#viewBlocked",
"#viewDetached",
"app.bsky.feed.defs#generatorView",
"app.bsky.graph.defs#listView",
"app.bsky.labeler.defs#labelerView",
"app.bsky.graph.defs#starterPackViewBasic"
]
}
}
},
"viewRecord": {
"type": "object",
"required": ["uri", "cid", "author", "value", "indexedAt"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"author": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic"
},
"value": {
"type": "unknown",
"description": "The record data itself."
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"replyCount": {
"type": "integer"
},
"repostCount": {
"type": "integer"
},
"likeCount": {
"type": "integer"
},
"quoteCount": {
"type": "integer"
},
"embeds": {
"type": "array",
"items": {
"type": "union",
"refs": [
"app.bsky.embed.images#view",
"app.bsky.embed.video#view",
"app.bsky.embed.gallery#view",
"app.bsky.embed.external#view",
"app.bsky.embed.record#view",
"app.bsky.embed.recordWithMedia#view"
]
}
},
"indexedAt": {
"type": "string",
"format": "datetime"
}
}
},
"viewNotFound": {
"type": "object",
"required": ["uri", "notFound"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"notFound": {
"type": "boolean",
"const": true
}
}
},
"viewBlocked": {
"type": "object",
"required": ["uri", "blocked", "author"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"blocked": {
"type": "boolean",
"const": true
},
"author": {
"type": "ref",
"ref": "app.bsky.feed.defs#blockedAuthor"
}
}
},
"viewDetached": {
"type": "object",
"required": ["uri", "detached"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"detached": {
"type": "boolean",
"const": true
}
}
}
}
}
@@ -0,0 +1,45 @@
{
"lexicon": 1,
"id": "app.bsky.embed.recordWithMedia",
"description": "A representation of a record embedded in a Bluesky record (eg, a post), alongside other compatible embeds. For example, a quote post and image, or a quote post and external URL card.",
"defs": {
"main": {
"type": "object",
"required": ["record", "media"],
"properties": {
"record": {
"type": "ref",
"ref": "app.bsky.embed.record"
},
"media": {
"type": "union",
"refs": [
"app.bsky.embed.images",
"app.bsky.embed.video",
"app.bsky.embed.gallery",
"app.bsky.embed.external"
]
}
}
},
"view": {
"type": "object",
"required": ["record", "media"],
"properties": {
"record": {
"type": "ref",
"ref": "app.bsky.embed.record#view"
},
"media": {
"type": "union",
"refs": [
"app.bsky.embed.images#view",
"app.bsky.embed.video#view",
"app.bsky.embed.gallery#view",
"app.bsky.embed.external#view"
]
}
}
}
}
}
+89
View File
@@ -0,0 +1,89 @@
{
"lexicon": 1,
"id": "app.bsky.embed.video",
"description": "A video embedded in a Bluesky record (eg, a post).",
"defs": {
"main": {
"type": "object",
"required": ["video"],
"properties": {
"video": {
"type": "blob",
"description": "The mp4 video file. May be up to 100mb, formerly limited to 50mb.",
"accept": ["video/mp4"],
"maxSize": 100000000
},
"captions": {
"type": "array",
"items": {
"type": "ref",
"ref": "#caption"
},
"maxLength": 20
},
"alt": {
"type": "string",
"description": "Alt text description of the video, for accessibility.",
"maxGraphemes": 1000,
"maxLength": 10000
},
"aspectRatio": {
"type": "ref",
"ref": "app.bsky.embed.defs#aspectRatio"
},
"presentation": {
"type": "string",
"description": "A hint to the client about how to present the video.",
"knownValues": ["default", "gif"]
}
}
},
"caption": {
"type": "object",
"required": ["lang", "file"],
"properties": {
"lang": {
"type": "string",
"format": "language"
},
"file": {
"type": "blob",
"accept": ["text/vtt"],
"maxSize": 20000
}
}
},
"view": {
"type": "object",
"required": ["cid", "playlist"],
"properties": {
"cid": {
"type": "string",
"format": "cid"
},
"playlist": {
"type": "string",
"format": "uri"
},
"thumbnail": {
"type": "string",
"format": "uri"
},
"alt": {
"type": "string",
"maxGraphemes": 1000,
"maxLength": 10000
},
"aspectRatio": {
"type": "ref",
"ref": "app.bsky.embed.defs#aspectRatio"
},
"presentation": {
"type": "string",
"description": "A hint to the client about how to present the video.",
"knownValues": ["default", "gif"]
}
}
}
}
}
+486
View File
@@ -0,0 +1,486 @@
{
"lexicon": 1,
"id": "app.bsky.feed.defs",
"defs": {
"postView": {
"type": "object",
"required": ["uri", "cid", "author", "record", "indexedAt"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"author": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic"
},
"record": {
"type": "unknown"
},
"embed": {
"type": "union",
"refs": [
"app.bsky.embed.images#view",
"app.bsky.embed.video#view",
"app.bsky.embed.gallery#view",
"app.bsky.embed.external#view",
"app.bsky.embed.record#view",
"app.bsky.embed.recordWithMedia#view"
]
},
"bookmarkCount": {
"type": "integer"
},
"replyCount": {
"type": "integer"
},
"repostCount": {
"type": "integer"
},
"likeCount": {
"type": "integer"
},
"quoteCount": {
"type": "integer"
},
"indexedAt": {
"type": "string",
"format": "datetime"
},
"viewer": {
"type": "ref",
"ref": "#viewerState"
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"threadgate": {
"type": "ref",
"ref": "#threadgateView"
},
"debug": {
"type": "unknown",
"description": "Debug information for internal development"
}
}
},
"viewerState": {
"type": "object",
"description": "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.",
"properties": {
"repost": {
"type": "string",
"format": "at-uri"
},
"like": {
"type": "string",
"format": "at-uri"
},
"bookmarked": {
"type": "boolean"
},
"threadMuted": {
"type": "boolean"
},
"replyDisabled": {
"type": "boolean"
},
"embeddingDisabled": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
}
}
},
"threadContext": {
"type": "object",
"description": "Metadata about this post within the context of the thread it is in.",
"properties": {
"rootAuthorLike": {
"type": "string",
"format": "at-uri"
}
}
},
"feedViewPost": {
"type": "object",
"required": ["post"],
"properties": {
"post": {
"type": "ref",
"ref": "#postView"
},
"reply": {
"type": "ref",
"ref": "#replyRef"
},
"reason": {
"type": "union",
"refs": ["#reasonRepost", "#reasonPin"]
},
"feedContext": {
"type": "string",
"description": "Context provided by feed generator that may be passed back alongside interactions.",
"maxLength": 2000
},
"reqId": {
"type": "string",
"description": "Unique identifier per request that may be passed back alongside interactions.",
"maxLength": 100
}
}
},
"replyRef": {
"type": "object",
"required": ["root", "parent"],
"properties": {
"root": {
"type": "union",
"refs": ["#postView", "#notFoundPost", "#blockedPost"]
},
"parent": {
"type": "union",
"refs": ["#postView", "#notFoundPost", "#blockedPost"]
},
"grandparentAuthor": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic",
"description": "When parent is a reply to another post, this is the author of that post."
}
}
},
"reasonRepost": {
"type": "object",
"required": ["by", "indexedAt"],
"properties": {
"by": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic"
},
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"indexedAt": {
"type": "string",
"format": "datetime"
}
}
},
"reasonPin": {
"type": "object",
"properties": {}
},
"threadViewPost": {
"type": "object",
"required": ["post"],
"properties": {
"post": {
"type": "ref",
"ref": "#postView"
},
"parent": {
"type": "union",
"refs": ["#threadViewPost", "#notFoundPost", "#blockedPost"]
},
"replies": {
"type": "array",
"items": {
"type": "union",
"refs": ["#threadViewPost", "#notFoundPost", "#blockedPost"]
}
},
"threadContext": {
"type": "ref",
"ref": "#threadContext"
}
}
},
"notFoundPost": {
"type": "object",
"required": ["uri", "notFound"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"notFound": {
"type": "boolean",
"const": true
}
}
},
"blockedPost": {
"type": "object",
"required": ["uri", "blocked", "author"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"blocked": {
"type": "boolean",
"const": true
},
"author": {
"type": "ref",
"ref": "#blockedAuthor"
}
}
},
"blockedAuthor": {
"type": "object",
"required": ["did"],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"viewer": {
"type": "ref",
"ref": "app.bsky.actor.defs#viewerState"
}
}
},
"generatorView": {
"type": "object",
"required": ["uri", "cid", "did", "creator", "displayName", "indexedAt"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"did": {
"type": "string",
"format": "did"
},
"creator": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
},
"displayName": {
"type": "string"
},
"description": {
"type": "string",
"maxGraphemes": 300,
"maxLength": 3000
},
"descriptionFacets": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.richtext.facet"
}
},
"avatar": {
"type": "string",
"format": "uri"
},
"likeCount": {
"type": "integer",
"minimum": 0
},
"acceptsInteractions": {
"type": "boolean"
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"viewer": {
"type": "ref",
"ref": "#generatorViewerState"
},
"contentMode": {
"type": "string",
"knownValues": [
"app.bsky.feed.defs#contentModeUnspecified",
"app.bsky.feed.defs#contentModeVideo"
]
},
"indexedAt": {
"type": "string",
"format": "datetime"
}
}
},
"generatorViewerState": {
"type": "object",
"properties": {
"like": {
"type": "string",
"format": "at-uri"
}
}
},
"skeletonFeedPost": {
"type": "object",
"required": ["post"],
"properties": {
"post": {
"type": "string",
"format": "at-uri"
},
"reason": {
"type": "union",
"refs": ["#skeletonReasonRepost", "#skeletonReasonPin"]
},
"feedContext": {
"type": "string",
"description": "Context that will be passed through to client and may be passed to feed generator back alongside interactions.",
"maxLength": 2000
}
}
},
"skeletonReasonRepost": {
"type": "object",
"required": ["repost"],
"properties": {
"repost": {
"type": "string",
"format": "at-uri"
}
}
},
"skeletonReasonPin": {
"type": "object",
"properties": {}
},
"threadgateView": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"record": {
"type": "unknown"
},
"lists": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#listViewBasic"
}
}
}
},
"interaction": {
"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"
]
},
"feedContext": {
"type": "string",
"description": "Context on a feed item that was originally supplied by the feed generator on getFeedSkeleton.",
"maxLength": 2000
},
"reqId": {
"type": "string",
"description": "Unique identifier per request that may be passed back alongside interactions.",
"maxLength": 100
}
}
},
"requestLess": {
"type": "token",
"description": "Request that less content like the given feed item be shown in the feed"
},
"requestMore": {
"type": "token",
"description": "Request that more content like the given feed item be shown in the feed"
},
"clickthroughItem": {
"type": "token",
"description": "User clicked through to the feed item"
},
"clickthroughAuthor": {
"type": "token",
"description": "User clicked through to the author of the feed item"
},
"clickthroughReposter": {
"type": "token",
"description": "User clicked through to the reposter of the feed item"
},
"clickthroughEmbed": {
"type": "token",
"description": "User clicked through to the embedded content of the feed item"
},
"contentModeUnspecified": {
"type": "token",
"description": "Declares the feed generator returns any types of posts."
},
"contentModeVideo": {
"type": "token",
"description": "Declares the feed generator returns posts containing app.bsky.embed.video embeds."
},
"interactionSeen": {
"type": "token",
"description": "Feed item was seen by user"
},
"interactionLike": {
"type": "token",
"description": "User liked the feed item"
},
"interactionRepost": {
"type": "token",
"description": "User reposted the feed item"
},
"interactionReply": {
"type": "token",
"description": "User replied to the feed item"
},
"interactionQuote": {
"type": "token",
"description": "User quoted the feed item"
},
"interactionShare": {
"type": "token",
"description": "User shared the feed item"
}
}
}
@@ -0,0 +1,55 @@
{
"lexicon": 1,
"id": "app.bsky.feed.describeFeedGenerator",
"defs": {
"main": {
"type": "query",
"description": "Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).",
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["did", "feeds"],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"feeds": {
"type": "array",
"items": {
"type": "ref",
"ref": "#feed"
}
},
"links": {
"type": "ref",
"ref": "#links"
}
}
}
}
},
"feed": {
"type": "object",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
}
}
},
"links": {
"type": "object",
"properties": {
"privacyPolicy": {
"type": "string"
},
"termsOfService": {
"type": "string"
}
}
}
}
}
+63
View File
@@ -0,0 +1,63 @@
{
"lexicon": 1,
"id": "app.bsky.feed.generator",
"defs": {
"main": {
"type": "record",
"description": "Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.",
"key": "any",
"record": {
"type": "object",
"required": ["did", "displayName", "createdAt"],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"displayName": {
"type": "string",
"maxGraphemes": 24,
"maxLength": 240
},
"description": {
"type": "string",
"maxGraphemes": 300,
"maxLength": 3000
},
"descriptionFacets": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.richtext.facet"
}
},
"avatar": {
"type": "blob",
"accept": ["image/png", "image/jpeg"],
"maxSize": 1000000
},
"acceptsInteractions": {
"type": "boolean",
"description": "Declaration that a feed accepts feedback interactions from a client through app.bsky.feed.sendInteractions"
},
"labels": {
"type": "union",
"description": "Self-label values",
"refs": ["com.atproto.label.defs#selfLabels"]
},
"contentMode": {
"type": "string",
"knownValues": [
"app.bsky.feed.defs#contentModeUnspecified",
"app.bsky.feed.defs#contentModeVideo"
]
},
"createdAt": {
"type": "string",
"format": "datetime"
}
}
}
}
}
}
+48
View File
@@ -0,0 +1,48 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getActorFeeds",
"defs": {
"main": {
"type": "query",
"description": "Get a list of feeds (feed generator records) created by the actor (in the actor's repo).",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feeds"],
"properties": {
"cursor": {
"type": "string"
},
"feeds": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#generatorView"
}
}
}
}
}
}
}
}
+56
View File
@@ -0,0 +1,56 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getActorLikes",
"defs": {
"main": {
"type": "query",
"description": "Get a list of posts liked by an actor. Requires auth, actor must be the requesting account.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feed"],
"properties": {
"cursor": {
"type": "string"
},
"feed": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#feedViewPost"
}
}
}
}
},
"errors": [
{
"name": "BlockedActor"
},
{
"name": "BlockedByActor"
}
]
}
}
}
+72
View File
@@ -0,0 +1,72 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getAuthorFeed",
"defs": {
"main": {
"type": "query",
"description": "Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
},
"filter": {
"type": "string",
"description": "Combinations of post/repost types to include in response.",
"knownValues": [
"posts_with_replies",
"posts_no_replies",
"posts_with_media",
"posts_and_author_threads",
"posts_with_video"
],
"default": "posts_with_replies"
},
"includePins": {
"type": "boolean",
"default": false
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feed"],
"properties": {
"cursor": {
"type": "string"
},
"feed": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#feedViewPost"
}
}
}
}
},
"errors": [
{
"name": "BlockedActor"
},
{
"name": "BlockedByActor"
}
]
}
}
}
+53
View File
@@ -0,0 +1,53 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getFeed",
"defs": {
"main": {
"type": "query",
"description": "Get a hydrated feed from an actor's selected feed generator. Implemented by App View.",
"parameters": {
"type": "params",
"required": ["feed"],
"properties": {
"feed": {
"type": "string",
"format": "at-uri"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feed"],
"properties": {
"cursor": {
"type": "string"
},
"feed": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#feedViewPost"
}
}
}
}
},
"errors": [
{
"name": "UnknownFeed"
}
]
}
}
}
@@ -0,0 +1,42 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getFeedGenerator",
"defs": {
"main": {
"type": "query",
"description": "Get information about a feed generator. Implemented by AppView.",
"parameters": {
"type": "params",
"required": ["feed"],
"properties": {
"feed": {
"type": "string",
"format": "at-uri",
"description": "AT-URI of the feed generator record."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["view", "isOnline", "isValid"],
"properties": {
"view": {
"type": "ref",
"ref": "app.bsky.feed.defs#generatorView"
},
"isOnline": {
"type": "boolean",
"description": "Indicates whether the feed generator service has been online recently, or else seems to be inactive."
},
"isValid": {
"type": "boolean",
"description": "Indicates whether the feed generator service is compatible with the record declaration."
}
}
}
}
}
}
}
@@ -0,0 +1,39 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getFeedGenerators",
"defs": {
"main": {
"type": "query",
"description": "Get information about a list of feed generators.",
"parameters": {
"type": "params",
"required": ["feeds"],
"properties": {
"feeds": {
"type": "array",
"items": {
"type": "string",
"format": "at-uri"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feeds"],
"properties": {
"feeds": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#generatorView"
}
}
}
}
}
}
}
}
@@ -0,0 +1,59 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getFeedSkeleton",
"defs": {
"main": {
"type": "query",
"description": "Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.",
"parameters": {
"type": "params",
"required": ["feed"],
"properties": {
"feed": {
"type": "string",
"format": "at-uri",
"description": "Reference to feed generator record describing the specific feed being requested."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feed"],
"properties": {
"cursor": {
"type": "string"
},
"feed": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#skeletonFeedPost"
}
},
"reqId": {
"type": "string",
"description": "Unique identifier per request that may be passed back alongside interactions.",
"maxLength": 100
}
}
}
},
"errors": [
{
"name": "UnknownFeed"
}
]
}
}
}
+80
View File
@@ -0,0 +1,80 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getLikes",
"defs": {
"main": {
"type": "query",
"description": "Get like records which reference a subject (by AT-URI and CID).",
"parameters": {
"type": "params",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri",
"description": "AT-URI of the subject (eg, a post record)."
},
"cid": {
"type": "string",
"format": "cid",
"description": "CID of the subject record (aka, specific version of record), to filter likes."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["uri", "likes"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"cursor": {
"type": "string"
},
"likes": {
"type": "array",
"items": {
"type": "ref",
"ref": "#like"
}
}
}
}
}
},
"like": {
"type": "object",
"required": ["indexedAt", "createdAt", "actor"],
"properties": {
"indexedAt": {
"type": "string",
"format": "datetime"
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"actor": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
+54
View File
@@ -0,0 +1,54 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getListFeed",
"defs": {
"main": {
"type": "query",
"description": "Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.",
"parameters": {
"type": "params",
"required": ["list"],
"properties": {
"list": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) to the list record."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feed"],
"properties": {
"cursor": {
"type": "string"
},
"feed": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#feedViewPost"
}
}
}
}
},
"errors": [
{
"name": "UnknownList"
}
]
}
}
}
+61
View File
@@ -0,0 +1,61 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getPostThread",
"defs": {
"main": {
"type": "query",
"description": "Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.",
"parameters": {
"type": "params",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) to post record."
},
"depth": {
"type": "integer",
"description": "How many levels of reply depth should be included in response.",
"default": 6,
"minimum": 0,
"maximum": 1000
},
"parentHeight": {
"type": "integer",
"description": "How many levels of parent (and grandparent, etc) post to include.",
"default": 80,
"minimum": 0,
"maximum": 1000
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["thread"],
"properties": {
"thread": {
"type": "union",
"refs": [
"app.bsky.feed.defs#threadViewPost",
"app.bsky.feed.defs#notFoundPost",
"app.bsky.feed.defs#blockedPost"
]
},
"threadgate": {
"type": "ref",
"ref": "app.bsky.feed.defs#threadgateView"
}
}
}
},
"errors": [
{
"name": "NotFound"
}
]
}
}
}
+41
View File
@@ -0,0 +1,41 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getPosts",
"defs": {
"main": {
"type": "query",
"description": "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
"parameters": {
"type": "params",
"required": ["uris"],
"properties": {
"uris": {
"type": "array",
"description": "List of post AT-URIs to return hydrated views for.",
"items": {
"type": "string",
"format": "at-uri"
},
"maxLength": 25
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["posts"],
"properties": {
"posts": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#postView"
}
}
}
}
}
}
}
}
+62
View File
@@ -0,0 +1,62 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getQuotes",
"defs": {
"main": {
"type": "query",
"description": "Get a list of quotes for a given post.",
"parameters": {
"type": "params",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) of post record"
},
"cid": {
"type": "string",
"format": "cid",
"description": "If supplied, filters to quotes of specific version (by CID) of the post record."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["uri", "posts"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"cursor": {
"type": "string"
},
"posts": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#postView"
}
}
}
}
}
}
}
}
+62
View File
@@ -0,0 +1,62 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getRepostedBy",
"defs": {
"main": {
"type": "query",
"description": "Get a list of reposts for a given post.",
"parameters": {
"type": "params",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) of post record"
},
"cid": {
"type": "string",
"format": "cid",
"description": "If supplied, filters to reposts of specific version (by CID) of the post record."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["uri", "repostedBy"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"cursor": {
"type": "string"
},
"repostedBy": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
}
}
}
@@ -0,0 +1,43 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getSuggestedFeeds",
"defs": {
"main": {
"type": "query",
"description": "Get a list of suggested feeds (feed generators) for the requesting account.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feeds"],
"properties": {
"cursor": {
"type": "string"
},
"feeds": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#generatorView"
}
}
}
}
}
}
}
}
+47
View File
@@ -0,0 +1,47 @@
{
"lexicon": 1,
"id": "app.bsky.feed.getTimeline",
"defs": {
"main": {
"type": "query",
"description": "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
"parameters": {
"type": "params",
"properties": {
"algorithm": {
"type": "string",
"description": "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["feed"],
"properties": {
"cursor": {
"type": "string"
},
"feed": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#feedViewPost"
}
}
}
}
}
}
}
}
+29
View File
@@ -0,0 +1,29 @@
{
"lexicon": 1,
"id": "app.bsky.feed.like",
"defs": {
"main": {
"type": "record",
"description": "Record declaring a 'like' of a piece of subject content.",
"key": "tid",
"record": {
"type": "object",
"required": ["subject", "createdAt"],
"properties": {
"subject": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"via": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
}
}
}
}
}
}
+130
View File
@@ -0,0 +1,130 @@
{
"lexicon": 1,
"id": "app.bsky.feed.post",
"defs": {
"main": {
"type": "record",
"description": "Record containing a Bluesky post.",
"key": "tid",
"record": {
"type": "object",
"required": ["text", "createdAt"],
"properties": {
"text": {
"type": "string",
"maxLength": 3000,
"maxGraphemes": 300,
"description": "The primary post content. May be an empty string, if there are embeds."
},
"entities": {
"type": "array",
"description": "DEPRECATED: replaced by app.bsky.richtext.facet.",
"items": {
"type": "ref",
"ref": "#entity"
}
},
"facets": {
"type": "array",
"description": "Annotations of text (mentions, URLs, hashtags, etc)",
"items": {
"type": "ref",
"ref": "app.bsky.richtext.facet"
}
},
"reply": {
"type": "ref",
"ref": "#replyRef"
},
"embed": {
"type": "union",
"refs": [
"app.bsky.embed.images",
"app.bsky.embed.video",
"app.bsky.embed.gallery",
"app.bsky.embed.external",
"app.bsky.embed.record",
"app.bsky.embed.recordWithMedia"
]
},
"langs": {
"type": "array",
"description": "Indicates human language of post primary text content.",
"maxLength": 3,
"items": {
"type": "string",
"format": "language"
}
},
"labels": {
"type": "union",
"description": "Self-label values for this post. Effectively content warnings.",
"refs": ["com.atproto.label.defs#selfLabels"]
},
"tags": {
"type": "array",
"description": "Additional hashtags, in addition to any included in post text and facets.",
"maxLength": 8,
"items": {
"type": "string",
"maxLength": 640,
"maxGraphemes": 64
}
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "Client-declared timestamp when this post was originally created."
}
}
}
},
"replyRef": {
"type": "object",
"required": ["root", "parent"],
"properties": {
"root": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"parent": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
}
}
},
"entity": {
"type": "object",
"description": "Deprecated: use facets instead.",
"required": ["index", "type", "value"],
"properties": {
"index": {
"type": "ref",
"ref": "#textSlice"
},
"type": {
"type": "string",
"description": "Expected values are 'mention' and 'link'."
},
"value": {
"type": "string"
}
}
},
"textSlice": {
"type": "object",
"description": "Deprecated. Use app.bsky.richtext instead -- A text segment. Start is inclusive, end is exclusive. Indices are for utf16-encoded strings.",
"required": ["start", "end"],
"properties": {
"start": {
"type": "integer",
"minimum": 0
},
"end": {
"type": "integer",
"minimum": 0
}
}
}
}
}
+49
View File
@@ -0,0 +1,49 @@
{
"lexicon": 1,
"id": "app.bsky.feed.postgate",
"defs": {
"main": {
"type": "record",
"key": "tid",
"description": "Record defining interaction rules for a post. The record key (rkey) of the postgate record must match the record key of the post, and that record must be in the same repository.",
"record": {
"type": "object",
"required": ["post", "createdAt"],
"properties": {
"createdAt": {
"type": "string",
"format": "datetime"
},
"post": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) to the post record."
},
"detachedEmbeddingUris": {
"type": "array",
"maxLength": 50,
"items": {
"type": "string",
"format": "at-uri"
},
"description": "List of AT-URIs embedding this post that the author has detached from."
},
"embeddingRules": {
"description": "List of rules defining who can embed this post. If value is an empty array or is undefined, no particular rules apply and anyone can embed.",
"type": "array",
"maxLength": 5,
"items": {
"type": "union",
"refs": ["#disableRule"]
}
}
}
}
},
"disableRule": {
"type": "object",
"description": "Disables embedding of this post.",
"properties": {}
}
}
}
+29
View File
@@ -0,0 +1,29 @@
{
"lexicon": 1,
"id": "app.bsky.feed.repost",
"defs": {
"main": {
"description": "Record representing a 'repost' of an existing Bluesky post.",
"type": "record",
"key": "tid",
"record": {
"type": "object",
"required": ["subject", "createdAt"],
"properties": {
"subject": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"via": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
}
}
}
}
}
}
+105
View File
@@ -0,0 +1,105 @@
{
"lexicon": 1,
"id": "app.bsky.feed.searchPosts",
"defs": {
"main": {
"type": "query",
"description": "Find posts matching search criteria, returning views of those posts. Note that this API endpoint may require authentication (eg, not public) for some service providers and implementations.",
"parameters": {
"type": "params",
"required": ["q"],
"properties": {
"q": {
"type": "string",
"description": "Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended."
},
"sort": {
"type": "string",
"knownValues": ["top", "latest"],
"default": "latest",
"description": "Specifies the ranking order of results."
},
"since": {
"type": "string",
"description": "Filter results for posts after the indicated datetime (inclusive). Expected to use 'sortAt' timestamp, which may not match 'createdAt'. Can be a datetime, or just an ISO date (YYYY-MM-DD)."
},
"until": {
"type": "string",
"description": "Filter results for posts before the indicated datetime (not inclusive). Expected to use 'sortAt' timestamp, which may not match 'createdAt'. Can be a datetime, or just an ISO date (YYY-MM-DD)."
},
"mentions": {
"type": "string",
"format": "at-identifier",
"description": "Filter to posts which mention the given account. Handles are resolved to DID before query-time. Only matches rich-text facet mentions."
},
"author": {
"type": "string",
"format": "at-identifier",
"description": "Filter to posts by the given account. Handles are resolved to DID before query-time."
},
"lang": {
"type": "string",
"format": "language",
"description": "Filter to posts in the given language. Expected to be based on post language field, though server may override language detection."
},
"domain": {
"type": "string",
"description": "Filter to posts with URLs (facet links or embeds) linking to the given domain (hostname). Server may apply hostname normalization."
},
"url": {
"type": "string",
"format": "uri",
"description": "Filter to posts with links (facet links or embeds) pointing to this URL. Server may apply URL normalization or fuzzy matching."
},
"tag": {
"type": "array",
"items": {
"type": "string",
"maxLength": 640,
"maxGraphemes": 64
},
"description": "Filter to posts with the given tag (hashtag), based on rich-text facet or tag field. Do not include the hash (#) prefix. Multiple tags can be specified, with 'AND' matching."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
},
"cursor": {
"type": "string",
"description": "Optional pagination mechanism; may not necessarily allow scrolling through entire result set."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["posts"],
"properties": {
"cursor": {
"type": "string"
},
"hitsTotal": {
"type": "integer",
"description": "Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits."
},
"posts": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#postView"
}
}
}
}
},
"errors": [
{
"name": "BadQueryString"
}
]
}
}
}
+233
View File
@@ -0,0 +1,233 @@
{
"lexicon": 1,
"id": "app.bsky.feed.searchPostsV2",
"defs": {
"main": {
"type": "query",
"description": "Find posts matching a search query or filters, returning search hits for matching post records.",
"parameters": {
"type": "params",
"required": [],
"properties": {
"cursor": {
"type": "string",
"description": "Optional pagination cursor."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25,
"description": "Maximum number of results to return."
},
"query": {
"type": "string",
"description": "Search query string. A query or at least one filter is required."
},
"sort": {
"type": "string",
"knownValues": ["recent", "top"],
"description": "Ranking order for results. 'recent' sorts by recency; 'top' uses search ranking."
},
"authors": {
"type": "array",
"items": {
"type": "string",
"format": "at-identifier"
},
"description": "Include posts by any of these authors. Handles are resolved to DIDs before searching."
},
"mentions": {
"type": "array",
"items": {
"type": "string",
"format": "at-identifier"
},
"description": "Include posts that mention any of these accounts. Handles are resolved to DIDs before searching."
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Include posts that link to any of these domains."
},
"urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"description": "Include posts that link to any of these URLs."
},
"embeddedAtUris": {
"type": "array",
"items": {
"type": "string",
"format": "at-uri"
},
"description": "Include posts that embed any of these AT URIs."
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 640,
"maxGraphemes": 64
},
"description": "Include posts tagged with any of these hashtags. Do not include the hash (#) prefix."
},
"excludeAuthors": {
"type": "array",
"items": {
"type": "string",
"format": "at-identifier"
},
"description": "Exclude posts by any of these authors. Handles are resolved to DIDs before searching."
},
"excludeMentions": {
"type": "array",
"items": {
"type": "string",
"format": "at-identifier"
},
"description": "Exclude posts that mention any of these accounts. Handles are resolved to DIDs before searching."
},
"excludeDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude posts that link to any of these domains."
},
"excludeUrls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"description": "Exclude posts that link to any of these URLs."
},
"excludeEmbeddedAtUris": {
"type": "array",
"items": {
"type": "string",
"format": "at-uri"
},
"description": "Exclude posts that embed any of these AT URIs."
},
"excludeHashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 640,
"maxGraphemes": 64
},
"description": "Exclude posts tagged with any of these hashtags. Do not include the hash (#) prefix."
},
"since": {
"type": "string",
"description": "Include posts indexed at or after this timestamp. Can be a datetime, or just an ISO date (YYYY-MM-DD)."
},
"until": {
"type": "string",
"description": "Include posts indexed before this timestamp. Defaults to the current time. Can be a datetime, or just an ISO date (YYYY-MM-DD)."
},
"allTime": {
"type": "boolean",
"description": "Search the full index instead of the recent-post window."
},
"languages": {
"type": "array",
"items": {
"type": "string",
"format": "language"
},
"description": "Include posts whose language matches any of these language codes."
},
"excludeLanguages": {
"type": "array",
"items": {
"type": "string",
"format": "language"
},
"description": "Exclude posts whose language matches any of these language codes."
},
"hasMedia": {
"type": "boolean",
"description": "Include only posts with media."
},
"hasVideo": {
"type": "boolean",
"description": "Include only posts with video."
},
"replyParentUri": {
"type": "string",
"format": "at-uri",
"description": "Include only direct replies to this parent post URI."
},
"threadRootUri": {
"type": "string",
"format": "at-uri",
"description": "Include only posts in the thread rooted at this post URI."
},
"excludeReplies": {
"type": "boolean",
"description": "Exclude replies from results. Mutually exclusive with repliesOnly."
},
"repliesOnly": {
"type": "boolean",
"description": "Include only replies. Mutually exclusive with excludeReplies."
},
"following": {
"type": "boolean",
"description": "Include only posts from accounts followed by the viewer."
},
"queryLanguage": {
"type": "string",
"knownValues": ["ja", "zh", "ko", "th", "ar"],
"description": "Language analyzer hint for the query text. If unset, the server auto-detects when possible."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["posts"],
"properties": {
"cursor": {
"type": "string",
"description": "Cursor for the next page of results."
},
"hitsTotal": {
"type": "integer",
"description": "Estimated total number of matching hits. May be rounded or truncated."
},
"posts": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#postView"
},
"description": "Hydrated views of matching posts."
},
"detectedQueryLanguages": {
"type": "array",
"items": {
"type": "string",
"knownValues": ["ja", "zh", "ko", "th", "ar"]
},
"description": "Query languages detected for CJK, Thai, or Arabic text. Empty or omitted for other scripts."
}
}
}
},
"errors": [
{
"name": "BadQueryString"
}
]
}
}
}
@@ -0,0 +1,37 @@
{
"lexicon": 1,
"id": "app.bsky.feed.sendInteractions",
"defs": {
"main": {
"type": "procedure",
"description": "Send information about interactions with feed items back to the feed generator that served them.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["interactions"],
"properties": {
"feed": {
"type": "string",
"format": "at-uri"
},
"interactions": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#interaction"
}
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {}
}
}
}
}
}
+75
View File
@@ -0,0 +1,75 @@
{
"lexicon": 1,
"id": "app.bsky.feed.threadgate",
"defs": {
"main": {
"type": "record",
"key": "tid",
"description": "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository.",
"record": {
"type": "object",
"required": ["post", "createdAt"],
"properties": {
"post": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) to the post record."
},
"allow": {
"description": "List of rules defining who can reply to this post. If value is an empty array, no one can reply. If value is undefined, anyone can reply.",
"type": "array",
"maxLength": 5,
"items": {
"type": "union",
"refs": [
"#mentionRule",
"#followerRule",
"#followingRule",
"#listRule"
]
}
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"hiddenReplies": {
"type": "array",
"maxLength": 300,
"items": {
"type": "string",
"format": "at-uri"
},
"description": "List of hidden reply URIs."
}
}
}
},
"mentionRule": {
"type": "object",
"description": "Allow replies from actors mentioned in your post.",
"properties": {}
},
"followerRule": {
"type": "object",
"description": "Allow replies from actors who follow you.",
"properties": {}
},
"followingRule": {
"type": "object",
"description": "Allow replies from actors you follow.",
"properties": {}
},
"listRule": {
"type": "object",
"description": "Allow replies from actors on a list.",
"required": ["list"],
"properties": {
"list": {
"type": "string",
"format": "at-uri"
}
}
}
}
}
+26
View File
@@ -0,0 +1,26 @@
{
"lexicon": 1,
"id": "app.bsky.graph.block",
"defs": {
"main": {
"type": "record",
"description": "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.",
"key": "tid",
"record": {
"type": "object",
"required": ["subject", "createdAt"],
"properties": {
"subject": {
"type": "string",
"format": "did",
"description": "DID of the account to be blocked."
},
"createdAt": {
"type": "string",
"format": "datetime"
}
}
}
}
}
}
+320
View File
@@ -0,0 +1,320 @@
{
"lexicon": 1,
"id": "app.bsky.graph.defs",
"defs": {
"listViewBasic": {
"type": "object",
"required": ["uri", "cid", "name", "purpose"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"purpose": {
"type": "ref",
"ref": "#listPurpose"
},
"avatar": {
"type": "string",
"format": "uri"
},
"listItemCount": {
"type": "integer",
"minimum": 0
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"viewer": {
"type": "ref",
"ref": "#listViewerState"
},
"indexedAt": {
"type": "string",
"format": "datetime"
}
}
},
"listView": {
"type": "object",
"required": ["uri", "cid", "creator", "name", "purpose", "indexedAt"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"creator": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
},
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"purpose": {
"type": "ref",
"ref": "#listPurpose"
},
"description": {
"type": "string",
"maxGraphemes": 300,
"maxLength": 3000
},
"descriptionFacets": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.richtext.facet"
}
},
"avatar": {
"type": "string",
"format": "uri"
},
"listItemCount": {
"type": "integer",
"minimum": 0
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"viewer": {
"type": "ref",
"ref": "#listViewerState"
},
"indexedAt": {
"type": "string",
"format": "datetime"
}
}
},
"listItemView": {
"type": "object",
"required": ["uri", "subject"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"subject": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
},
"starterPackView": {
"type": "object",
"required": ["uri", "cid", "record", "creator", "indexedAt"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"record": {
"type": "unknown"
},
"creator": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic"
},
"list": {
"type": "ref",
"ref": "#listViewBasic"
},
"listItemsSample": {
"type": "array",
"maxLength": 12,
"items": {
"type": "ref",
"ref": "#listItemView"
}
},
"feeds": {
"type": "array",
"maxLength": 3,
"items": {
"type": "ref",
"ref": "app.bsky.feed.defs#generatorView"
}
},
"joinedWeekCount": {
"type": "integer",
"minimum": 0
},
"joinedAllTimeCount": {
"type": "integer",
"minimum": 0
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"indexedAt": {
"type": "string",
"format": "datetime"
}
}
},
"starterPackViewBasic": {
"type": "object",
"required": ["uri", "cid", "record", "creator", "indexedAt"],
"properties": {
"uri": {
"type": "string",
"format": "at-uri"
},
"cid": {
"type": "string",
"format": "cid"
},
"record": {
"type": "unknown"
},
"creator": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileViewBasic"
},
"listItemCount": {
"type": "integer",
"minimum": 0
},
"joinedWeekCount": {
"type": "integer",
"minimum": 0
},
"joinedAllTimeCount": {
"type": "integer",
"minimum": 0
},
"labels": {
"type": "array",
"items": {
"type": "ref",
"ref": "com.atproto.label.defs#label"
}
},
"indexedAt": {
"type": "string",
"format": "datetime"
}
}
},
"listPurpose": {
"type": "string",
"knownValues": [
"app.bsky.graph.defs#modlist",
"app.bsky.graph.defs#curatelist",
"app.bsky.graph.defs#referencelist"
]
},
"modlist": {
"type": "token",
"description": "A list of actors to apply an aggregate moderation action (mute/block) on."
},
"curatelist": {
"type": "token",
"description": "A list of actors used for curation purposes such as list feeds or interaction gating."
},
"referencelist": {
"type": "token",
"description": "A list of actors used for only for reference purposes such as within a starter pack."
},
"listViewerState": {
"type": "object",
"properties": {
"muted": {
"type": "boolean"
},
"blocked": {
"type": "string",
"format": "at-uri"
}
}
},
"notFoundActor": {
"type": "object",
"description": "indicates that a handle or DID could not be resolved",
"required": ["actor", "notFound"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"notFound": {
"type": "boolean",
"const": true
}
}
},
"relationship": {
"type": "object",
"description": "lists the bi-directional graph relationships between one actor (not indicated in the object), and the target actors (the DID included in the object)",
"required": ["did"],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"following": {
"type": "string",
"format": "at-uri",
"description": "if the actor follows this DID, this is the AT-URI of the follow record"
},
"followedBy": {
"type": "string",
"format": "at-uri",
"description": "if the actor is followed by this DID, contains the AT-URI of the follow record"
},
"blocking": {
"type": "string",
"format": "at-uri",
"description": "if the actor blocks this DID, this is the AT-URI of the block record"
},
"blockedBy": {
"type": "string",
"format": "at-uri",
"description": "if the actor is blocked by this DID, contains the AT-URI of the block record"
},
"blockingByList": {
"type": "string",
"format": "at-uri",
"description": "if the actor blocks this DID via a block list, this is the AT-URI of the listblock record"
},
"blockedByList": {
"type": "string",
"format": "at-uri",
"description": "if the actor is blocked by this DID via a block list, contains the AT-URI of the listblock record"
}
}
}
}
}
+29
View File
@@ -0,0 +1,29 @@
{
"lexicon": 1,
"id": "app.bsky.graph.follow",
"defs": {
"main": {
"type": "record",
"description": "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.",
"key": "tid",
"record": {
"type": "object",
"required": ["subject", "createdAt"],
"properties": {
"subject": {
"type": "string",
"format": "did"
},
"createdAt": {
"type": "string",
"format": "datetime"
},
"via": {
"type": "ref",
"ref": "com.atproto.repo.strongRef"
}
}
}
}
}
}
@@ -0,0 +1,48 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getActorStarterPacks",
"defs": {
"main": {
"type": "query",
"description": "Get a list of starter packs created by the actor.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["starterPacks"],
"properties": {
"cursor": {
"type": "string"
},
"starterPacks": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#starterPackViewBasic"
}
}
}
}
}
}
}
}
+43
View File
@@ -0,0 +1,43 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getBlocks",
"defs": {
"main": {
"type": "query",
"description": "Enumerates which accounts the requesting account is currently blocking. Requires auth.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["blocks"],
"properties": {
"cursor": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
}
}
}
+52
View File
@@ -0,0 +1,52 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getFollowers",
"defs": {
"main": {
"type": "query",
"description": "Enumerates accounts which follow a specified account (actor).",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["subject", "followers"],
"properties": {
"subject": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
},
"cursor": {
"type": "string"
},
"followers": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
}
}
}
+52
View File
@@ -0,0 +1,52 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getFollows",
"defs": {
"main": {
"type": "query",
"description": "Enumerates accounts which a specified account (actor) follows.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["subject", "follows"],
"properties": {
"subject": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
},
"cursor": {
"type": "string"
},
"follows": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
}
}
}
@@ -0,0 +1,52 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getKnownFollowers",
"defs": {
"main": {
"type": "query",
"description": "Enumerates accounts which follow a specified account (actor) and are followed by the viewer.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["subject", "followers"],
"properties": {
"subject": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
},
"cursor": {
"type": "string"
},
"followers": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
}
}
}
+53
View File
@@ -0,0 +1,53 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getList",
"defs": {
"main": {
"type": "query",
"description": "Gets a 'view' (with additional context) of a specified list.",
"parameters": {
"type": "params",
"required": ["list"],
"properties": {
"list": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) of the list record to hydrate."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["list", "items"],
"properties": {
"cursor": {
"type": "string"
},
"list": {
"type": "ref",
"ref": "app.bsky.graph.defs#listView"
},
"items": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#listItemView"
}
}
}
}
}
}
}
}
@@ -0,0 +1,43 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getListBlocks",
"defs": {
"main": {
"type": "query",
"description": "Get mod lists that the requesting account (actor) is blocking. Requires auth.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["lists"],
"properties": {
"cursor": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#listView"
}
}
}
}
}
}
}
}
+43
View File
@@ -0,0 +1,43 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getListMutes",
"defs": {
"main": {
"type": "query",
"description": "Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["lists"],
"properties": {
"cursor": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#listView"
}
}
}
}
}
}
}
}
+57
View File
@@ -0,0 +1,57 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getLists",
"defs": {
"main": {
"type": "query",
"description": "Enumerates the lists created by a specified account (actor).",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier",
"description": "The account (actor) to enumerate lists from."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
},
"purposes": {
"type": "array",
"description": "Optional filter by list purpose. If not specified, all supported types are returned.",
"items": {
"type": "string",
"knownValues": ["modlist", "curatelist"]
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["lists"],
"properties": {
"cursor": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#listView"
}
}
}
}
}
}
}
}
@@ -0,0 +1,72 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getListsWithMembership",
"defs": {
"main": {
"type": "query",
"description": "Enumerates the lists created by the session user, and includes membership information about `actor` in those lists. Only supports curation and moderation lists (no reference lists, used in starter packs). Requires auth.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier",
"description": "The account (actor) to check for membership."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
},
"purposes": {
"type": "array",
"description": "Optional filter by list purpose. If not specified, all supported types are returned.",
"items": {
"type": "string",
"knownValues": ["modlist", "curatelist"]
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["listsWithMembership"],
"properties": {
"cursor": {
"type": "string"
},
"listsWithMembership": {
"type": "array",
"items": {
"type": "ref",
"ref": "#listWithMembership"
}
}
}
}
}
},
"listWithMembership": {
"description": "A list and an optional list item indicating membership of a target user to that list.",
"type": "object",
"required": ["list"],
"properties": {
"list": {
"type": "ref",
"ref": "app.bsky.graph.defs#listView"
},
"listItem": {
"type": "ref",
"ref": "app.bsky.graph.defs#listItemView"
}
}
}
}
}
+43
View File
@@ -0,0 +1,43 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getMutes",
"defs": {
"main": {
"type": "query",
"description": "Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["mutes"],
"properties": {
"cursor": {
"type": "string"
},
"mutes": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
}
}
}
}
}
}
}
@@ -0,0 +1,59 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getRelationships",
"defs": {
"main": {
"type": "query",
"description": "Enumerates public relationships between one account, and a list of other accounts. Does not require auth.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier",
"description": "Primary account requesting relationships for."
},
"others": {
"type": "array",
"description": "List of 'other' accounts to be related back to the primary.",
"maxLength": 30,
"items": {
"type": "string",
"format": "at-identifier"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["relationships"],
"properties": {
"actor": {
"type": "string",
"format": "did"
},
"relationships": {
"type": "array",
"items": {
"type": "union",
"refs": [
"app.bsky.graph.defs#relationship",
"app.bsky.graph.defs#notFoundActor"
]
}
}
}
}
},
"errors": [
{
"name": "ActorNotFound",
"description": "the primary actor at-identifier could not be resolved"
}
]
}
}
}
@@ -0,0 +1,34 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getStarterPack",
"defs": {
"main": {
"type": "query",
"description": "Gets a view of a starter pack.",
"parameters": {
"type": "params",
"required": ["starterPack"],
"properties": {
"starterPack": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) of the starter pack record."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["starterPack"],
"properties": {
"starterPack": {
"type": "ref",
"ref": "app.bsky.graph.defs#starterPackView"
}
}
}
}
}
}
}
@@ -0,0 +1,40 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getStarterPacks",
"defs": {
"main": {
"type": "query",
"description": "Get views for a list of starter packs.",
"parameters": {
"type": "params",
"required": ["uris"],
"properties": {
"uris": {
"type": "array",
"items": {
"type": "string",
"format": "at-uri"
},
"maxLength": 25
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["starterPacks"],
"properties": {
"starterPacks": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#starterPackViewBasic"
}
}
}
}
}
}
}
}
@@ -0,0 +1,64 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getStarterPacksWithMembership",
"defs": {
"main": {
"type": "query",
"description": "Enumerates the starter packs created by the session user, and includes membership information about `actor` in those starter packs. Requires auth.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier",
"description": "The account (actor) to check for membership."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["starterPacksWithMembership"],
"properties": {
"cursor": {
"type": "string"
},
"starterPacksWithMembership": {
"type": "array",
"items": {
"type": "ref",
"ref": "#starterPackWithMembership"
}
}
}
}
}
},
"starterPackWithMembership": {
"description": "A starter pack and an optional list item indicating membership of a target user to that starter pack.",
"type": "object",
"required": ["starterPack"],
"properties": {
"starterPack": {
"type": "ref",
"ref": "app.bsky.graph.defs#starterPackView"
},
"listItem": {
"type": "ref",
"ref": "app.bsky.graph.defs#listItemView"
}
}
}
}
}
@@ -0,0 +1,49 @@
{
"lexicon": 1,
"id": "app.bsky.graph.getSuggestedFollowsByActor",
"defs": {
"main": {
"type": "query",
"description": "Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.",
"parameters": {
"type": "params",
"required": ["actor"],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier"
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["suggestions"],
"properties": {
"suggestions": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.actor.defs#profileView"
}
},
"recIdStr": {
"type": "string",
"description": "Snowflake for this recommendation, use when submitting recommendation events."
},
"isFallback": {
"type": "boolean",
"description": "DEPRECATED, unused. Previously: if true, response has fallen-back to generic results, and is not scoped using relativeToDid",
"default": false
},
"recId": {
"type": "integer",
"description": "DEPRECATED: use recIdStr instead."
}
}
}
}
}
}
}
+53
View File
@@ -0,0 +1,53 @@
{
"lexicon": 1,
"id": "app.bsky.graph.list",
"defs": {
"main": {
"type": "record",
"description": "Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.",
"key": "tid",
"record": {
"type": "object",
"required": ["name", "purpose", "createdAt"],
"properties": {
"purpose": {
"type": "ref",
"description": "Defines the purpose of the list (aka, moderation-oriented or curration-oriented)",
"ref": "app.bsky.graph.defs#listPurpose"
},
"name": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Display name for list; can not be empty."
},
"description": {
"type": "string",
"maxGraphemes": 300,
"maxLength": 3000
},
"descriptionFacets": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.richtext.facet"
}
},
"avatar": {
"type": "blob",
"accept": ["image/png", "image/jpeg"],
"maxSize": 1000000
},
"labels": {
"type": "union",
"refs": ["com.atproto.label.defs#selfLabels"]
},
"createdAt": {
"type": "string",
"format": "datetime"
}
}
}
}
}
}
+26
View File
@@ -0,0 +1,26 @@
{
"lexicon": 1,
"id": "app.bsky.graph.listblock",
"defs": {
"main": {
"type": "record",
"description": "Record representing a block relationship against an entire an entire list of accounts (actors).",
"key": "tid",
"record": {
"type": "object",
"required": ["subject", "createdAt"],
"properties": {
"subject": {
"type": "string",
"format": "at-uri",
"description": "Reference (AT-URI) to the mod list record."
},
"createdAt": {
"type": "string",
"format": "datetime"
}
}
}
}
}
}

Some files were not shown because too many files have changed in this diff Show More