ai.newnal.trustsquare.defs Documentation (EN)

actorProfileView object

No description available.

Properties

actor ref #actorView Required

No description available.

historyVisible boolean Required

No description available.

pdsEndpoint string uri Optional

A valid URI.

stats ref #actorStats Required

No description available.

verification ref #verificationView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "actor",
    "verification",
    "stats",
    "historyVisible"
  ],
  "properties": {
    "actor": {
      "ref": "#actorView",
      "type": "ref"
    },
    "stats": {
      "ref": "#actorStats",
      "type": "ref"
    },
    "pdsEndpoint": {
      "type": "string",
      "format": "uri"
    },
    "verification": {
      "ref": "#verificationView",
      "type": "ref"
    },
    "historyVisible": {
      "type": "boolean"
    }
  }
}

actorStats object

No description available.

Properties

chatMessages integer Required

No description available.

comments integer Required

No description available.

firstSeenAt string datetime Optional

An RFC 3339 formatted timestamp.

likesReceived integer Required

No description available.

squaresCreated integer Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "comments",
    "chatMessages",
    "squaresCreated",
    "likesReceived"
  ],
  "properties": {
    "comments": {
      "type": "integer"
    },
    "firstSeenAt": {
      "type": "string",
      "format": "datetime"
    },
    "chatMessages": {
      "type": "integer"
    },
    "likesReceived": {
      "type": "integer"
    },
    "squaresCreated": {
      "type": "integer"
    }
  }
}

actorView object

No description available.

Properties

affiliation string Optional

No description available.

ageBand string Optional

No description available.

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Required

No description available.

gender string Optional

No description available.

handle string handle Required

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

occupation string Optional

No description available.

realName boolean Optional

No description available.

verificationStatus string Required

No description available.

Known values: active, expired, revoked, invalid, none

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle",
    "displayName",
    "verificationStatus"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "gender": {
      "type": "string"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "ageBand": {
      "type": "string"
    },
    "realName": {
      "type": "boolean"
    },
    "occupation": {
      "type": "string"
    },
    "affiliation": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "verificationStatus": {
      "type": "string",
      "knownValues": [
        "active",
        "expired",
        "revoked",
        "invalid",
        "none"
      ]
    }
  }
}

chatMessageView object

No description available.

Properties

author ref #actorView Required

No description available.

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

hidden boolean Required

No description available.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

squareUri string at-uri Required

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

syncState ref #syncState Required

No description available.

text string 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",
    "author",
    "squareUri",
    "text",
    "hidden",
    "createdAt",
    "indexedAt",
    "syncState"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "text": {
      "type": "string"
    },
    "author": {
      "ref": "#actorView",
      "type": "ref"
    },
    "hidden": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "squareUri": {
      "type": "string",
      "format": "at-uri"
    },
    "syncState": {
      "ref": "#syncState",
      "type": "ref"
    }
  }
}

commentView object

No description available.

Properties

author ref #actorView Required

No description available.

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

deleted boolean Required

Tombstone for a comment the author deleted; text is empty.

dislikeCount integer Required

No description available.

edited boolean Required

No description available.

editedAt string datetime Optional

An RFC 3339 formatted timestamp.

hidden boolean Required

Hidden by the Square creator or an operator. Only returned to the creator or the author.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

likeCount integer Required

No description available.

pinned boolean Required

No description available.

reply ref #replyRef Optional

No description available.

replyCount integer Required

No description available.

squareUri string at-uri Required

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

syncState ref #syncState Required

No description available.

text string Required

No description available.

trustScore string Optional

Debug only; present when the AppView runs with ranking debug enabled.

uri string at-uri Required

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

viewer ref #viewerState Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "squareUri",
    "text",
    "likeCount",
    "dislikeCount",
    "replyCount",
    "edited",
    "hidden",
    "pinned",
    "deleted",
    "createdAt",
    "indexedAt",
    "syncState"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "text": {
      "type": "string"
    },
    "reply": {
      "ref": "#replyRef",
      "type": "ref"
    },
    "author": {
      "ref": "#actorView",
      "type": "ref"
    },
    "edited": {
      "type": "boolean"
    },
    "hidden": {
      "type": "boolean",
      "description": "Hidden by the Square creator or an operator. Only returned to the creator or the author."
    },
    "pinned": {
      "type": "boolean"
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "deleted": {
      "type": "boolean",
      "description": "Tombstone for a comment the author deleted; text is empty."
    },
    "editedAt": {
      "type": "string",
      "format": "datetime"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "likeCount": {
      "type": "integer"
    },
    "squareUri": {
      "type": "string",
      "format": "at-uri"
    },
    "syncState": {
      "ref": "#syncState",
      "type": "ref"
    },
    "replyCount": {
      "type": "integer"
    },
    "trustScore": {
      "type": "string",
      "description": "Debug only; present when the AppView runs with ranking debug enabled."
    },
    "dislikeCount": {
      "type": "integer"
    }
  }
}

