app.bsky.graph.defs

bsky-lexicons.bsky.social

Documentation

curatelist token

A list of actors used for curation purposes such as list feeds or interaction gating.

Referenceapp.bsky.graph.defs#curatelist

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

View raw schema 
{
  "type": "token",
  "description": "A list of actors used for curation purposes such as list feeds or interaction gating."
}
listItemView object

No description available.

Properties

uri string at-uri Required

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

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "subject"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "subject": {
      "ref": "app.bsky.actor.defs#profileView",
      "type": "ref"
    }
  }
}
listPurpose string

No description available.

Known Values (other values may be valid)
app.bsky.graph.defs#modlist(token) app.bsky.graph.defs#curatelist(token) app.bsky.graph.defs#referencelist(token)
View raw schema 
{
  "type": "string",
  "knownValues": [
    "app.bsky.graph.defs#modlist",
    "app.bsky.graph.defs#curatelist",
    "app.bsky.graph.defs#referencelist"
  ]
}
listView object

No description available.

Properties

avatar string uri Optional

A valid URI.

cid string cid Required

A content identifier (CID) referencing immutable data.

description string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
indexedAt string datetime Required

An RFC 3339 formatted timestamp.

listItemCount integer Optional

No description available.

minimum: 0
name string Required

No description available.

maxLength: 64 bytesminLength: 1 bytes
purpose ref #listPurpose Required

No description available.

uri string at-uri Required

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

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "creator",
    "name",
    "purpose",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "viewer": {
      "ref": "#listViewerState",
      "type": "ref"
    },
    "creator": {
      "ref": "app.bsky.actor.defs#profileView",
      "type": "ref"
    },
    "purpose": {
      "ref": "#listPurpose",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "description": {
      "type": "string",
      "maxLength": 3000,
      "maxGraphemes": 300
    },
    "listItemCount": {
      "type": "integer",
      "minimum": 0
    },
    "descriptionFacets": {
      "type": "array",
      "items": {
        "ref": "app.bsky.richtext.facet",
        "type": "ref"
      }
    }
  }
}
listViewBasic object

No description available.

Properties

avatar string uri Optional

A valid URI.

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

listItemCount integer Optional

No description available.

minimum: 0
name string Required

No description available.

maxLength: 64 bytesminLength: 1 bytes
purpose ref #listPurpose Required

No description available.

uri string at-uri Required

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

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "name",
    "purpose"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string",
      "maxLength": 64,
      "minLength": 1
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "viewer": {
      "ref": "#listViewerState",
      "type": "ref"
    },
    "purpose": {
      "ref": "#listPurpose",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "listItemCount": {
      "type": "integer",
      "minimum": 0
    }
  }
}
listViewerState object

No description available.

Properties

blocked string at-uri Optional

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

muted boolean Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "muted": {
      "type": "boolean"
    },
    "blocked": {
      "type": "string",
      "format": "at-uri"
    }
  }
}
modlist token

A list of actors to apply an aggregate moderation action (mute/block) on.

Referenceapp.bsky.graph.defs#modlist

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

View raw schema 
{
  "type": "token",
  "description": "A list of actors to apply an aggregate moderation action (mute/block) on."
}
notFoundActor object

indicates that a handle or DID could not be resolved

Properties

actor string at-identifier Required

Either a DID or an AT Protocol handle.

notFound boolean Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "actor",
    "notFound"
  ],
  "properties": {
    "actor": {
      "type": "string",
      "format": "at-identifier"
    },
    "notFound": {
      "type": "boolean",
      "const": true
    }
  },
  "description": "indicates that a handle or DID could not be resolved"
}
referencelist token

A list of actors used for only for reference purposes such as within a starter pack.

Referenceapp.bsky.graph.defs#referencelist

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

View raw schema 
{
  "type": "token",
  "description": "A list of actors used for only for reference purposes such as within a starter pack."
}
relationship object

lists the bi-directional graph relationships between one actor (not indicated in the object), and the target actors (the DID included in the object)

Properties

blockedBy string at-uri Optional

if the actor is blocked by this DID, contains the AT-URI of the block record

blockedByList string at-uri Optional

if the actor is blocked by this DID via a block list, contains the AT-URI of the listblock record

blocking string at-uri Optional

if the actor blocks this DID, this is the AT-URI of the block record

blockingByList string at-uri Optional

if the actor blocks this DID via a block list, this is the AT-URI of the listblock record

did string did Required

A decentralized identifier (DID).

followedBy string at-uri Optional

if the actor is followed by this DID, contains the AT-URI of the follow record

following string at-uri Optional

if the actor follows this DID, this is the AT-URI of the follow record

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    }
  },
  "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)"
}
starterPackView object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

joinedAllTimeCount integer Optional

No description available.

minimum: 0
joinedWeekCount integer Optional

No description available.

minimum: 0
listItemsSample array of ref#listItemView Optional

No description available.

maxLength: 12 items
record unknown Required

No description available.

uri string at-uri Required

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

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "record",
    "creator",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "list": {
      "ref": "#listViewBasic",
      "type": "ref"
    },
    "feeds": {
      "type": "array",
      "items": {
        "ref": "app.bsky.feed.defs#generatorView",
        "type": "ref"
      },
      "maxLength": 3
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "record": {
      "type": "unknown"
    },
    "creator": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "joinedWeekCount": {
      "type": "integer",
      "minimum": 0
    },
    "listItemsSample": {
      "type": "array",
      "items": {
        "ref": "#listItemView",
        "type": "ref"
      },
      "maxLength": 12
    },
    "joinedAllTimeCount": {
      "type": "integer",
      "minimum": 0
    }
  }
}
starterPackViewBasic object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

joinedAllTimeCount integer Optional

No description available.

minimum: 0
joinedWeekCount integer Optional

No description available.

minimum: 0
listItemCount integer Optional

No description available.

minimum: 0
record unknown Required

No description available.

uri string at-uri Required

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

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "record",
    "creator",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "record": {
      "type": "unknown"
    },
    "creator": {
      "ref": "app.bsky.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "listItemCount": {
      "type": "integer",
      "minimum": 0
    },
    "joinedWeekCount": {
      "type": "integer",
      "minimum": 0
    },
    "joinedAllTimeCount": {
      "type": "integer",
      "minimum": 0
    }
  }
}

Lexicon Garden

@