town.delve.graph.defs

delve.town

Documentation

curatelist token

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

Referencetown.delve.graph.defs#curatelist

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

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

No description available.

Properties

subjectOptedOut boolean Optional

Set to true when the subject has opted out of appearing in the reference list. Only set when the viewer owns the list.

uri string at-uri Required

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

View raw schema 
{
  "properties": {
    "subject": {
      "ref": "town.delve.actor.defs#profileView",
      "type": "ref"
    },
    "subjectOptedOut": {
      "const": true,
      "description": "Set to true when the subject has opted out of appearing in the reference list. Only set when the viewer owns the list.",
      "type": "boolean"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "subject"
  ],
  "type": "object"
}
listPurpose string

No description available.

Known Values (other values may be valid)
town.delve.graph.defs#modlist(token) town.delve.graph.defs#curatelist(token) town.delve.graph.defs#referencelist(token)
View raw schema 
{
  "knownValues": [
    "town.delve.graph.defs#modlist",
    "town.delve.graph.defs#curatelist",
    "town.delve.graph.defs#referencelist"
  ],
  "type": "string"
}
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 
{
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "creator": {
      "ref": "town.delve.actor.defs#profileView",
      "type": "ref"
    },
    "description": {
      "maxGraphemes": 300,
      "maxLength": 3000,
      "type": "string"
    },
    "descriptionFacets": {
      "items": {
        "ref": "town.delve.richtext.facet",
        "type": "ref"
      },
      "type": "array"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "listItemCount": {
      "minimum": 0,
      "type": "integer"
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "purpose": {
      "ref": "#listPurpose",
      "type": "ref"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "viewer": {
      "ref": "#listViewerState",
      "type": "ref"
    }
  },
  "required": [
    "uri",
    "cid",
    "creator",
    "name",
    "purpose",
    "indexedAt"
  ],
  "type": "object"
}
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 
{
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "listItemCount": {
      "minimum": 0,
      "type": "integer"
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "purpose": {
      "ref": "#listPurpose",
      "type": "ref"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "viewer": {
      "ref": "#listViewerState",
      "type": "ref"
    }
  },
  "required": [
    "uri",
    "cid",
    "name",
    "purpose"
  ],
  "type": "object"
}
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.

referenceListOptOut string at-uri Optional

The authenticated viewer's app.bsky.graph.referencelistoptout record URI for this reference list. Only set for reference lists. A client can delete this record to undo the opt-out.

View raw schema 
{
  "properties": {
    "blocked": {
      "format": "at-uri",
      "type": "string"
    },
    "muted": {
      "type": "boolean"
    },
    "referenceListOptOut": {
      "description": "The authenticated viewer's app.bsky.graph.referencelistoptout record URI for this reference list. Only set for reference lists. A client can delete this record to undo the opt-out.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "type": "object"
}
modlist token

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

Referencetown.delve.graph.defs#modlist

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

View raw schema 
{
  "description": "A list of actors to apply an aggregate moderation action (mute/block) on.",
  "type": "token"
}
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 
{
  "description": "indicates that a handle or DID could not be resolved",
  "properties": {
    "actor": {
      "format": "at-identifier",
      "type": "string"
    },
    "notFound": {
      "const": true,
      "type": "boolean"
    }
  },
  "required": [
    "actor",
    "notFound"
  ],
  "type": "object"
}
referencelist token

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

Referencetown.delve.graph.defs#referencelist

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

View raw schema 
{
  "description": "A list of actors used for only for reference purposes such as within a starter pack.",
  "type": "token"
}
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 
{
  "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)",
  "properties": {
    "blockedBy": {
      "description": "if the actor is blocked by this DID, contains the AT-URI of the block record",
      "format": "at-uri",
      "type": "string"
    },
    "blockedByList": {
      "description": "if the actor is blocked by this DID via a block list, contains the AT-URI of the listblock record",
      "format": "at-uri",
      "type": "string"
    },
    "blocking": {
      "description": "if the actor blocks this DID, this is the AT-URI of the block record",
      "format": "at-uri",
      "type": "string"
    },
    "blockingByList": {
      "description": "if the actor blocks this DID via a block list, this is the AT-URI of the listblock record",
      "format": "at-uri",
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "followedBy": {
      "description": "if the actor is followed by this DID, contains the AT-URI of the follow record",
      "format": "at-uri",
      "type": "string"
    },
    "following": {
      "description": "if the actor follows this DID, this is the AT-URI of the follow record",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "did"
  ],
  "type": "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 
{
  "properties": {
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "creator": {
      "ref": "town.delve.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "feeds": {
      "items": {
        "ref": "town.delve.feed.defs#generatorView",
        "type": "ref"
      },
      "maxLength": 3,
      "type": "array"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "joinedAllTimeCount": {
      "minimum": 0,
      "type": "integer"
    },
    "joinedWeekCount": {
      "minimum": 0,
      "type": "integer"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "list": {
      "ref": "#listViewBasic",
      "type": "ref"
    },
    "listItemsSample": {
      "items": {
        "ref": "#listItemView",
        "type": "ref"
      },
      "maxLength": 12,
      "type": "array"
    },
    "record": {
      "type": "unknown"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "record",
    "creator",
    "indexedAt"
  ],
  "type": "object"
}
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 
{
  "properties": {
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "creator": {
      "ref": "town.delve.actor.defs#profileViewBasic",
      "type": "ref"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "joinedAllTimeCount": {
      "minimum": 0,
      "type": "integer"
    },
    "joinedWeekCount": {
      "minimum": 0,
      "type": "integer"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "listItemCount": {
      "minimum": 0,
      "type": "integer"
    },
    "record": {
      "type": "unknown"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "record",
    "creator",
    "indexedAt"
  ],
  "type": "object"
}

Lexicon Garden

@