commitView object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

data string cid Required

MST root CID.

rev string tid Required

A timestamp-based identifier (TID).

sig string Required

Base64 signature bytes.

View raw schema

{
  "type": "object",
  "required": [
    "cid",
    "rev",
    "sig",
    "data"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "rev": {
      "type": "string",
      "format": "tid"
    },
    "sig": {
      "type": "string",
      "description": "Base64 signature bytes."
    },
    "data": {
      "type": "string",
      "format": "cid",
      "description": "MST root CID."
    }
  }
}

disclosure object

What the account holder chose to reveal, signed by the verifier. `ageBand` and `gender` are derived from the verified identity and are therefore attested; `occupation` and `affiliation` are self-declared. With nothing disclosed, `displayName` is the masked form of the verified name.

Properties

affiliation string Optional

Self-declared.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

ageBand string Optional

Attested: derived from the verified birth date.

Known values: teens, 20s, 30s, 40s, 50s, 60s, 70plus

displayName string Required

The verified name when `realName` is true, otherwise its masked form.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

gender string Optional

Attested: as supplied by the identity provider.

Known values: male, female, other

occupation string Optional

Self-declared.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

realName boolean Required

Whether `displayName` is the full verified name.

View raw schema

{
  "type": "object",
  "required": [
    "displayName",
    "realName"
  ],
  "properties": {
    "gender": {
      "type": "string",
      "description": "Attested: as supplied by the identity provider.",
      "knownValues": [
        "male",
        "female",
        "other"
      ]
    },
    "ageBand": {
      "type": "string",
      "description": "Attested: derived from the verified birth date.",
      "knownValues": [
        "teens",
        "20s",
        "30s",
        "40s",
        "50s",
        "60s",
        "70plus"
      ]
    },
    "realName": {
      "type": "boolean",
      "description": "Whether `displayName` is the full verified name."
    },
    "occupation": {
      "type": "string",
      "maxLength": 1000,
      "description": "Self-declared.",
      "maxGraphemes": 100
    },
    "affiliation": {
      "type": "string",
      "maxLength": 1000,
      "description": "Self-declared.",
      "maxGraphemes": 100
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "description": "The verified name when `realName` is true, otherwise its masked form.",
      "maxGraphemes": 64
    }
  },
  "description": "What the account holder chose to reveal, signed by the verifier. `ageBand` and `gender` are derived from the verified identity and are therefore attested; `occupation` and `affiliation` are self-declared. With nothing disclosed, `displayName` is the masked form of the verified name."
}

historyItem object

No description available.

Properties

chatMessage ref #chatMessageView Optional

No description available.

comment ref #commentView Optional

No description available.

kind string Required

No description available.

Known values: comment, chat

square ref #squareView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "kind",
    "square"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "knownValues": [
        "comment",
        "chat"
      ]
    },
    "square": {
      "ref": "#squareView",
      "type": "ref"
    },
    "comment": {
      "ref": "#commentView",
      "type": "ref"
    },
    "chatMessage": {
      "ref": "#chatMessageView",
      "type": "ref"
    }
  }
}

liveStatus object

No description available.

Properties

endedAt string datetime Optional

An RFC 3339 formatted timestamp.

startedAt string datetime Optional

An RFC 3339 formatted timestamp.

state string Required

No description available.

Known values: none, upcoming, live, ended

View raw schema

{
  "type": "object",
  "required": [
    "state"
  ],
  "properties": {
    "state": {
      "type": "string",
      "knownValues": [
        "none",
        "upcoming",
        "live",
        "ended"
      ]
    },
    "endedAt": {
      "type": "string",
      "format": "datetime"
    },
    "startedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

proofChecks object

No description available.

Properties

cidMatchesIndex boolean Required

No description available.

didDocFresh boolean Required

No description available.

inclusionValid boolean Required

No description available.

signatureValid boolean Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "signatureValid",
    "inclusionValid",
    "cidMatchesIndex",
    "didDocFresh"
  ],
  "properties": {
    "didDocFresh": {
      "type": "boolean"
    },
    "inclusionValid": {
      "type": "boolean"
    },
    "signatureValid": {
      "type": "boolean"
    },
    "cidMatchesIndex": {
      "type": "boolean"
    }
  }
}

proofView object

No description available.

Properties

checkedAt string datetime Required

An RFC 3339 formatted timestamp.

checks ref #proofChecks Required

No description available.

cid string cid Optional

Record CID from the PDS proof; absent when the record no longer exists.

commit ref #commitView Optional

No description available.

did string did Required

A decentralized identifier (DID).

error string Optional

No description available.

indexedCid string cid Optional

A content identifier (CID) referencing immutable data.

pdsEndpoint string uri Required

A valid URI.

record unknown Optional

No description available.

signingKey string Required

did:key of the repository signing key from the DID document.

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",
    "did",
    "pdsEndpoint",
    "signingKey",
    "checks",
    "checkedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "Record CID from the PDS proof; absent when the record no longer exists."
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "error": {
      "type": "string"
    },
    "checks": {
      "ref": "#proofChecks",
      "type": "ref"
    },
    "commit": {
      "ref": "#commitView",
      "type": "ref"
    },
    "record": {
      "type": "unknown"
    },
    "checkedAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedCid": {
      "type": "string",
      "format": "cid"
    },
    "signingKey": {
      "type": "string",
      "description": "did:key of the repository signing key from the DID document."
    },
    "pdsEndpoint": {
      "type": "string",
      "format": "uri"
    }
  }
}

replyRef object

No description available.

Properties

parent ref com.atproto.repo.strongRef Required

No description available.

root ref com.atproto.repo.strongRef Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "root",
    "parent"
  ],
  "properties": {
    "root": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    },
    "parent": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    }
  }
}

socialAccountView object

A social account an actor has linked. `method` is carried through so a reader can tell a mocked claim from an ownership-checked one.

Properties

handle string Required

No description available.

method string Required

No description available.

Known values: mock, oauth, post-proof

platform string Required

No description available.

Known values: youtube, facebook, x, naver

profileUrl string uri Optional

A valid URI.

verifiedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema

{
  "type": "object",
  "required": [
    "platform",
    "handle",
    "method",
    "verifiedAt"
  ],
  "properties": {
    "handle": {
      "type": "string"
    },
    "method": {
      "type": "string",
      "knownValues": [
        "mock",
        "oauth",
        "post-proof"
      ]
    },
    "platform": {
      "type": "string",
      "knownValues": [
        "youtube",
        "facebook",
        "x",
        "naver"
      ]
    },
    "profileUrl": {
      "type": "string",
      "format": "uri"
    },
    "verifiedAt": {
      "type": "string",
      "format": "datetime"
    }
  },
  "description": "A social account an actor has linked. `method` is carried through so a reader can tell a mocked claim from an ownership-checked one."
}

squareSettings object

No description available.

Properties

allowChat boolean Optional

No description available.

allowComments boolean Optional

No description available.

requireRealName boolean Optional

When true, only accounts disclosing their full verified name may write in this Square.

slowModeSeconds integer Optional

No description available.

minimum: 0maximum: 600

View raw schema

{
  "type": "object",
  "properties": {
    "allowChat": {
      "type": "boolean",
      "default": true
    },
    "allowComments": {
      "type": "boolean",
      "default": true
    },
    "requireRealName": {
      "type": "boolean",
      "default": false,
      "description": "When true, only accounts disclosing their full verified name may write in this Square."
    },
    "slowModeSeconds": {
      "type": "integer",
      "default": 3,
      "maximum": 600,
      "minimum": 0
    }
  }
}

squareStats object

No description available.

Properties

chatMessages integer Required

No description available.

comments integer Required

No description available.

participants integer Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "comments",
    "chatMessages",
    "participants"
  ],
  "properties": {
    "comments": {
      "type": "integer"
    },
    "chatMessages": {
      "type": "integer"
    },
    "participants": {
      "type": "integer"
    }
  }
}

squareView object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

creator ref #actorView Required

No description available.

description string Optional

No description available.

id string Required

Short public id used in /s/{id} links.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

liveStatus ref #liveStatus Required

No description available.

mode string Required

No description available.

Known values: vod, live

pinned array of refcom.atproto.repo.strongRef Required

No description available.

settings ref #squareSettings Required

No description available.

stats ref #squareStats Required

No description available.

subject ref #videoMeta Required

No description available.

syncState ref #syncState Required

No description available.

title string Optional

No description available.

uri string at-uri Required

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

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "id",
    "creator",
    "subject",
    "mode",
    "settings",
    "pinned",
    "stats",
    "liveStatus",
    "createdAt",
    "indexedAt",
    "syncState"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Short public id used in /s/{id} links."
    },
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "mode": {
      "type": "string",
      "knownValues": [
        "vod",
        "live"
      ]
    },
    "stats": {
      "ref": "#squareStats",
      "type": "ref"
    },
    "title": {
      "type": "string"
    },
    "pinned": {
      "type": "array",
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      }
    },
    "creator": {
      "ref": "#actorView",
      "type": "ref"
    },
    "subject": {
      "ref": "#videoMeta",
      "type": "ref"
    },
    "settings": {
      "ref": "#squareSettings",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "syncState": {
      "ref": "#syncState",
      "type": "ref"
    },
    "liveStatus": {
      "ref": "#liveStatus",
      "type": "ref"
    },
    "description": {
      "type": "string"
    }
  }
}

syncState string

AppView knowledge about a record: written to PDS but not yet seen on the network, or confirmed from the firehose.

Known Values (other values may be valid)

optimistic confirmed

View raw schema

{
  "type": "string",
  "description": "AppView knowledge about a record: written to PDS but not yet seen on the network, or confirmed from the firehose.",
  "knownValues": [
    "optimistic",
    "confirmed"
  ]
}

threadView object

No description available.

Properties

comment ref #commentView Required

No description available.

hasMoreReplies boolean Required

No description available.

replies array of ref#commentView Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "comment",
    "replies",
    "hasMoreReplies"
  ],
  "properties": {
    "comment": {
      "ref": "#commentView",
      "type": "ref"
    },
    "replies": {
      "type": "array",
      "items": {
        "ref": "#commentView",
        "type": "ref"
      }
    },
    "hasMoreReplies": {
      "type": "boolean"
    }
  }
}

verificationView object

No description available.

Properties

attestationValid boolean Optional

No description available.

cid string cid Optional

A content identifier (CID) referencing immutable data.

disclosure ref #disclosure Optional

No description available.

expiresAt string datetime Optional

An RFC 3339 formatted timestamp.

issuer string did Optional

A decentralized identifier (DID).

provider string Optional

No description available.

status string Required

No description available.

Known values: active, expired, revoked, invalid, none

uri string at-uri Optional

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

verificationId string Optional

No description available.

verifiedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema

{
  "type": "object",
  "required": [
    "status"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "issuer": {
      "type": "string",
      "format": "did"
    },
    "status": {
      "type": "string",
      "knownValues": [
        "active",
        "expired",
        "revoked",
        "invalid",
        "none"
      ]
    },
    "provider": {
      "type": "string"
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime"
    },
    "disclosure": {
      "ref": "#disclosure",
      "type": "ref"
    },
    "verifiedAt": {
      "type": "string",
      "format": "datetime"
    },
    "verificationId": {
      "type": "string"
    },
    "attestationValid": {
      "type": "boolean"
    }
  }
}

videoMeta object

No description available.

Properties

channelHandle string Optional

The channel's YouTube handle including its leading @, when the channel has one.

channelId string Optional

No description available.

channelTitle string Optional

No description available.

thumbnailUrl string uri Optional

A valid URI.

title string Optional

No description available.

url string uri Required

A valid URI.

videoId string Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "videoId",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "videoId": {
      "type": "string"
    },
    "channelId": {
      "type": "string"
    },
    "channelTitle": {
      "type": "string"
    },
    "thumbnailUrl": {
      "type": "string",
      "format": "uri"
    },
    "channelHandle": {
      "type": "string",
      "description": "The channel's YouTube handle including its leading @, when the channel has one."
    }
  }
}

viewerState object

No description available.

Properties

reaction string Optional

No description available.

Known values: like, dislike

reactionUri string at-uri Optional

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

View raw schema

{
  "type": "object",
  "properties": {
    "reaction": {
      "type": "string",
      "knownValues": [
        "like",
        "dislike"
      ]
    },
    "reactionUri": {
      "type": "string",
      "format": "at-uri"
    }
  }
}

youtubeVideo object

A YouTube video or live stream that a Square is attached to.

Properties

channelId string Optional

No description available.

maxLength: 64 bytes

url string uri Required

Canonical https://www.youtube.com/watch?v=... URL.

videoId string Required

YouTube video id.

maxLength: 16 bytesminLength: 11 bytes

View raw schema

{
  "type": "object",
  "required": [
    "videoId",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Canonical https://www.youtube.com/watch?v=... URL."
    },
    "videoId": {
      "type": "string",
      "maxLength": 16,
      "minLength": 11,
      "description": "YouTube video id."
    },
    "channelId": {
      "type": "string",
      "maxLength": 64
    }
  },
  "description": "A YouTube video or live stream that a Square is attached to."
}