通过

Bluesky Social （独立出版商） （预览版）

Bluesky Social 终结点的规范。 包括用于社交交互、管理员、聊天、ATProto 和臭氧的终结点。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name Dan Romano
Email dan.romano@swolcat.com
连接器元数据
发布者 krautrocker
网站 https://docs.bsky.app/
隐私策略 https://example.com/privacy-policy
类别 社交媒体

Bluesky API 连接器

  • **此自定义连接器允许 Power Platform 应用与 Bluesky 的 API 交互，支持管理源、对话、通知、视频上传和帐户数据的作。

出版商：丹·罗曼诺

先决条件

  • **若要使用此连接器，需要：

    • **Bluesky 帐户。
    • **使用应用密码访问 Bluesky 的 API。

支持的作

  • **此连接器包括以下作：

源终结点

  • **GET /app.bsky.feed.getTimeline 检索用户的日程表帖子。
  • **GET /app.bsky.feed.getFeed 从特定源或标记检索帖子。
  • **GET /app.bsky.feed.searchPosts 搜索与查询匹配的帖子。
  • **GET /app.bsky.feed.getActorFeeds 检索由特定执行组件发布的源。
  • **GET /app.bsky.feed.getActorLikes 检索特定参与者喜欢的帖子。
  • **GET /app.bsky.feed.getAuthorFeed 从特定作者的源检索帖子。
  • **GET /app.bsky.feed.getFeedGenerator 检索为用户生成的源。
  • **GET /app.bsky.feed.getFeedGenerators 检索有关所有源生成器的元数据。
  • **GET /app.bsky.feed.getFeedSkeleton 检索源的最小主干版本。
  • **GET /app.bsky.feed.getListFeed 从特定列表中检索帖子。
  • **GET /app.bsky.feed.getPosts 按 ID 检索特定文章的列表。
  • **GET /app.bsky.feed.getPostThread 检索与特定文章相关的文章的线程。
  • **GET /app.bsky.feed.getLikes 检索喜欢特定帖子的用户。
  • **GET /app.bsky.feed.getQuotes 检索引用特定文章的文章。
  • **GET /app.bsky.feed.getRepostedBy 检索重新发布特定帖子的用户。
  • **GET /app.bsky.feed.getSuggestedFeeds 检索用户的建议源。
  • **POST /app.bsky.feed.sendInteractions 发送帖子的交互（如或重新发布）。

执行组件终结点

  • **GET /app.bsky.actor.getPreferences 检索用户的首选项。
  • **GET /app.bsky.actor.getProfile 检索特定用户的配置文件。
  • **GET /app.bsky.actor.getProfiles 检索多个用户配置文件。
  • **GET /app.bsky.actor.getSuggestions 检索用户的帐户建议。
  • **POST /app.bsky.actor.putPreferences Update the user'spreferences.
  • **GET /app.bsky.actor.searchActors 按查询搜索用户帐户。
  • **GET /app.bsky.actor.searchActorsTypeahead 检索用户帐户的搜索建议。

图形终结点

  • **GET /app.bsky.graph.getActorStarterPacks 检索新用户的帐户初学者包。
  • **GET /app.bsky.graph.getKnownFollowers 获取经过身份验证的用户已知的关注者。
  • **GET /app.bsky.graph.getFollowers 检索用户关注者列表。
  • **GET /app.bsky.graph.getFollows 检索用户后跟特定用户。
  • **GET /app.bsky.graph.getBlocks 检索被经过身份验证的用户阻止的用户。
  • **GET /app.bsky.graph.getList 检索特定用户列表。
  • **GET /app.bsky.graph.getLists 检索经过身份验证的用户的所有列表。
  • **GET /app.bsky.graph.getListBlocks 检索在特定列表中阻止的用户。
  • **GET /app.bsky.graph.getListMutes 检索经过身份验证的用户的静音列表。
  • **GET /app.bsky.graph.getMutes 检索静音用户。
  • **GET /app.bsky.graph.getRelationships 检索经过身份验证的用户和指定帐户之间的关系。
  • **GET /app.bsky.graph.getStarterPack 检索新用户的单个初学者包。
  • **GET /app.bsky.graph.getStarterPacks 检索新用户的所有初学者包。
  • **GET /app.bsky.graph.getSuggestedFollowsByActor 检索建议的帐户，由执行组件筛选。
  • **POST /app.bsky.graph.muteActor 将特定执行组件静音。
  • **POST /app.bsky.graph.unmuteActor Unmute a specific actor.
  • **POST /app.bsky.graph.muteActorList 将特定执行组件列表设为静音。
  • **POST /app.bsky.graph.unmuteActorList 取消静音特定执行组件列表。
  • **POST /app.bsky.graph.muteThread 将整个帖子线程设为静音。
  • **POST /app.bsky.graph.unmuteThread 取消静音整个帖子线程。

标记器终结点

  • **GET /app.bsky.labeler.getServices 检索可供用户使用的标签器服务列表。

通知终结点

  • **GET /app.bsky.notification.getUnreadCount 检索未读通知计数。
  • **GET /app.bsky.notification.listNotifications List notifications List notifications for the authenticated user.
  • **POST /app.bsky.notification.putPreferences Update 通知首选项。
  • **POST /app.bsky.notification.registerPush Register for push notifications.
  • **POST /app.bsky.notification.updateSeen Mark 通知，如下所示。

视频终结点

  • **GET /app.bsky.video.getJobStatus 检索视频上传作业的状态。
  • **GET /app.bsky.video.getUploadLimits 检索用户的视频上传限制。
  • **POST /app.bsky.video.uploadVideo 上传视频文件。

chat.bsky 端点

  • **DELETE /chat.bsky.actor.deleteAccount 永久删除执行组件的帐户和相关数据。
  • **GET /chat.bsky.actor.exportAccountData 导出特定执行组件的帐户数据。
  • **DELETE /chat.bsky.convo.deleteMessageForSelf 仅从用户视图中删除消息。
  • **GET /chat.bsky.convo.getConvo 检索特定对话。
  • **GET /chat.bsky.convo.getConvoForMembers 获取特定成员之间的对话。
  • **GET /chat.bsky.convo.getLog 检索聊天日志。
  • **GET /chat.bsky.convo.getMessages 检索对话中的消息。
  • **POST /chat.bsky.convo.leaveConvo 离开对话。
  • **GET /chat.bsky.convo.listConvos 列出用户的所有对话。
  • **POST /chat.bsky.convo.muteConvo 将通知设为对话静音。
  • **POST /chat.bsky.convo.sendMessage 在对话中发送消息。
  • **POST /chat.bsky.convo.sendMessageBatch 在批处理中发送多个消息。
  • **POST /chat.bsky.convo.unmuteConvo Unmute Notifications for a conversation.
  • **POST /chat.bsky.convo.updateRead 将对话标记为已读。
  • **GET /chat.bsky.moderation.getActorMetadata 检索与执行组件的审查状态关联的元数据。
  • **GET /chat.bsky.moderation.getMessageContext 检索消息审查的上下文。
  • **POST /chat.bsky.moderation.updateActorAccess Update access permissions for a specified actor.

com.atproto.admin 端点

  • **DELETE /com.atproto.admin.deleteAccount 永久删除帐户。
  • **POST /com.atproto.admin.disableAccountInvites 禁用帐户的邀请。
  • **POST /com.atproto.admin.disableInviteCodes 禁用邀请代码。
  • **POST /com.atproto.admin.enableAccountInvites 为帐户启用邀请。
  • **GET /com.atproto.admin.getAccountInfo 获取有关特定帐户的信息。
  • **GET /com.atproto.admin.getAccountInfos 检索有关多个帐户的信息。
  • **GET /com.atproto.admin.getInviteCodes 检索帐户的邀请代码。
  • **GET /com.atproto.admin.getSubjectStatus 检索主题的状态信息。
  • **GET /com.atproto.admin.searchAccounts 搜索帐户。
  • **POST /com.atproto.admin.sendEmail 向帐户发送电子邮件。
  • **POST /com.atproto.admin.updateAccountEmail 更新与帐户关联的电子邮件地址。
  • **POST /com.atproto.admin.updateAccountHandle 更新与帐户关联的句柄。
  • **POST /com.atproto.admin.updateAccountPassword 更新帐户的密码。
  • **POST /com.atproto.admin.updateSubjectStatus 更新主题的状态。

com.atproto.identity 端点

  • **GET /com.atproto.identity.getRecommendedDidCredentials 检索推荐的 DID 凭据。
  • **POST /com.atproto.identity.requestPlcOperationSignature 请求 PLC作的签名。
  • **GET /com.atproto.identity.resolveHandle 解析帐户句柄。
  • **POST /com.atproto.identity.signPlcOperation 签名 PLC作。
  • **POST /com.atproto.identity.submitPlcOperation Submit a PLC operation.
  • **POST /com.atproto.identity.updateHandle 更新标识的句柄。

com.atproto.label 端点

  • **GET /com.atproto.label.queryLabels 查询内容或执行组件的查询标签。

com.atproto.moderation 端点

  • **POST /com.atproto.moderation.createReport 创建报表进行审核。
  • **GET /com.atproto.moderation.getActorMetadata 检索元数据以进行审查。

com.atproto.repo 端点

  • **POST /com.atproto.repo.applyWrites 将写入应用于存储库。
  • **POST /com.atproto.repo.createRecord 在存储库中创建记录。
  • **DELETE /com.atproto.repo.deleteRecord 从存储库中删除记录。
  • **GET /com.atproto.repo.describeRepo 描述存储库。
  • **GET /com.atproto.repo.getRecord 按 ID 检索记录。
  • **POST /com.atproto.repo.importRepo 将数据导入存储库。
  • **GET /com.atproto.repo.listMissingBlobs List 缺少 blob。
  • **GET /com.atproto.repo.listRecords 列出存储库中的所有记录。
  • **POST /com.atproto.repo.putRecord 更新存储库中的记录。
  • **POST /com.atproto.repo.uploadBlob 将二进制 blob 上传到存储库。

com.atproto.server 端点

  • **POST /com.atproto.server.activateAccount 激活帐户。
  • **GET /com.atproto.server.checkAccountStatus 检查帐户状态。
  • **POST /com.atproto.server.confirmEmail 确认电子邮件地址。
  • **POST /com.atproto.server.createAccount 创建一个新帐户。
  • **POST /com.atproto.server.createAppPassword 创建特定于应用的密码。
  • **POST /com.atproto.server.createInviteCode 创建单个邀请代码。
  • **POST /com.atproto.server.createInviteCodes 创建多个邀请代码。
  • **POST /com.atproto.server.createSession 创建会话。
  • **POST /com.atproto.server.deactivateAccount 停用帐户。
  • **DELETE /com.atproto.server.deleteAccount 永久删除帐户。
  • **DELETE /com.atproto.server.deleteSession 删除会话。
  • **GET /com.atproto.server.describeServer 描述服务器信息。
  • **GET /com.atproto.server.getAccountInviteCodes 检索帐户的邀请代码。
  • **GET /com.atproto.server.getServiceAuth 检索服务身份验证信息。
  • **GET /com.atproto.server.getSession 检索会话信息。
  • **GET /com.atproto.server.listAppPasswords 列出特定于应用的密码。
  • **POST /com.atproto.server.refreshSession 刷新会话。
  • **POST /com.atproto.server.requestAccountDelete 请求删除帐户。
  • **POST /com.atproto.server.requestEmailConfirmation 请求电子邮件确认。
  • **POST /com.atproto.server.requestEmailUpdate 请求电子邮件更新。
  • **POST /com.atproto.server.requestPasswordReset 请求密码重置。
  • **POST /com.atproto.server.reserveSigningKey 保留签名密钥。
  • **POST /com.atproto.server.resetPassword 重置密码。
  • **POST /com.atproto.server.revokeAppPassword 撤销特定于应用的密码。
  • **POST /com.atproto.server.updateEmail 更新与帐户关联的电子邮件。

com.atproto.sync 端点

  • **GET /com.atproto.sync.getBlob 按 ID 检索 blob。
  • **GET /com.atproto.sync.getBlocks 按 ID 检索块。
  • **GET /com.atproto.sync.getLatestCommit 获取最新提交。
  • **GET /com.atproto.sync.getRecord 检索用于同步的记录。
  • **GET /com.atproto.sync.getRepo 检索要同步的存储库数据。
  • **GET /com.atproto.sync.getRepoStatus 检索存储库状态。
  • **GET /com.atproto.sync.listBlobs 列出存储库中的 blob。
  • **GET /com.atproto.sync.listRepos List 存储库进行同步。
  • **POST /com.atproto.sync.notifyOfUpdate 通知系统中的更新。
  • **POST /com.atproto.sync.requestCrawl 请求对同步进行爬网。

tools.ozone.communication 端点

  • **POST /tools.臭氧.communication.createTemplate 创建通信模板。
  • **DELETE /tools.ozone.communication.deleteTemplate 删除通信模板。
  • **GET /tools.ozone.communication.listTemplates List 通信模板。
  • **POST /tools.臭氧.communication.updateTemplate 更新通信模板。

tools.ozone.moderation 端点

  • **POST /tools.ozone.moderation.emitEvent 发出审查事件。
  • **GET /tools.ozone.moderation.getEvent 检索特定的审查事件。
  • **GET /tools.ozone.moderation.getRecord 检索审查记录。
  • **GET /tools.ozone.moderation.getRecords List 审查记录。
  • **GET /tools.ozone.moderation.getRepo 检索存储库的审查信息。
  • **GET /tools.ozone.moderation.getRepos 检索多个存储库的审查数据。
  • **GET /tools.ozone.moderation.queryEvents 查询审查事件。
  • **GET /tools.ozone.moderation.queryStatuses 查询审查状态。
  • **POST /tools.ozone.moderation.searchRepos 搜索存储库进行审查。

tools.ozone.server 端点

  • **GET /tools.ozone.server.getConfig 检索服务器配置信息。

tools.ozone.set 端点

  • **POST /tools.ozone.set.addValues 向集添加值。
  • **DELETE /tools.ozone.set.deleteSet Delete a specified set.
  • **DELETE /tools.ozone.set.deleteValues 从集中删除特定值。
  • **GET /tools.ozone.set.getValues 从集中检索值。
  • **GET /tools.ozone.set.querySets 查询集基于筛选器。
  • **POST /tools.ozone.set.upsertSet 创建或更新集。

tools.ozone.signature 端点

  • **GET /tools.ozone.signature.findCorrelation 查找与签名相关的关联。
  • **GET /tools.ozone.signature.findRelatedAccounts 查找与签名相关的帐户。
  • **GET /tools.ozone.signature.searchAccounts 按签名搜索帐户。

tools.ozone.team 端点

  • **POST /tools.ozone.team.addMember 向团队添加成员。
  • **DELETE /tools.ozone.team.deleteMember 从团队中删除成员。
  • **GET /tools.ozone.team.listMembers 列出团队中的成员。
  • **POST /tools.ozone.team.updateMember Update 团队成员信息。

未指定的终结点

  • **POST /app.bsky.unspecced.uploadBlob 将二进制 Blob 上传到用户帐户。
  • **GET /app.bsky.unspecced.getBlob 从用户帐户检索二进制 Blob。

获取凭据

  • 转到 Bluesky 开发人员门户。
  • 在“帐户设置”下生成应用密码。
  • 保存应用密码，以便在连接器设置中使用。

入门

  • **某些终结点需要特定参数（例如执行组件/用户 ID），例如。

    • **身份验证：首先使用 Bluesky 凭据进行身份验证。
    • **选择终结点：选择所需的终结点，例如检索源或列出通知。
    • **设置参数：提供所需的参数，例如用户 ID、限制或查询字符串。
    • **执行请求：运行请求以检索数据或在 Power Platform 应用中执行作。

已知问题和限制

常见问题解答

  • 问：如何生成应用密码？
    答：访问 Bluesky 开发人员门户 并生成新的应用密码。 使用密码生成令牌。

  • 问：API 速率限制是什么？
    答：Bluesky 为每个帐户每分钟施加 100 个请求的速率限制。

  • 问：什么是有用的术语和定义，例如执行组件或 DID？
    一个： 要了解的有用术语：

    • 演员： 与系统交互的实体（通常是用户）。 这可以代表人员、组织或自动化系统。
    • 初学者包： 一组精选的建议帐户或内容，旨在帮助新用户开始使用该平台。
    • 签名： 用于验证系统中事务或作的真实性和完整性的加密证明。
    • PLC（个人链接链）： 一种类似于区块链的结构，用于维护帐户作的可验证历史记录（例如处理更新、密钥轮换）。 它确保透明度和可信度。
    • DID （分散标识符）： 未绑定到集中式注册表的执行组件的全局唯一标识符。 DID 是蓝斯基分散性质的基础。

Support

  • **dan.romano@swolcat.com 或 torin@imp.sh （原始所有者）

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

GetRecommendedDidCredentials

描述应包含在要迁移到此服务的帐户的 DID 文档中的凭据。
RequestPlcOperationSignature

请求包含代码的电子邮件，以请求已签名的 PLC作。
ResolveHandle

将句柄（域名）解析为 DID。
Search Actors for Typeahead

检索 typeahead 搜索的帐户建议。
SignPlcOperation

签署 PLC作以更新请求的 DID 文档中的某些值。
SubmitPlcOperation

验证 PLC作，以确保它不会违反服务的约束。
UpdateHandle

更新当前帐户的句柄。 如有必要，验证处理有效性和更新 did：plc 文档。
上传新 Blob

上传新的 Blob。
上传视频

上传要处理并存储在 PDS 上的视频。
下载存储库导出

下载存储库导出为 CAR 文件。
从存储库获取单个记录

从存储库获取单个记录。
从存储库获取数据块

按 CID 从给定存储库获取数据块。
从存储库获取记录

通过其唯一标识符从存储库中检索记录。
从臭氧团队中删除成员

从臭氧团队中删除成员。
从集中删除值

从特定集中删除值。
以 CAR 文件的形式导入存储库

以 CAR 文件的形式导入存储库。 需要 Content-Length 标头。
保留签名密钥

保留存储库签名密钥以用于帐户创建。
停用帐户

完成迁移后停用当前处于活动状态的帐户。
列出与主题相关的审查事件

列出与主题相关的审查事件。
列出存储库

枚举所有存储库的所有 DID、rev 和提交 CID
列出存储库中的记录

列出存储库中与特定集合匹配的记录范围。
列出对话

列出对话。
列出帐户 Blob CID

列出存储库修订以来的帐户 Blob ID。
列出应用密码

列出所有应用密码。
列出所有有权访问臭氧服务的成员

列出所有有权访问臭氧服务的成员。
列出请求帐户缺少的 blob

返回请求帐户缺少的 blob 的列表。
列出通知

枚举请求帐户的通知。
创建单个新存储库记录

创建单个新存储库记录。
创建可重用的通信模板

用于创建新的可重用 comm. 模板的管理员作。
创建帐户

使用提供的详细信息创建帐户。
创建应用密码

创建应用密码。
创建或更新集元数据

创建或更新集元数据。
创建报告

提交有关 atproto 帐户或记录的审查报告。 通过审查服务（使用 PDS 代理）实现，需要身份验证。
创建身份验证会话

创建身份验证会话
创建邀请代码

为指定的用例创建邀请代码。
创建邀请代码

创建具有指定使用限制的多个邀请代码。
删除会话

删除当前会话。
删除存储库记录或确保它不存在

删除存储库记录，或确保它不存在。
删除帐户

以管理员身份删除用户帐户。
删除帐户

使用令牌和密码删除执行组件帐户。
删除帐户

删除帐户。
删除自有消息

删除发送消息的用户的消息。
删除通信模板

按其唯一 ID 删除通信模板。
删除集

删除整个集。
刷新身份验证会话

刷新身份验证会话以获取新的访问令牌和刷新令牌。
发送交互

发送有关交互的信息。
发送批处理消息

将一批消息发送到多个对话。
发送消息

将单个消息发送到特定对话。
取消静音对话

取消静音对话。
取消静音执行组件

取消静音指定的帐户。
取消静音执行组件列表

取消指定的帐户列表。
取消静音线程

取消指定线程的静音。
向用户帐户电子邮件地址发送电子邮件

向用户帐户电子邮件地址发送电子邮件。
向集添加值

将值添加到特定集。
启用帐户邀请

重新启用帐户接收邀请代码的功能。
基于搜索词查找存储库

根据搜索词查找存储库。
对执行组件执行审核作

对执行组件执行审核作
对请求帐户的未读通知数进行计数

对请求帐户的未读通知数进行计数。
导出帐户数据

导出帐户数据。
将对话设为静音

将对话设为静音。
将线程设为静音

将线程设为静音，防止来自该线程及其任何子级的通知。
应用存储库写入

应用存储库的批处理事务来创建、更新和删除。
描述服务器

描述服务器的帐户创建要求和功能。
搜索帐户

获取与搜索查询匹配的帐户列表。
搜索帖子

查找与搜索条件匹配的帖子，并返回这些文章的视图。
撤销应用密码

按名称撤销应用密码。
更新主题状态

更新主题的服务特定管理员状态。
更新对话读取状态

更新对话中的项目以将其标记为已读。
更新帐户句柄

用于更新帐户句柄的管理作。
更新帐户密码

以管理员身份更新用户帐户的密码。
更新帐户电子邮件

更新帐户电子邮件的管理作。
更新执行组件访问

更新执行组件的访问权限。
更新现有通信模板

更新现有通信模板的管理作。
更新电子邮件

更新帐户的电子邮件。
更新臭氧服务中的成员

更新臭氧服务中的成员。
更新通知

通知爬网服务最近的更新，并且爬网应恢复。
查找与提供的 AT-URI 模式相关的标签

查找与提供的 AT-URI 模式相关的标签。
查找匹配搜索条件的执行组件（配置文件）

查找匹配搜索条件的执行组件（配置文件）。
查找威胁签名的相关

查找 2 个或多个帐户之间的所有相关威胁签名。
查找相关帐户

获取与根帐户共享某些匹配威胁签名的帐户。
查看主题的审查状态

查看主题（记录或存储库）的审查状态。
查询可用集

查询可用集。
检查帐户状态

返回帐户的状态，尤其是与导入或恢复相关的状态。
检索记录视图

返回记录视图的动态架构信息。
注册以接收推送通知

注册以接收推送通知。
添加团队成员

将成员添加到臭氧团队。
激活帐户

激活当前停用的帐户。
确认电子邮件

使用 requestEmailConfirmation 过程生成的令牌确认电子邮件。
禁用邀请代码

禁用特定的邀请代码以防止进一步使用。
离开对话

通过指定对话 ID 来保留对话。
编写存储库记录

根据需要编写存储库记录，创建或更新它。
获取 Convo for Members

获取一个或多个成员的对话。
获取一个帐户之间的公共关系，以及其他帐户的列表

获取一个帐户与其他帐户的列表之间的公共关系。
获取与帐户关联的 Blob

获取与给定帐户关联的 Blob。
获取个人资料

使用执行组件句柄或 DID 检索执行组件的详细配置文件视图。
获取作者源

获取执行组件的“作者源”的视图。
获取入门包

根据提供的引用（AT-URI）获取初学者包的视图。
获取关注

枚举指定执行组件所遵循的帐户。
获取关注者

枚举遵循指定执行组件的帐户。
获取列表

枚举由指定帐户创建的列表。
获取列表源

从列表中获取最近发布的文章源。
获取列表视图

获取指定列表的“视图”（具有其他上下文）。
获取初学者包

获取基于提供的 URI 的初学者包列表的详细视图。
获取参与者喜欢的帖子列表

获取参与者喜欢的帖子列表。
获取存储库托管状态

在此服务器上获取存储库的托管状态。
获取存储库的当前提交

获取指定存储库的当前提交 CID 和修订。
获取审查存储库

获取所有审查存储库的列表。
获取对话

根据提供的对话 ID 获取对话。
获取已知关注者

检索特定帐户的追随者，该帐户后跟查看器。
获取帐户信息

获取有关帐户的详细信息。
获取帐户信息

获取有关某些帐户的详细信息。
获取帐户邀请代码

获取当前帐户的所有邀请代码。
获取帖子

获取指定文章列表的帖子视图。
获取帖子线程

获取线程中的帖子。
获取建议的参与者

获取建议的参与者的列表。
获取建议的后跟执行组件

枚举类似于给定帐户。
获取建议的源

检索请求帐户的建议源列表。
获取当前会话信息

获取有关经过身份验证的会话的信息。
获取执行组件元数据

通过 DID 为执行组件提取与审查相关的元数据
获取执行组件源

获取执行组件创建的源列表。
获取报价

获取给定文章的报价列表。
获取日志

检索会话中作和消息的日志。
获取时间线

获取请求帐户的主时间线的视图。
获取有关存储库的详细信息

获取有关存储库的详细信息。
获取有关审核事件的详细信息

获取有关审核事件的详细信息。
获取有关帐户和存储库的信息

获取有关帐户和存储库的信息，包括集合列表。
获取有关某些记录的详细信息

获取有关某些记录的详细信息。
获取有关标签器服务列表的信息

获取有关标签器服务列表的信息。
获取有关源的信息

获取有关源生成器的信息。
获取有关记录的详细信息

获取有关记录的详细信息。
获取服务器配置

获取有关臭氧的服务器配置的详细信息。
获取服务身份验证令牌

代表请求的服务的 DID 获取已签名的令牌。
获取消息

从特定对话获取邮件列表。
获取消息上下文

从对话中提取周围消息
获取源

从参与者选择的源生成器中获取水化源。
获取源框架

获取源生成器提供的源的框架。
获取源生成器信息

获取有关源生成器的信息。
获取源生成器信息

获取有关源生成器列表的信息。
获取由执行组件创建的初学者包列表

获取由执行组件创建的初学者包的列表。
获取经过身份验证的用户的视频上传限制

获取经过身份验证的用户的视频上传限制。
获取视频处理作业的状态详细信息

获取视频处理作业的状态详细信息。
获取设置值

获取特定集及其值。
获取赞

获取引用主题的记录（按 AT-URI 和 CID）。
获取通信模板列表

检索所有可用通信模板的列表。
获取邀请代码

获取邀请代码的管理员视图。
获取配置文件

获取多个执行组件的详细配置文件视图。
获取重新发布者

获取给定帖子的转帖列表。
获取阻止列表

获取请求帐户（执行组件）正在阻止的模式列表。
获取静音

枚举请求帐户当前已静音的帐户。
获取静音列表

获取请求帐户当前已静音的模式列表。
获取首选项

获取附加到当前帐户的专用首选项。
设置帐户首选项

设置附加到帐户的专用首选项。
设置通知首选项

为帐户设置与通知相关的首选项。
请求删除帐户

通过电子邮件启动用户帐户删除。
请求密码重置

通过电子邮件启动用户帐户密码重置。
请求爬网

请求服务永久爬网托管存储库。
请求电子邮件更新

请求令牌以更新电子邮件。
请求电子邮件确认

请求包含代码的电子邮件，以确认电子邮件的所有权。
通知服务器请求帐户已看到通知

通知服务器请求帐户已看到通知。
重置密码

使用令牌重置用户帐户密码。
静音执行组件

为指定的帐户创建静音关系。
静音执行组件列表

为指定的帐户列表创建静音关系。

GetRecommendedDidCredentials

操作 ID:
GetRecommendedDidCredentials

描述应包含在要迁移到此服务的帐户的 DID 文档中的凭据。

返回

名称 路径 类型 说明
rotationKeys
 rotationKeys array of string
alsoKnownAs
 alsoKnownAs array of string
verificationMethods
 verificationMethods object
services
 services object

RequestPlcOperationSignature

操作 ID:
RequestPlcOperationSignature

请求包含代码的电子邮件，以请求已签名的 PLC作。

返回

名称 路径 类型 说明
success
 success boolean

指示请求是否成功。

ResolveHandle

操作 ID:
ResolveHandle

将句柄（域名）解析为 DID。

参数

名称 密钥 必需 类型 说明
要解析的句柄。
 handle True string

要解析的句柄。

返回

名称 路径 类型 说明
did
 did string

已解决的 DID。

Search Actors for Typeahead

操作 ID:
SearchActorsTypeahead

检索 typeahead 搜索的帐户建议。

参数

名称 密钥 必需 类型 说明
搜索词
 q string

用于类型头结果的搜索词。
限度
 limit integer

要检索的最大结果数。

返回

名称 路径 类型 说明
演员
 actors array of appProfileViewBasic

与 typeahead 搜索匹配的最小执行组件详细信息的数组。

SignPlcOperation

操作 ID:
SignPlcOperation

签署 PLC作以更新请求的 DID 文档中的某些值。

参数

名称 密钥 必需 类型 说明
代币
 token True string

通过 com.atproto.identity.requestPlcOperationSignature 接收的令牌。
rotationKeys
 rotationKeys array of string
alsoKnownAs
 alsoKnownAs array of string
verificationMethods
 verificationMethods object
services
 services object

返回

名称 路径 类型 说明
操作
 operation object

SubmitPlcOperation

操作 ID:
SubmitPlcOperation

验证 PLC作，以确保它不会违反服务的约束。

参数

名称 密钥 必需 类型 说明
操作
 operation True object

要验证的 PLC作。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否已成功验证。

UpdateHandle

操作 ID:
UpdateHandle

更新当前帐户的句柄。 如有必要，验证处理有效性和更新 did：plc 文档。

参数

名称 密钥 必需 类型 说明
句柄
 handle True string

新句柄。

返回

名称 路径 类型 说明
success
 success boolean

指示句柄是否已成功更新。
消息
 message string

有关作的其他信息。

上传新 Blob

操作 ID:
UploadBlob

上传新的 Blob。

参数

名称 密钥 必需 类型 说明
要上传的文件
 file True file

要上传的 Blob 文件。

返回

名称 路径 类型 说明
blob
 blob string

上传的 Blob ID。

上传视频

操作 ID:
UploadVideo

上传要处理并存储在 PDS 上的视频。

参数

名称 密钥 必需 类型 说明
视频文件
 file True file

要上传和处理的二进制视频文件。

返回

此操作输出是动态内容。

下载存储库导出

操作 ID:
SyncGetRepo

下载存储库导出为 CAR 文件。

参数

名称 密钥 必需 类型 说明
存储库 DID
 did True string

存储库的 DID。
Revision
 since string

要从中创建差异的存储库的修订（'rev'）。

返回

response
binary

从存储库获取单个记录

操作 ID:
RepoGetRecord

从存储库获取单个记录。

参数

名称 密钥 必需 类型 说明
存储库的句柄或 DID
 repo True string

存储库的句柄或 DID。
记录集合的 NSID
 collection True string

记录集合的 NSID。
记录键
 rkey True string

记录键。
记录版本的 CID
 cid string

记录版本的 CID。

返回

名称 路径 类型 说明
uri
 uri string

记录的 URI。
cid
 cid string

记录的 CID。
value
 value object

记录的值。

从存储库获取数据块

操作 ID:
GetBlocks

按 CID 从给定存储库获取数据块。

参数

名称 密钥 必需 类型 说明
存储库 DID
 did True string

存储库的 DID。
阻止 CID
 cids True array

要提取的块的 CID。

返回

名称 路径 类型 说明
块
 blocks array of string

提取的块列表。

从存储库获取记录

操作 ID:
SyncGetRecord

通过其唯一标识符从存储库中检索记录。

参数

名称 密钥 必需 类型 说明
记录 ID
 did True string

记录的唯一标识符。

返回

名称 路径 类型 说明
id
 record.id string

记录的唯一标识符。
内容
 record.content string

记录的内容。

从臭氧团队中删除成员

操作 ID:
DeleteMemberTeam

从臭氧团队中删除成员。

参数

名称 密钥 必需 类型 说明
did
 did True string

成员的 DID。

从集中删除值

操作 ID:
DeleteValues

从特定集中删除值。

参数

名称 密钥 必需 类型 说明
姓名
 name True string

要从中删除值的集的名称。
values
 values True array of string

以 CAR 文件的形式导入存储库

操作 ID:
ImportRepo

以 CAR 文件的形式导入存储库。 需要 Content-Length 标头。

参数

名称 密钥 必需 类型 说明
CAR 文件详细信息
 body True string

要导入的 CAR 文件。

返回

名称 路径 类型 说明
消息
 message string

指示已导入存储库的成功消息。
repoId
 repoId string

导入的存储库的唯一标识符。

保留签名密钥

操作 ID:
ReserveSigningKey

保留存储库签名密钥以用于帐户创建。

参数

名称 密钥 必需 类型 说明
did
 did string

用于保留签名密钥的分散标识符（DID）。

返回

名称 路径 类型 说明
签名密钥
 signingKey string

保留签名密钥的公钥。

停用帐户

操作 ID:
DeactivateAccount

完成迁移后停用当前处于活动状态的帐户。

参数

名称 密钥 必需 类型 说明
deleteAfter
 deleteAfter date-time

保留已停用帐户的时间范围。

列出与主题相关的审查事件

操作 ID:
QueryEvents

列出与主题相关的审查事件。

参数

名称 密钥 必需 类型 说明
用于筛选的事件类型
 types array

要筛选的事件类型：defs#modEvent<名称>
创建者
 createdBy string

由用户创建
排序方式
 sortDirection string

事件排序方向。
在时间戳之后创建的事件
 createdAfter date-time

检索在给定时间戳之后创建的事件。
在时间戳之前创建的事件
 createdBefore date-time

检索在给定时间戳之前创建的事件。
Subject
 subject string

Subject
事件集合
 collections array

返回主题属于给定集合的事件。
主题类型
 subjectType string

返回主题为帐户或记录的事件。
返回所有类型的事件
 includeAllUserRecords boolean

从给定的“collections”参数返回所有记录类型的事件。
限度
 limit integer

限度
有评论，是/否
 hasComment boolean

如果为 true，则仅返回带注释的事件。
注释
 comment string

返回包含关键字的注释的事件。
Addedl 标签
 addedLabels array

返回添加所有这些标签的事件。
带已删除标签的事件
 removedLabels array

返回删除标签的事件。
已删除的标签
 addedTags array

返回删除标签的事件。
已删除标记
 removedTags array

返回删除标记的事件。
报表类型
 reportTypes array

审查事件的报表类型
分页游标
 cursor string

分页游标

返回

名称 路径 类型 说明
游标
 cursor string
events
 events array of modEventView

列出存储库

操作 ID:
ListRepos

枚举所有存储库的所有 DID、rev 和提交 CID

参数

名称 密钥 必需 类型 说明
结果限制
 limit integer

要返回的最大结果数。
Cursor
 cursor string

下一组结果的分页游标。

返回

名称 路径 类型 说明
游标
 cursor string
repos
 repos array of listRepos.repo

列出存储库中的记录

操作 ID:
ListRecords

列出存储库中与特定集合匹配的记录范围。

参数

名称 密钥 必需 类型 说明
存储库标识符
 repo True string

存储库的句柄或 DID。
集合类型
 collection True string

记录类型的 NSID。
限制结果
 limit integer

要返回的记录数。
分页游标
 cursor string

用于分页结果的游标。
反向顺序
 reverse boolean

标志以反转返回的记录的顺序。

返回

名称 路径 类型 说明
游标
 cursor string

结果的下一页的分页游标。
记录
 records array of listRecords.record

列出对话

操作 ID:
ListConvos

列出对话。

参数

名称 密钥 必需 类型 说明
分页限制
 limit integer

要返回的最大会话数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

名称 路径 类型 说明
游标
 cursor string

分页的游标。
车队
 convos array of object
id
 convos.id string

会话的唯一标识符。
转速
 convos.rev string

会话的修订标识符。
成员
 convos.members array of chatProfileViewBasic

对话中的成员列表。
lastMessage
 convos.lastMessage lastMessage

表示对话中的最后一条消息。
温和
 convos.muted boolean

指示对话是否已静音。
打开
 convos.opened boolean

指示是否已打开对话。
unreadCount
 convos.unreadCount integer

会话中未读消息的计数。

列出帐户 Blob CID

操作 ID:
ListBlobs

列出存储库修订以来的帐户 Blob ID。

参数

名称 密钥 必需 类型 说明
存储库 DID
 did True string

存储库的 DID。
Revision
 since string

自那以后列出 Blob 的存储库的可选修订。
结果限制
 limit integer

要返回的最大结果数。
Cursor
 cursor string

下一组结果的分页游标。

返回

名称 路径 类型 说明
游标
 cursor string
cids
 cids array of string

列出应用密码

操作 ID:
ServerListAppPasswords

列出所有应用密码。

返回

名称 路径 类型 说明
密码
 passwords array of listAppPassword

列出所有有权访问臭氧服务的成员

操作 ID:
ListMembersTeam

列出所有有权访问臭氧服务的成员。

参数

名称 密钥 必需 类型 说明
限制结果
 limit integer

要返回的最大结果数。
分页游标
 cursor string

用于分页结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

结果的下一页的分页游标。
成员
 members array of member

列出请求帐户缺少的 blob

操作 ID:
ListMissingBlobs

返回请求帐户缺少的 blob 的列表。

参数

名称 密钥 必需 类型 说明
限制结果
 limit integer

要返回的最大结果数。
分页游标
 cursor string

用于分页结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

结果的下一页的分页游标。
blobs
 blobs array of listMissingBlobs.recordBlob

列出通知

操作 ID:
ListNotifications

枚举请求帐户的通知。

参数

名称 密钥 必需 类型 说明
限度
 limit integer

要返回的最大通知数。
Priority
 priority boolean

按优先级状态筛选通知。
Cursor
 cursor string

用于检索下一组通知的分页游标。
看到在
 seenAt date-time

筛选在指定日期时间或之后看到的通知。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的分页游标。
notifications
 notifications array of notification

通知列表。
priority
 priority boolean

指示是否包含优先级通知。
seenAt
 seenAt date-time

指示上次看到通知的时间的时间戳。

创建单个新存储库记录

操作 ID:
CreateRecord

创建单个新存储库记录。

参数

名称 密钥 必需 类型 说明
存储库
 repo True string

存储库的句柄或 DID（即当前帐户）。
收藏
 collection True string

记录集合的 NSID。
rkey
 rkey string

记录键。
验证
 validate boolean

为跳过 Lexicon 架构验证设置的 True 或 false 值。
记录
 record True object

记录对象。
swapCommit
 swapCommit string

比较和交换 CID 之前的提交。

返回

名称 路径 类型 说明
uri
 uri string

创建的记录的 URI。
cid
 cid string

创建的记录的 CID。
提交
 commit commitMeta
validationStatus
 validationStatus string

创建可重用的通信模板

操作 ID:
CreateTemplate

用于创建新的可重用 comm. 模板的管理员作。

参数

名称 密钥 必需 类型 说明
姓名
 name True string

模板的名称。
contentMarkdown
 contentMarkdown True string

模板的内容（支持 markdown）可以包含变量占位符。
主题
 subject True string

电子邮件中使用的邮件主题。
lang
 lang string

消息语言。
createdBy
 createdBy string

正在创建模板的用户的 DID。

返回

Body
templateView

创建帐户

操作 ID:
CreateAccount

使用提供的详细信息创建帐户。

参数

名称 密钥 必需 类型 说明
电子邮件
 email string

帐户的电子邮件地址。
句柄
 handle True string

请求帐户的句柄。
did
 did string

预先存在的 atproto DID，正在导入到新帐户。
inviteCode
 inviteCode string

邀请用于创建帐户的代码。
verificationCode
 verificationCode string

用于验证电子邮件或电话的代码。
verificationPhone
 verificationPhone string

帐户验证的电话号码。
密码
 password string

初始帐户密码。 可能需要满足特定于实例的密码强度要求。
recoveryKey
 recoveryKey string

将包含在 PLC 创建作中的 DID PLC 轮换密钥（恢复密钥）。
plcOp
 plcOp object

可选的 PLC作数据。

返回

名称 路径 类型 说明
accessJwt
 accessJwt string

访问 JWT 令牌进行身份验证。
refreshJwt
 refreshJwt string

刷新 JWT 令牌进行会话续订。
句柄
 handle string

新帐户的句柄。
did
 did string

新帐户的 DID。
didDoc
 didDoc object

与新帐户关联的 DID 文档。

创建应用密码

操作 ID:
ServerCreateAppPassword

创建应用密码。

参数

名称 密钥 必需 类型 说明
姓名
 name True string

应用密码的短名称，可帮助区分它们。
特权
 privileged boolean

如果应用密码具有对可能敏感的帐户状态的“特权”访问权限。 用于受信任的客户端。

返回

Body
createAppPassword

创建或更新集元数据

操作 ID:
UpsertSet

创建或更新集元数据。

参数

名称 密钥 必需 类型 说明
姓名
 name True string
描述
 description string

返回

Body
setView

创建报告

操作 ID:
CreateReport

提交有关 atproto 帐户或记录的审查报告。 通过审查服务（使用 PDS 代理）实现，需要身份验证。

参数

名称 密钥 必需 类型 说明
reasonSpam
 reasonSpam string

垃圾邮件：频繁的不需要的促销、回复、提及
reasonViolation
 reasonViolation string

直接违反服务器规则、法律、服务条款
reasonMisleading
 reasonMisleading string

误导性标识、附属关系或内容
reasonSexual
 reasonSexual string

不需要或错误标记的性内容
reasonRude
 reasonRude string

粗鲁、骚扰、显式或其他不令人不安的行为
reasonOther
 reasonOther string

其他：报表未属于另一个报表类别
reasonAppeal
 reasonAppeal string

上诉：上诉之前采取适度行动
原因
 reason string

有关内容和冲突的其他上下文。
did
 did True string
uri
 uri True string

强引用的 URI。
cid
 cid True string

强引用的 CID。

返回

名称 路径 类型 说明
id
 id integer

报表的唯一标识符。
reasonType
 reasonType reasonType

审查报告的原因类型。 预定义原因之一。
原因
 reason string

有关内容和冲突的其他上下文。
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

使用 URI 和 CID 定义强引用。
reportedBy
 reportedBy string

提交报告的用户的 DID。
createdAt
 createdAt date-time

创建报表时的时间戳。

创建身份验证会话

操作 ID:
CreateSession

创建身份验证会话

参数

名称 密钥 必需 类型 说明
Host
 pdshost True string

Bluesky 主机
用户名
 identifier True string

句柄或其他标识符
密码
 password True string

身份验证用户的密码
身份验证因素令牌
 authFactorToken string

多重身份验证的可选令牌

返回

名称 路径 类型 说明
accessJwt
 accessJwt string

JWT 访问令牌。
refreshJwt
 refreshJwt string

JWT 刷新令牌。
句柄
 handle string

用户的句柄。
did
 did string

用户的分散标识符（DID）。
didDoc
 didDoc object

可选 DID 文档。
电子邮件
 email string

用户的电子邮件地址
emailConfirmed
 emailConfirmed boolean

指示是否确认电子邮件。
emailAuthFactor
 emailAuthFactor boolean

指示电子邮件是否用于身份验证。
活跃
 active boolean

指示会话是否处于活动状态。
状态
 status string

用户帐户的状态。

创建邀请代码

操作 ID:
CreateInviteCode

为指定的用例创建邀请代码。

参数

名称 密钥 必需 类型 说明
useCount
 useCount True integer

可以使用邀请代码的次数。
forAccount
 forAccount string

要为其生成邀请代码的帐户的 DID。

返回

名称 路径 类型 说明
代码
 code string

生成的邀请代码。

创建邀请代码

操作 ID:
CreateInviteCodes

创建具有指定使用限制的多个邀请代码。

参数

名称 密钥 必需 类型 说明
codeCount
 codeCount True integer

要生成的邀请代码数。
useCount
 useCount True integer

可以使用每个邀请代码的次数。
forAccounts
 forAccounts array of string

邀请代码所针对的帐户的 DID 数组。

返回

名称 路径 类型 说明
codes
 codes array of object

生成的邀请代码。
帐户
 codes.account string

与邀请代码关联的帐户的 DID。
代码
 codes.code string

生成的邀请代码。

删除会话

操作 ID:
ServerDeleteSession

删除当前会话。

删除存储库记录或确保它不存在

操作 ID:
DeleteRecord

删除存储库记录，或确保它不存在。

参数

名称 密钥 必需 类型 说明
存储库
 repo True string

存储库的句柄或 DID（即当前帐户）。
收藏
 collection True string

记录集合的 NSID。
rkey
 rkey True string

记录键。
swapRecord
 swapRecord string

按 CID 比较和交换上一条记录。
swapCommit
 swapCommit string

比较和交换 CID 之前的提交。

返回

名称 路径 类型 说明
提交
 commit commitMeta

删除帐户

操作 ID:
AdminDeleteAccount

以管理员身份删除用户帐户。

参数

名称 密钥 必需 类型 说明
分散式标识符 （DID）
 did True string

返回

名称 路径 类型 说明
success
 success boolean

指示帐户是否已成功删除。
消息
 message string

详细说明结果的可选消息。

删除帐户

操作 ID:
ServerDeleteAccount

使用令牌和密码删除执行组件帐户。

参数

名称 密钥 必需 类型 说明
did
 did True string

要删除的帐户的分散标识符（DID）。
密码
 password True string

帐户的密码。
代币
 token True string

与帐户关联的令牌。

返回

名称 路径 类型 说明
success
 success boolean

指示帐户删除是否成功。
消息
 message string

可选成功消息。

删除帐户

操作 ID:
ActorDeleteAccount

删除帐户。

删除自有消息

操作 ID:
DeleteMessageForSelf

删除发送消息的用户的消息。

参数

名称 密钥 必需 类型 说明
convoId
 convoId True string

包含要删除的消息的会话的 ID。
消息ID
 messageId True string

要删除的消息的 ID。

返回

Body
deletedMessageView

删除通信模板

操作 ID:
DeleteTemplate

按其唯一 ID 删除通信模板。

参数

名称 密钥 必需 类型 说明
id
 id True string

要删除的模板的唯一标识符。

删除集

操作 ID:
DeleteSet

删除整个集。

参数

名称 密钥 必需 类型 说明
姓名
 name True string

要删除的集的名称

刷新身份验证会话

操作 ID:
RefreshSession

刷新身份验证会话以获取新的访问令牌和刷新令牌。

参数

名称 密钥 必需 类型 说明
refreshJwt
 refreshJwt True string

会话创建期间提供的刷新令牌

返回

名称 路径 类型 说明
accessJwt
 accessJwt string

JWT 访问令牌。
refreshJwt
 refreshJwt string

JWT 刷新令牌。
句柄
 handle string

用户的句柄。
did
 did string

分散式标识符（DID）。
didDoc
 didDoc object

可选 DID 文档。
活跃
 active boolean

指示会话是否处于活动状态。
状态
 status string

帐户的托管状态。

发送交互

操作 ID:
SendInteractions

发送有关交互的信息。

参数

名称 密钥 必需 类型 说明
项
 item string
事件
 event string
feedContext
 feedContext string

最初由 getFeedSkeleton 上的源生成器提供的源项的上下文。

发送批处理消息

操作 ID:
SendMessageBatch

将一批消息发送到多个对话。

参数

名称 密钥 必需 类型 说明
convoId
 convoId True string
文本消息
 text True string
byteStart
 byteStart True integer

范围的起始字节。
byteEnd
 byteEnd True integer

范围的结束字节。
featureType
 featureType string

功能的类型。
details
 details object

有关该功能的详细信息。
uri
 uri True string

强引用的 URI。
cid
 cid True string

强引用的 CID。

返回

此操作输出是动态内容。

发送消息

操作 ID:
SendMessage

将单个消息发送到特定对话。

参数

名称 密钥 必需 类型 说明
convoId
 convoId True string

会话的 ID。
文本消息
 text True string
byteStart
 byteStart True integer

范围的起始字节。
byteEnd
 byteEnd True integer

范围的结束字节。
featureType
 featureType string

功能的类型。
details
 details object

有关该功能的详细信息。
uri
 uri True string

强引用的 URI。
cid
 cid True string

强引用的 CID。

返回

此操作输出是动态内容。

取消静音对话

操作 ID:
UnmuteConvo

取消静音对话。

参数

名称 密钥 必需 类型 说明
convoId
 convoId True string

要取消静音的对话的 ID。

返回

名称 路径 类型 说明
对话视图
 convo convoView

表示会话的视图。

取消静音执行组件

操作 ID:
UnmuteActor

取消静音指定的帐户。

参数

名称 密钥 必需 类型 说明
执行组件 ID
 actor True string

要取消静音的执行组件的标识符（AT-identifier）。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。

取消静音执行组件列表

操作 ID:
UnmuteActorList

取消指定的帐户列表。

参数

名称 密钥 必需 类型 说明
列表 URI
 list True string

要取消静音的列表的 URI。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。

取消静音线程

操作 ID:
UnmuteThread

取消指定线程的静音。

参数

名称 密钥 必需 类型 说明
根线程 URI
 root True string

要取消静音的根线程的 URI。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。

向用户帐户电子邮件地址发送电子邮件

操作 ID:
SendEmail

向用户帐户电子邮件地址发送电子邮件。

参数

名称 密钥 必需 类型 说明
收件人 DID
 recipientDid True string

接收者的分散标识符（DID）。
Content
 content True string

电子邮件的内容。
Subject
 subject string

电子邮件的主题。
发件人 DID
 senderDid True string

发送方的 DID。
其他注释
 comment string

发件人不会在电子邮件本身中使用的其他注释。

返回

名称 路径 类型 说明
送
 sent boolean

指示电子邮件是否已成功发送。

向集添加值

操作 ID:
AddValuesToSet

将值添加到特定集。

参数

名称 密钥 必需 类型 说明
姓名
 name True string

要向其添加值的集的名称
values
 values True array of string

要添加到集的值

启用帐户邀请

操作 ID:
AdminEnableAccountInvites

重新启用帐户接收邀请代码的功能。

参数

名称 密钥 必需 类型 说明
帐户标识符
 account True string

正在为其启用邀请的帐户/DID。
启用原因
 note string

启用邀请的可选原因。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。
消息
 message string

详细说明结果的可选消息。

基于搜索词查找存储库

操作 ID:
SearchReposModeration

根据搜索词查找存储库。

参数

名称 密钥 必需 类型 说明
搜索词
 q string

用于查找存储库的搜索词。
限制结果
 limit integer

要返回的最大结果数。
分页游标
 cursor string

用于分页结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

结果的下一页的分页游标。
repos
 repos array of repoView

对执行组件执行审核作

操作 ID:
EmitEvent

对执行组件执行审核作

参数

名称 密钥 必需 类型 说明
事件
 event True string

要发出的审查事件。
主题
 subject True string

审查事件的主题。
subjectBlobCids
 subjectBlobCids array of string
createdBy
 createdBy True string

返回

Body
modEventView

对请求帐户的未读通知数进行计数

操作 ID:
GetUnreadCount

对请求帐户的未读通知数进行计数。

参数

名称 密钥 必需 类型 说明
Priority
 priority boolean

指定是否只应对高优先级通知进行计数。
在
 seenAt date-time

统计在提供的时间戳之后看到的通知。

返回

名称 路径 类型 说明
计数
 count integer

未读通知的数量。

导出帐户数据

操作 ID:
ActorExportAccountData

导出帐户数据。

返回

response
file

将对话设为静音

操作 ID:
MuteConvo

将对话设为静音。

参数

名称 密钥 必需 类型 说明
convoId
 convoId True string

要静音的对话的 ID。

返回

名称 路径 类型 说明
对话视图
 convo convoView

表示会话的视图。

将线程设为静音

操作 ID:
MuteThread

将线程设为静音，防止来自该线程及其任何子级的通知。

参数

名称 密钥 必需 类型 说明
根 URI
 root True string

要静音的线程根目录的 URI 引用。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。

应用存储库写入

操作 ID:
ApplyWrites

应用存储库的批处理事务来创建、更新和删除。

返回

名称 路径 类型 说明
提交
 commit commitMeta
results
 results array of applyWrites.result

描述服务器

操作 ID:
ServerDescribeServer

描述服务器的帐户创建要求和功能。

返回

名称 路径 类型 说明
inviteCodeRequired
 inviteCodeRequired boolean

如果为 true，则必须提供邀请代码才能在此实例上创建帐户。
phoneVerificationRequired
 phoneVerificationRequired boolean

如果为 true，则必须提供电话验证令牌才能在此实例上创建帐户。
availableUserDomains
 availableUserDomains array of string
链接
 links describeServerLinks
联系
 contact describeServerContact
did
 did string

服务器的分散标识符（DID）。

搜索帐户

操作 ID:
AdminSearchAccounts

获取与搜索查询匹配的帐户列表。

参数

名称 密钥 必需 类型 说明
要搜索的电子邮件地址。
 email string

要搜索的电子邮件地址。
下一个结果的分页游标。
 cursor string

下一组结果的分页游标。
要检索的最大结果数。
 limit integer

要检索的最大结果数

返回

名称 路径 类型 说明
游标
 cursor string

用于检索下一组结果的游标。
accounts
 accounts array of accountView

匹配帐户的列表。

搜索帖子

操作 ID:
SearchPosts

查找与搜索条件匹配的帖子，并返回这些文章的视图。

参数

名称 密钥 必需 类型 说明
搜索查询
 q True string

搜索查询字符串。
排序方式
 sort string

指定结果的排名顺序。
自 Datetime 起
 since string

筛选指定日期/时间后帖子的结果（含）。
直到日期/时间
 until string

在指示的日期/时间（不包括）之前筛选帖子的结果。
提及帐户
 mentions string

筛选为提及给定帐户的帖子。
作者帐户
 author string

按给定帐户筛选为帖子。 句柄在查询时间之前解析为 DID。
语言筛选器
 lang string

筛选为给定语言中的帖子。
域筛选器
 domain string

筛选为包含 URL 的帖子。
URL 筛选器
 url string

筛选为包含链接的帖子。
哈希标记筛选器
 tag array

筛选为具有给定标记（井号标签）的帖子。
结果限制
 limit integer

要返回的最大结果数。
分页游标
 cursor string

可选的分页机制。

返回

名称 路径 类型 说明
游标
 cursor string
hitsTotal
 hitsTotal integer
公告
 posts array of postView

撤销应用密码

操作 ID:
ServerRevokeAppPassword

按名称撤销应用密码。

参数

名称 密钥 必需 类型 说明
姓名
 name True string

要撤销的应用密码的名称。

更新主题状态

操作 ID:
UpdateSubjectStatus

更新主题的服务特定管理员状态。

参数

名称 密钥 必需 类型 说明
did
 did True string
uri
 uri True string

强引用的 URI。
cid
 cid True string

强引用的 CID。
did
 did True string
cid
 cid True string
recordUri
 recordUri string
应用的
 applied True boolean
ref
 ref string
应用的
 applied True boolean
ref
 ref string

返回

名称 路径 类型 说明
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

使用 URI 和 CID 定义强引用。
repoBlobRef
 subject.repoBlobRef repoBlobRef
takedown
 takedown statusAttr

更新对话读取状态

操作 ID:
UpdateRead

更新对话中的项目以将其标记为已读。

参数

名称 密钥 必需 类型 说明
convoId
 convoId True string

会话的 ID。
消息ID
 messageId string

要标记为已读的消息的 ID。

返回

名称 路径 类型 说明
对话视图
 convo convoView

表示会话的视图。

更新帐户句柄

操作 ID:
UpdateAccountHandle

用于更新帐户句柄的管理作。

参数

名称 密钥 必需 类型 说明
did
 did True string

帐户的 DID。
句柄
 handle True string

帐户的新句柄。

返回

名称 路径 类型 说明
success
 success boolean

指示更新是否成功。
消息
 message string

提供其他信息的可选消息。

更新帐户密码

操作 ID:
UpdateAccountPassword

以管理员身份更新用户帐户的密码。

参数

名称 密钥 必需 类型 说明
did
 did True string

要更新的帐户的 DID。
密码
 password True string

帐户的新密码。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。
消息
 message string

有关作结果的其他详细信息。

更新帐户电子邮件

操作 ID:
UpdateAccountEmail

更新帐户电子邮件的管理作。

参数

名称 密钥 必需 类型 说明
帐户
 account True string

存储库的句柄或 DID。
电子邮件
 email True string

帐户的新电子邮件地址。

返回

名称 路径 类型 说明
success
 success boolean

指示更新是否成功。
消息
 message string

提供其他信息的可选消息。

更新执行组件访问

操作 ID:
UpdateActorAccess

更新执行组件的访问权限。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string
允许访问
 allowAccess True boolean
引用 ID
 ref string

返回

名称 路径 类型 说明
success
 success boolean

指示访问更新是否成功。
消息
 message string

详细说明结果的可选消息。

更新现有通信模板

操作 ID:
UpdateTemplate

更新现有通信模板的管理作。

参数

名称 密钥 必需 类型 说明
id
 id True string

要更新的模板的 ID。
姓名
 name string

模板的名称。
lang
 lang string

消息语言。
contentMarkdown
 contentMarkdown string

模板的内容（支持 markdown）可以包含变量占位符。
主题
 subject string

电子邮件中使用的邮件主题。
updatedBy （更新者）
 updatedBy string

正在更新模板的用户的 DID。
禁用的
 disabled boolean

模板是否已禁用。

返回

Body
templateView

更新电子邮件

操作 ID:
ServerUpdateEmail

更新帐户的电子邮件。

参数

名称 密钥 必需 类型 说明
电子邮件
 email True string

要更新帐户的新电子邮件地址。
emailAuthFactor
 emailAuthFactor boolean

电子邮件是否用作身份验证因素。
代币
 token string

如果已确认帐户的电子邮件，则来自 requestEmailUpdate 的令牌。

更新臭氧服务中的成员

操作 ID:
UpdateMemberTeam

更新臭氧服务中的成员。

参数

名称 密钥 必需 类型 说明
did
 did True string

成员的 DID。
禁用的
 disabled boolean

指示成员是否已禁用。
角色
 role string

分配给成员的角色。

返回

Body
member

更新通知

操作 ID:
NotifyOfUpdate

通知爬网服务最近的更新，并且爬网应恢复。

参数

名称 密钥 必需 类型 说明
主机名
 hostname True string

通知更新的当前服务的主机名。

查找与提供的 AT-URI 模式相关的标签

操作 ID:
QueryLabels

查找与提供的 AT-URI 模式相关的标签。

参数

名称 密钥 必需 类型 说明
要匹配的 AT URI 模式列表
 uriPatterns True array

要匹配的 AT URI 模式列表（布尔“OR”）。
要筛选的 DID
 sources array

要筛选的标签源（DID）的可选列表。
限度
 limit integer

要返回的最大标签数。
分页游标
 cursor string

分页的游标。

返回

名称 路径 类型 说明
游标
 cursor string

分页的游标。
labels
 labels array of label

查找匹配搜索条件的执行组件（配置文件）

操作 ID:
SearchActors

查找匹配搜索条件的执行组件（配置文件）。

参数

名称 密钥 必需 类型 说明
搜索查询
 q string

搜索查询字符串。 语法、短语、布尔和分面未指定，但建议使用 Lucene 查询语法。
结果限制
 limit integer

要返回的最大执行组件数。
分页游标
 cursor string

用于分页的游标以提取下一组结果。

返回

名称 路径 类型 说明
游标
 cursor string

分页的游标。
演员
 actors array of profileView

匹配执行组件配置文件的列表。

查找威胁签名的相关

操作 ID:
FindCorrelation

查找 2 个或多个帐户之间的所有相关威胁签名。

参数

名称 密钥 必需 类型 说明
帐户 DID
 dids True array

用于查找相关签名的帐户的 DID 列表。

返回

名称 路径 类型 说明
details
 details array of sigDetail

查找相关帐户

操作 ID:
FindRelatedAccounts

获取与根帐户共享某些匹配威胁签名的帐户。

参数

名称 密钥 必需 类型 说明
帐户 DID
 did True string

根帐户的 DID。
分页游标
 cursor string

下一组结果的分页游标。
结果限制
 limit integer

要返回的最大结果数。

返回

名称 路径 类型 说明
游标
 cursor string
accounts
 accounts array of findRelatedAccounts.relatedAccount

查看主题的审查状态

操作 ID:
QueryStatusesModeration

查看主题（记录或存储库）的审查状态。

参数

名称 密钥 必需 类型 说明
包括所有用户记录
 includeAllUserRecords boolean

返回属于指定帐户的“collections”参数中的主题或主题。
使用者 URI
 subject string

获取其状态的主题。
Comment 关键字
 comment string

按批注中的关键字搜索主题。
时间戳后报告
 reportedAfter date-time

搜索主题在给定时间戳后报告。
在时间戳之前报告
 reportedBefore date-time

搜索主题在给定时间戳之前报告。
在时间戳后查看
 reviewedAfter date-time

在给定时间戳之后查看的搜索主题。
在时间戳之前查看
 reviewedBefore date-time

在给定时间戳之前审阅的搜索主题。
在时间戳后托管已删除
 hostingDeletedAfter date-time

搜索在时间戳后删除关联记录/帐户的主题。
在时间戳之前托管已删除
 hostingDeletedBefore date-time

搜索在时间戳之前删除关联的记录/帐户的主题。
在时间戳后托管已更新
 hostingUpdatedAfter date-time

搜索在时间戳后更新关联记录/帐户的主题。
在时间戳之前托管已更新
 hostingUpdatedBefore date-time

搜索在时间戳之前更新关联记录/帐户的主题。
托管状态
 hostingStatuses array

按关联记录/帐户的状态搜索主题。
包括静音主题
 includeMuted boolean

默认情况下，我们不会在结果中包含静音主题。
审阅状态
 reviewState string

指定何时提取处于特定状态的主题。
限制结果
 limit integer

要返回的最大结果数。

返回

名称 路径 类型 说明
游标
 cursor string

结果的下一页的分页游标。
subjectStatuses
 subjectStatuses array of subjectStatusView

查询可用集

操作 ID:
QuerySets

查询可用集。

参数

名称 密钥 必需 类型 说明
结果限制
 limit integer

要返回的最大集数。
分页游标
 cursor string

分页的游标。
名称前缀
 namePrefix string

按名称前缀筛选集。
按字段排序
 sortBy string

要按其排序结果的字段。
排序方向
 sortDirection string

排序方向，默认为名称字段的升序。

返回

名称 路径 类型 说明
sets
 sets array of setView
游标
 cursor string

检查帐户状态

操作 ID:
CheckAccountStatus

返回帐户的状态，尤其是与导入或恢复相关的状态。

返回

名称 路径 类型 说明
激活
 activated boolean

指示帐户是否已激活。
validDid
 validDid boolean

指示 DID 是否有效。
repoCommit
 repoCommit string

帐户存储库的提交标识符。
repoRev
 repoRev string

存储库修订信息。
repoBlocks
 repoBlocks integer

存储库块数。
indexedRecords
 indexedRecords integer

帐户中的索引记录数。
privateStateValues
 privateStateValues integer

私有状态值的数目。
expectedBlobs
 expectedBlobs integer

预期 blob 数。
importedBlobs
 importedBlobs integer

导入的 Blob 数。

检索记录视图

操作 ID:
EmbedRecordView

返回记录视图的动态架构信息。

参数

名称 密钥 必需 类型 说明
记录 ID
 recordId True string

记录的标识符。

返回

名称 路径 类型 说明
记录
 record object

记录视图的详细信息。

注册以接收推送通知

操作 ID:
RegisterPush

注册以接收推送通知。

参数

名称 密钥 必需 类型 说明
serviceDid
 serviceDid True string

推送通知服务的 DID。
代币
 token True string

推送通知令牌。
平台
 platform True string

推送通知的平台。
应用程序ID
 appId True string

请求推送通知的应用的标识符。

返回

名称 路径 类型 说明
success
 success boolean

指示注册是否成功。

添加团队成员

操作 ID:
AddTeamMember

将成员添加到臭氧团队。

参数

名称 密钥 必需 类型 说明
did
 did True string

要添加的成员的 DID。
角色
 role True string

要添加的成员的角色。

返回

Body
member

激活帐户

操作 ID:
ActivateAccount

激活当前停用的帐户。

确认电子邮件

操作 ID:
ConfirmEmail

使用 requestEmailConfirmation 过程生成的令牌确认电子邮件。

参数

名称 密钥 必需 类型 说明
电子邮件
 email True string

要确认的电子邮件地址。
代币
 token True string

发送给用户电子邮件的确认令牌。

禁用邀请代码

操作 ID:
DisableInviteCodes

禁用特定的邀请代码以防止进一步使用。

参数

名称 密钥 必需 类型 说明
inviteCodes
 inviteCodes array of string

要禁用的邀请代码列表。

返回

名称 路径 类型 说明
success
 success boolean

指示作成功。

离开对话

操作 ID:
LeaveConvo

通过指定对话 ID 来保留对话。

参数

名称 密钥 必需 类型 说明
convoId
 convoId True string

要离开的对话的 ID。

返回

名称 路径 类型 说明
convoId
 convoId string

留下的对话的 ID。
转速
 rev string

会话的修订标识符。

编写存储库记录

操作 ID:
PutRecord

根据需要编写存储库记录，创建或更新它。

参数

名称 密钥 必需 类型 说明
存储库
 repo True string

存储库的句柄或 DID（即当前帐户）。
收藏
 collection True string

记录集合的 NSID。
rkey
 rkey True string

记录键。
验证
 validate boolean

用于跳过 Lexicon 架构验证的 True/false 值。
记录
 record True object

记录的内容。
swapRecord
 swapRecord string

按 CID 比较和交换上一条记录。
swapCommit
 swapCommit string

比较和交换 CID 之前的提交。

返回

名称 路径 类型 说明
uri
 uri string
cid
 cid string
提交
 commit commitMeta
validationStatus
 validationStatus string

获取 Convo for Members

操作 ID:
GetConvoForMembers

获取一个或多个成员的对话。

参数

名称 密钥 必需 类型 说明
成员 DID 标识符
 members True array

会话成员的 DID 标识符列表。

返回

名称 路径 类型 说明
对话视图
 convo convoView

表示会话的视图。

获取一个帐户之间的公共关系，以及其他帐户的列表

操作 ID:
GetRelationships

获取一个帐户与其他帐户的列表之间的公共关系。

参数

名称 密钥 必需 类型 说明
主帐户
 actor True string

请求关系的主要帐户。
其他帐户
 others string

要与主要帐户相关的“其他”帐户列表。

返回

名称 路径 类型 说明
参与者
 actor string

主帐户的 DID。
relationships
 relationships array of object

执行组件和其他帐户之间的关系列表。
类型
 relationships.type string

关系或状态的类型。

获取与帐户关联的 Blob

操作 ID:
GetBlob

获取与给定帐户关联的 Blob。

参数

名称 密钥 必需 类型 说明
帐户 DID
 did True string

帐户的 DID。
Blob CID
 cid True string

要提取的 Blob 的 CID。

返回

名称 路径 类型 说明
blob
 blob string

Base64 编码的 Blob 内容。

获取个人资料

操作 ID:
GetProfile

使用执行组件句柄或 DID 检索执行组件的详细配置文件视图。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

处理或 DID 帐户以提取其配置文件。

返回

此操作输出是动态内容。

获取作者源

操作 ID:
GetAuthorFeed

获取执行组件的“作者源”的视图。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

要提取其作者源的执行组件的标识符。
限度
 limit integer

要提取的最大项数。
分页 curose
 cursor string

用于提取下一组结果的分页游标。
筛选条件
 filter string

要包括在响应中的 post/repost 类型的组合。
包括固定文章
 includePins boolean

是否在响应中包含固定帖子。

返回

名称 路径 类型 说明
游标
 cursor string
信息提要
 feed array of feedViewPost

获取入门包

操作 ID:
GetStarterPack

根据提供的引用（AT-URI）获取初学者包的视图。

参数

名称 密钥 必需 类型 说明
初学者包标识符
 starterPack True string

初学者包记录的参考（AT-URI）。

返回

名称 路径 类型 说明
starterPack
 starterPack starterPackView

获取关注

操作 ID:
GetFollows

枚举指定执行组件所遵循的帐户。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

正在检索其后跟的执行组件的句柄或 DID。
要检索的最大帐户数
 limit integer

要返回的最大帐户数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

此操作输出是动态内容。

获取关注者

操作 ID:
GetFollowers

枚举遵循指定执行组件的帐户。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

正在检索其追随者的执行组件的句柄或 DID。
分页限制
 limit integer

要返回的最大关注者数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

此操作输出是动态内容。

获取列表

操作 ID:
GetLists

枚举由指定帐户创建的列表。

参数

名称 密钥 必需 类型 说明
帐户标识符
 actor True string

要枚举列表的帐户（执行组件）。
限制结果
 limit integer

要返回的最大结果数。
分页游标
 cursor string

用于检索下一组结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的游标。
列表
 lists array of listView

获取列表源

操作 ID:
GetListFeed

从列表中获取最近发布的文章源。

参数

名称 密钥 必需 类型 说明
列表参考
 list True string

对列表记录的引用（AT-URI）。
结果限制
 limit integer

要检索的最大帖子数。
分页游标
 cursor string

可选的分页机制。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的分页游标。
信息提要
 feed array of feedViewPost

源中的帖子数组。

获取列表视图

操作 ID:
GetList

获取指定列表的“视图”（具有其他上下文）。

参数

名称 密钥 必需 类型 说明
列表参考
 list True string

要冻结的列表记录的参考（AT-URI）。
限制结果
 limit integer

要返回的最大结果数。
分页的游标
 cursor string

用于检索下一组结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的游标。
列表
 list listView
items
 items array of listItemView

获取初学者包

操作 ID:
GetStarterPacks

获取基于提供的 URI 的初学者包列表的详细视图。

参数

名称 密钥 必需 类型 说明
初学者包 URI
 uris True string

初学者包的 AT-URIs 列表（最多 25 个项目）。

返回

此操作输出是动态内容。

获取参与者喜欢的帖子列表

操作 ID:
GetActorLikes

获取参与者喜欢的帖子列表。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

正在检索其赞的执行组件的标识符。
结果限制
 limit integer

要返回的最大结果数。
分页游标
 cursor string

分页的游标。

返回

名称 路径 类型 说明
游标
 cursor string

结果的下一页的光标。
信息提要
 feed array of feedViewPost

演员喜欢的帖子列表。

获取存储库托管状态

操作 ID:
GetRepoStatus

在此服务器上获取存储库的托管状态。

参数

名称 密钥 必需 类型 说明
存储库 DID
 did True string

存储库的 DID。

返回

名称 路径 类型 说明
did
 did string
活跃
 active boolean
状态
 status string

指示活动状态的 True 或 false 值。
转速
 rev string

可选字段（如果 active=true）的存储库的当前修订版

获取存储库的当前提交

操作 ID:
GetLatestCommit

获取指定存储库的当前提交 CID 和修订。

参数

名称 密钥 必需 类型 说明
存储库 DID
 did True string

存储库的 DID。

返回

名称 路径 类型 说明
cid
 cid string
转速
 rev string

存储库的修订标识符。

获取审查存储库

操作 ID:
GetRepos

获取所有审查存储库的列表。

返回

名称 路径 类型 说明
repositories
 repositories array of object

审查存储库列表。
id
 repositories.id string

存储库的唯一标识符。
状态
 repositories.status string

存储库的状态。

获取对话

操作 ID:
GetConvo

根据提供的对话 ID 获取对话。

参数

名称 密钥 必需 类型 说明
会话 ID
 convoId True string

要检索的会话的 ID。

返回

名称 路径 类型 说明
对话视图
 convo convoView

表示会话的视图。

获取已知关注者

操作 ID:
GetKnownFollowers

检索特定帐户的追随者，该帐户后跟查看器。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

正在检索其追随者的执行组件的句柄或 DID。
关注者限制
 limit integer

要返回的最大关注者数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

此操作输出是动态内容。

获取帐户信息

操作 ID:
AdminGetAccountInfo

获取有关帐户的详细信息。

参数

名称 密钥 必需 类型 说明
帐户标识符
 did True string

帐户的分散标识符（DID）。

返回

Body
accountView

获取帐户信息

操作 ID:
AdminGetAccountInfos

获取有关某些帐户的详细信息。

参数

名称 密钥 必需 类型 说明
帐户标识符
 dids True array

帐户标识符数组（DID）。

返回

名称 路径 类型 说明
infos
 infos array of accountView

获取帐户邀请代码

操作 ID:
ServerGetAccountInviteCodes

获取当前帐户的所有邀请代码。

参数

名称 密钥 必需 类型 说明
包含已用
 includeUsed boolean

在响应中包含已使用的邀请代码。
创建可用
 createAvailable boolean

控制是否应创建任何新的“已赚取”但不应创建“已创建”邀请。

返回

名称 路径 类型 说明
codes
 codes array of inviteCode

获取帖子

操作 ID:
GetPosts

获取指定文章列表的帖子视图。

参数

名称 密钥 必需 类型 说明
发布 AT-URIs
 uris True array

要返回冻结视图的帖子 AT-URIs 列表。

返回

名称 路径 类型 说明
公告
 posts array of postView

获取帖子线程

操作 ID:
GetPostThread

获取线程中的帖子。

参数

名称 密钥 必需 类型 说明
发布 AT-URI
 uri True string

要发布记录的参考（AT-URI）。
答复深度
 depth integer

响应中应包含多少级别的回复深度。
父帖子级别
 parentHeight integer

要包括多少级别的父母（和祖父母等）。

返回

名称 路径 类型 说明
状态
 thread.status string
threadgate
 threadgate threadgateView

获取建议的参与者

操作 ID:
GetSuggestions

获取建议的参与者的列表。

参数

名称 密钥 必需 类型 说明
限度
 limit integer

要返回的最大结果数。
Cursor
 cursor string

分页的游标。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的分页游标。
演员
 actors array of profileView

建议执行组件配置文件的列表。

获取建议的后跟执行组件

操作 ID:
GetSuggestedFollowsByActor

枚举类似于给定帐户。

参数

名称 密钥 必需 类型 说明
Actor
 actor True string

建议使用类似以下内容的帐户标识符。

返回

名称 路径 类型 说明
建议
 suggestions array of profileView

要关注的建议配置文件列表。
isFallback
 isFallback boolean

指示结果是否为回退泛型建议。

获取建议的源

操作 ID:
GetSuggestedFeeds

检索请求帐户的建议源列表。

参数

名称 密钥 必需 类型 说明
限度
 limit integer

要返回的建议源的最大数目（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

此操作输出是动态内容。

获取当前会话信息

操作 ID:
GetSession

获取有关经过身份验证的会话的信息。

返回

名称 路径 类型 说明
句柄
 handle string

用户的句柄。
did
 did string

用户的分散标识符（DID）。
电子邮件
 email string

用户的电子邮件地址
emailConfirmed
 emailConfirmed boolean

指示是否已确认电子邮件。
emailAuthFactor
 emailAuthFactor boolean

指示电子邮件是否用作身份验证因素。
didDoc
 didDoc object

可选 DID 文档。
活跃
 active boolean

指示会话是否处于活动状态。
状态
 status string

用户帐户的状态。

获取执行组件元数据

操作 ID:
GetActorMetadata

通过 DID 为执行组件提取与审查相关的元数据

参数

名称 密钥 必需 类型 说明
DID
 actor True string

执行组件的分散标识符（DID）。

返回

名称 路径 类型 说明
日
 day ActorMetadata
月份
 month ActorMetadata
全部
 all ActorMetadata

获取执行组件源

操作 ID:
GetActorFeeds

获取执行组件创建的源列表。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

要检索其源的执行组件的句柄或 DID。
限度
 limit integer

要返回的最大源数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

此操作输出是动态内容。

获取报价

操作 ID:
GetQuotes

获取给定文章的报价列表。

参数

名称 密钥 必需 类型 说明
发布参考 URI
 uri True string

帖子记录的参考（AT-URI）。
特定版本 CID
 cid string

如果提供，则筛选为帖子记录的特定版本（按 CID）的引号。
结果限制
 limit integer

要检索的最大引号数。
分页游标
 cursor string

可选的分页机制。

返回

名称 路径 类型 说明
uri
 uri string

帖子记录的参考（AT-URI）。
cid
 cid string

帖子记录的特定版本（CID）。
游标
 cursor string

下一组结果的分页游标。
公告
 posts array of postView

报价的帖子视图数组。

获取日志

操作 ID:
GetLog

检索会话中作和消息的日志。

参数

名称 密钥 必需 类型 说明
分页游标
 cursor string

用于检索下一组日志的分页游标。

返回

此操作输出是动态内容。

获取时间线

操作 ID:
GetTimeline

获取请求帐户的主时间线的视图。

参数

名称 密钥 必需 类型 说明
算法变体
 algorithm string

时间线的变体“算法”。
限度
 limit integer

要返回的最大帖子数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

此操作输出是动态内容。

获取有关存储库的详细信息

操作 ID:
GetRepoModeration

获取有关存储库的详细信息。

参数

名称 密钥 必需 类型 说明
存储库的 DID
 did True string

存储库的 DID。

返回

Body
repoViewDetail

获取有关审核事件的详细信息

操作 ID:
GetEvent

获取有关审核事件的详细信息。

参数

名称 密钥 必需 类型 说明
要检索的审查事件的 ID
 id True integer

要检索的审查事件的 ID。

返回

Body
modEventViewDetail

获取有关帐户和存储库的信息

操作 ID:
DescribeRepo

获取有关帐户和存储库的信息，包括集合列表。

参数

名称 密钥 必需 类型 说明
存储库的句柄或 DID。
 repo True string

存储库的句柄或 DID。

返回

名称 路径 类型 说明
句柄
 handle string
did
 did string
didDoc
 didDoc object
collections
 collections array of string
handleIsCorrect
 handleIsCorrect boolean

指示句柄当前是否有效。

获取有关某些记录的详细信息

操作 ID:
GetRecordsModeration

获取有关某些记录的详细信息。

参数

名称 密钥 必需 类型 说明
要检索的记录的 URI
 uris True array

记录的 URI 列表。

返回

名称 路径 类型 说明
记录
 records array of object
items
 records object

获取有关标签器服务列表的信息

操作 ID:
GetServices

获取有关标签器服务列表的信息。

参数

名称 密钥 必需 类型 说明
DID
 dids True array

DID
详细
 detailed boolean

详细

返回

名称 路径 类型 说明
views
 views array of labelerView

获取有关源的信息

操作 ID:
DescribeFeedGenerator

获取有关源生成器的信息。

返回

名称 路径 类型 说明
did
 did string
饲料
 feeds array of describeFeedGeneratorFeed
链接
 links describeFeedGeneratorLinks

获取有关记录的详细信息

操作 ID:
GetRecordModeration

获取有关记录的详细信息。

参数

名称 密钥 必需 类型 说明
要检索的记录的 URI
 uri True string

记录的 URI。
特定版本的 CID
 cid string

记录版本的 CID。

返回

Body
recordViewDetail

获取服务器配置

操作 ID:
ServerGetConfig

获取有关臭氧的服务器配置的详细信息。

返回

名称 路径 类型 说明
appview
 appview serviceConfig
pds
 pds serviceConfig
blobDivert
 blobDivert serviceConfig
聊天
 chat serviceConfig
查看器
 viewer viewerConfig

获取服务身份验证令牌

操作 ID:
GetServiceAuth

代表请求的服务的 DID 获取已签名的令牌。

参数

名称 密钥 必需 类型 说明
DID
 aud True string

令牌将用于进行身份验证的服务的 DID。
过期日期
 exp integer

JWT 过期的 Unix Epoch 秒中的时间。 默认值 = 60 秒
Lexicon 方法
 lxm string

用于将请求的令牌绑定到的 Lexicon （XRPC） 方法。

返回

名称 路径 类型 说明
代币
 token string

已签名的身份验证令牌。

获取消息

操作 ID:
GetMessages

从特定对话获取邮件列表。

参数

名称 密钥 必需 类型 说明
会话 ID
 convoId True string

要从中检索消息的会话的 ID。
分页限制
 limit integer

要返回的最大消息数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组消息的分页游标。

返回

此操作输出是动态内容。

获取消息上下文

操作 ID:
GetMessageContext

从对话中提取周围消息

参数

名称 密钥 必需 类型 说明
对话 ID
 convoId string

消息来自的对话。
消息 ID
 messageId True string

消息的 ID。
指定消息之前要包含的消息数。
 before integer

指定消息之前要包含的消息数。
指定消息后要包含的消息数。
 after integer

指定消息后要包含的消息数。

返回

此操作输出是动态内容。

获取源

操作 ID:
GetFeed

从参与者选择的源生成器中获取水化源。

参数

名称 密钥 必需 类型 说明
源生成器 URI
 feed True string

源生成器的 URI。
执行组件标识符
 actor True string

请求源的执行组件的句柄或 DID。
限度
 limit integer

要返回的最大帖子数（默认值：50，最大值：100）。
分页游标
 cursor string

用于检索下一组结果的分页游标。

返回

此操作输出是动态内容。

获取源框架

操作 ID:
GetFeedSkeleton

获取源生成器提供的源的框架。

参数

名称 密钥 必需 类型 说明
源生成器参考。
 feed True string

对描述所请求的特定源的源生成器记录的引用。
要检索的结果数。
 limit integer

限度
分页游标。
 cursor string

分页游标

返回

名称 路径 类型 说明
游标
 cursor string
信息提要
 feed array of skeletonFeedPost

获取源生成器信息

操作 ID:
GetFeedGenerator

获取有关源生成器的信息。

参数

名称 密钥 必需 类型 说明
源生成器 AT-URI
 feed True string

源生成器记录的 AT-URI。

返回

名称 路径 类型 说明
视图
 view generatorView
isOnline
 isOnline boolean

指示源生成器服务最近是否已联机。
isValid
 isValid boolean

指示源生成器服务是否与记录声明兼容。

获取源生成器信息

操作 ID:
GetFeedGenerators

获取有关源生成器列表的信息。

参数

名称 密钥 必需 类型 说明
源生成器 AT-URIs 列表
 feeds True array

表示要检索其信息的源生成器的 AT-URIs 列表。

返回

名称 路径 类型 说明
饲料
 feeds array of generatorView

获取由执行组件创建的初学者包列表

操作 ID:
GetActorStarterPacks

获取由执行组件创建的初学者包的列表。

参数

名称 密钥 必需 类型 说明
执行组件标识符
 actor True string

要为其检索初学者包的执行组件标识符。
结果限制
 limit integer

要返回的最大初学者包数。
分页游标
 cursor string

用于分页的游标以提取下一组结果。

返回

名称 路径 类型 说明
游标
 cursor string

分页的游标。
starterPacks
 starterPacks array of starterPackViewBasic

获取经过身份验证的用户的视频上传限制

操作 ID:
GetUploadLimits

获取经过身份验证的用户的视频上传限制。

返回

名称 路径 类型 说明
canUpload
 canUpload boolean

指示用户是否可以上传视频。
remainingDailyVideos
 remainingDailyVideos integer

用户目前仍可上传的视频数。
remainingDailyBytes
 remainingDailyBytes integer

目前可用于上传的剩余数据大小（以字节为单位）。
消息
 message string

有关上传限制的其他信息。
错误
 error string

错误消息（如果适用）。

获取视频处理作业的状态详细信息

操作 ID:
GetjobStatus

获取视频处理作业的状态详细信息。

参数

名称 密钥 必需 类型 说明
职位编号
 jobId True string

要检索其状态的视频处理作业的 ID。

返回

名称 路径 类型 说明
jobStatus
 jobStatus jobStatus

获取设置值

操作 ID:
GetValues

获取特定集及其值。

参数

名称 密钥 必需 类型 说明
设置名称
 name True string

要检索的集的名称。
结果限制
 limit integer

要返回的最大值数。
分页游标
 cursor string

分页的游标。

返回

名称 路径 类型 说明
set
 set setView
values
 values array of string
游标
 cursor string

获取赞

操作 ID:
GetLikes

获取引用主题的记录（按 AT-URI 和 CID）。

参数

名称 密钥 必需 类型 说明
主题 AT-URI。
 uri True string

主题 AT-URI（例如帖子记录）。
使用者记录的 CID。
 cid string

主题记录的 CID（记录的特定版本），用于筛选赞。
限制结果数。
 limit integer

限度
分页游标。
 cursor string

分页游标

返回

名称 路径 类型 说明
uri
 uri string
cid
 cid string
游标
 cursor string
喜欢
 likes array of getLikesLike

获取通信模板列表

操作 ID:
ListTemplates

检索所有可用通信模板的列表。

返回

名称 路径 类型 说明
communicationTemplates
 communicationTemplates array of templateView

获取邀请代码

操作 ID:
AdminGetInviteCodes

获取邀请代码的管理员视图。

参数

名称 密钥 必需 类型 说明
Sort 方法
 sort string

邀请代码的排序方法。
限度
 limit integer

要返回的最大结果数。
分页游标
 cursor string

分页的游标。

返回

名称 路径 类型 说明
分页的游标。
 cursor string
codes
 codes array of inviteCode

获取配置文件

操作 ID:
GetProfiles

获取多个执行组件的详细配置文件视图。

参数

名称 密钥 必需 类型 说明
执行组件标识符列表
 actors True array

执行组件标识符

返回

名称 路径 类型 说明
profiles
 profiles array of profileViewDetailed

获取重新发布者

操作 ID:
GetRepostedBy

获取给定帖子的转帖列表。

参数

名称 密钥 必需 类型 说明
发布参考 URI
 uri True string

帖子记录的参考（AT-URI）。
特定版本 CID
 cid string

如果提供，则筛选以重新发布帖子记录的特定版本（按 CID）。
结果限制
 limit integer

要检索的最大重新发布次数。
分页游标
 cursor string

可选的分页机制。

返回

名称 路径 类型 说明
uri
 uri string

帖子记录的参考（AT-URI）。
cid
 cid string

帖子记录的特定版本（CID）。
游标
 cursor string

下一组结果的分页游标。
repostedBy
 repostedBy array of profileView

重新发布帖子的配置文件数组。

获取阻止列表

操作 ID:
GetListBlocks

获取请求帐户（执行组件）正在阻止的模式列表。

参数

名称 密钥 必需 类型 说明
限制结果
 limit integer

要返回的最大结果数。
分页游标
 cursor string

用于检索下一组结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的游标。
列表
 lists array of listView

获取静音

操作 ID:
GetMutes

枚举请求帐户当前已静音的帐户。

参数

名称 密钥 必需 类型 说明
限制结果
 limit integer

要返回的最大结果数。
分页游标
 cursor string

用于检索下一组结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的游标。
静音
 mutes array of profileView

获取静音列表

操作 ID:
GetListMutes

获取请求帐户当前已静音的模式列表。

参数

名称 密钥 必需 类型 说明
限制结果
 limit integer

要返回的最大结果数。
分页游标
 cursor string

用于检索下一组结果的游标。

返回

名称 路径 类型 说明
游标
 cursor string

下一组结果的游标。
列表
 lists array of listView

获取首选项

操作 ID:
GetPreferences

获取附加到当前帐户的专用首选项。

返回

名称 路径 类型 说明
preferences
 preferences preferences

设置帐户首选项

操作 ID:
PutPreferences

设置附加到帐户的专用首选项。

参数

名称 密钥 必需 类型 说明
enabled
 enabled True boolean
labelerDid
 labelerDid string

此首选项适用于哪个标签器？
标签
 label True string
能见度
 visibility True string
pinned
 pinned True array of string
保存
 saved True array of string
timelineIndex
 timelineIndex integer
id
 id True string
类型
 type True string
value
 value True string
pinned
 pinned True boolean
birthDate
 birthDate date-time

帐户所有者的出生日期。
信息提要
 feed True string

源的 URI，或描述源的标识符。
hideReplies
 hideReplies boolean

隐藏源中的回复。
hideRepliesByUnfollowed
 hideRepliesByUnfollowed boolean

如果回复不是后跟用户，则隐藏源中的回复。
hideRepliesByLikeCount
 hideRepliesByLikeCount integer
hideReposts
 hideReposts boolean

隐藏源中的重新发布。
hideQuotePosts
 hideQuotePosts boolean

隐藏源中的引号文章。
排序
 sort string

线程的排序模式。
prioritizeFollowedUsers
 prioritizeFollowedUsers boolean

在所有答复顶部显示关注的用户。
tags
 tags True array of string
id
 id string
value
 value True string

静音的单词本身。
目标
 targets string
actorTarget
 actorTarget string

要向其应用静音单词的用户组。 如果未定义，则适用于所有用户。
expiresAt
 expiresAt date-time

静音词过期的日期和时间，不再应用。
items
 items True array of string
参考线
 guide True string
queuedNudges
 queuedNudges array of string
id
 id True string
完成
 completed True boolean
数据
 data string

NUX 的任意数据。 300 个字符的限制。
expiresAt
 expiresAt date-time

NUX 到期和完成的日期和时间。
did
 did True string

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。
消息
 message string

可选成功消息。

设置通知首选项

操作 ID:
PutNotificationPreferences

为帐户设置与通知相关的首选项。

参数

名称 密钥 必需 类型 说明
priority
 priority True boolean

指示是否应启用优先级通知。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。
消息
 message string

可选成功消息。

请求删除帐户

操作 ID:
ServerRequestAccountDelete

通过电子邮件启动用户帐户删除。

请求密码重置

操作 ID:
RequestPasswordReset

通过电子邮件启动用户帐户密码重置。

参数

名称 密钥 必需 类型 说明
电子邮件
 email True string

与用户帐户关联的电子邮件地址。

请求爬网

操作 ID:
RequestCrawl

请求服务永久爬网托管存储库。

参数

名称 密钥 必需 类型 说明
主机名
 hostname True string

请求爬网的当前服务的主机名。

请求电子邮件更新

操作 ID:
ServerRequestEmailUpdate

请求令牌以更新电子邮件。

返回

名称 路径 类型 说明
tokenRequired
 tokenRequired boolean

指示电子邮件更新是否需要令牌。

请求电子邮件确认

操作 ID:
ServerRequestEmailConfirmation

请求包含代码的电子邮件，以确认电子邮件的所有权。

通知服务器请求帐户已看到通知

操作 ID:
UpdateSeen

通知服务器请求帐户已看到通知。

参数

名称 密钥 必需 类型 说明
seenAt
 seenAt True date-time

指示何时看到通知的时间戳。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。

重置密码

操作 ID:
ResetPassword

使用令牌重置用户帐户密码。

参数

名称 密钥 必需 类型 说明
代币
 token True string

为密码重置提供的令牌。
密码
 password True string

用户帐户的新密码。

静音执行组件

操作 ID:
MuteActor

为指定的帐户创建静音关系。

参数

名称 密钥 必需 类型 说明
帐户标识符
 actor True string

要静音的帐户的标识符。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。

静音执行组件列表

操作 ID:
MuteActorList

为指定的帐户列表创建静音关系。

参数

名称 密钥 必需 类型 说明
列表 URI
 list True string

要静音的帐户列表的 URI 引用。

返回

名称 路径 类型 说明
success
 success boolean

指示作是否成功。

定义

preferences

名称 路径 类型 说明
adultContentPref
 adultContentPref adultContentPref
contentLabelPref
 contentLabelPref contentLabelPref
savedFeedsPref
 savedFeedsPref savedFeedsPref
savedFeedsPrefV2
 savedFeedsPrefV2 savedFeedsPrefV2
personalDetailsPref
 personalDetailsPref personalDetailsPref
feedViewPref
 feedViewPref feedViewPref
threadViewPref
 threadViewPref threadViewPref
interestsPref
 interestsPref interestsPref
mutedWordsPref
 mutedWordsPref mutedWordsPref
hiddenPostsPref
 hiddenPostsPref hiddenPostsPref
bskyAppStatePref
 bskyAppStatePref bskyAppStatePref

特定于 bsky.app 程序的状态的抓取包。
labelersPref
 labelersPref labelersPref

adultContentPref

名称 路径 类型 说明
enabled
 enabled boolean

contentLabelPref

名称 路径 类型 说明
labelerDid
 labelerDid string

此首选项适用于哪个标签器？
标签
 label string
能见度
 visibility string

savedFeed

名称 路径 类型 说明
id
 id string
类型
 type string
value
 value string
pinned
 pinned boolean

savedFeedsPrefV2

名称 路径 类型 说明
items
 items array of savedFeed

savedFeedsPref

名称 路径 类型 说明
pinned
 pinned array of string
保存
 saved array of string
timelineIndex
 timelineIndex integer

personalDetailsPref

名称 路径 类型 说明
birthDate
 birthDate date-time

帐户所有者的出生日期。

feedViewPref

名称 路径 类型 说明
信息提要
 feed string

源的 URI，或描述源的标识符。
hideReplies
 hideReplies boolean

隐藏源中的回复。
hideRepliesByUnfollowed
 hideRepliesByUnfollowed boolean

如果回复不是后跟用户，则隐藏源中的回复。
hideRepliesByLikeCount
 hideRepliesByLikeCount integer
hideReposts
 hideReposts boolean

隐藏源中的重新发布。
hideQuotePosts
 hideQuotePosts boolean

隐藏源中的引号文章。

threadViewPref

名称 路径 类型 说明
排序
 sort string

线程的排序模式。
prioritizeFollowedUsers
 prioritizeFollowedUsers boolean

在所有答复顶部显示关注的用户。

interestsPref

名称 路径 类型 说明
tags
 tags array of string

mutedWordTarget

string

mutedWord

帐户所有者已静音的单词。

名称 路径 类型 说明
id
 id string
value
 value string

静音的单词本身。
目标
 targets array of mutedWordTarget
actorTarget
 actorTarget string

要向其应用静音单词的用户组。 如果未定义，则适用于所有用户。
expiresAt
 expiresAt date-time

静音词过期的日期和时间，不再应用。

mutedWordsPref

名称 路径 类型 说明
items
 items array of mutedWord

hiddenPostsPref

名称 路径 类型 说明
items
 items array of string

labelersPref

名称 路径 类型 说明
labelers
 labelers array of labelerPrefItem

labelerPrefItem

名称 路径 类型 说明
did
 did string

starterPackView

名称 路径 类型 说明
uri
 uri string
cid
 cid string
记录
 record
创建者
 creator appProfileViewBasic
列表
 list listViewBasic
listItemsSample
 listItemsSample array of listItemView
饲料
 feeds array of generatorView
joinedWeekCount
 joinedWeekCount integer
joinedAllTimeCount
 joinedAllTimeCount integer
labels
 labels array of label
indexedAt
 indexedAt date-time

starterPackViewBasic

名称 路径 类型 说明
uri
 uri string
cid
 cid string
记录
 record
创建者
 creator appProfileViewBasic
listItemCount
 listItemCount integer
joinedWeekCount
 joinedWeekCount integer
joinedAllTimeCount
 joinedAllTimeCount integer
labels
 labels array of label
indexedAt
 indexedAt date-time

bskyAppStatePref

特定于 bsky.app 程序的状态的抓取包。

名称 路径 类型 说明
activeProgressGuide
 activeProgressGuide bskyAppProgressGuide

如果已设置，则为活动进度指南。
queuedNudges
 queuedNudges array of string
nuxs
 nuxs array of nux

bskyAppProgressGuide

如果已设置，则为活动进度指南。

名称 路径 类型 说明
参考线
 guide string

nux

新的用户体验 （NUX） 存储对象

名称 路径 类型 说明
id
 id string
完成
 completed boolean
数据
 data string

NUX 的任意数据。 300 个字符的限制。
expiresAt
 expiresAt date-time

NUX 到期和完成的日期和时间。

profileViewDetailed

名称 路径 类型 说明
did
 did string
句柄
 handle string
displayName
 displayName string
描述
 description string
化身
 avatar string
旗帜
 banner string
followersCount
 followersCount integer
followsCount
 followsCount integer
postsCount
 postsCount integer
相关
 associated profileAssociated
joinedViaStarterPack
 joinedViaStarterPack starterPackViewBasic
indexedAt
 indexedAt date-time
createdAt
 createdAt date-time
查看器
 viewer appViewerState

有关请求帐户与使用者帐户关系的元数据。
labels
 labels array of label
pinnedPost
 pinnedPost strongRef

使用 URI 和 CID 定义强引用。

profileView

有关配置文件的基本信息。

名称 路径 类型 说明
did
 did string

配置文件的分散标识符（DID）。
句柄
 handle string

配置文件的句柄。
displayName
 displayName string

配置文件的显示名称。
化身
 avatar string

配置文件的头像 URL。
相关
 associated associatedMetadata

配置文件的关联元数据。
查看器
 viewer viewerMetadata

有关查看器与执行组件关系的元数据。
labels
 labels array of label

与配置文件关联的标签。
createdAt
 createdAt date-time

创建配置文件时的时间戳。

associatedMetadata

配置文件的关联元数据。

名称 路径 类型 说明
列表
 lists integer

关联的列表数。
feedgens
 feedgens integer

关联的源生成器数。
starterPacks
 starterPacks integer

初学者包数。
贴 标 机
 labeler boolean

指示配置文件是否为标签器。
allowIncoming
 chat.allowIncoming string

允许传入聊天设置（例如“all”）。

mutedByList

使执行组件静音的列表的详细信息。

名称 路径 类型 说明
uri
 uri string

将执行组件设为静音的列表的 URI。
cid
 cid string

列表的内容标识符（CID）。
姓名
 name string

列表的名称。
purpose
 purpose string

列表的用途。
化身
 avatar string

列表的虚拟形象映像 URI。
listItemCount
 listItemCount integer

列表中的项数。
labels
 labels array of label

与列表关联的标签。
查看器
 viewer viewerMetadata

有关查看器与执行组件关系的元数据。
indexedAt
 indexedAt date-time

为列表编制索引时的时间戳。

blockingByList

阻止执行组件的列表的详细信息。

名称 路径 类型 说明
uri
 uri string

阻止执行组件的列表的 URI。
cid
 cid string

列表的内容标识符（CID）。
姓名
 name string

列表的名称。
purpose
 purpose string

列表的用途。
化身
 avatar string

列表的虚拟形象映像 URI。
listItemCount
 listItemCount integer

列表中的项数。
labels
 labels array of label

与列表关联的标签。
查看器
 viewer viewerMetadata

有关查看器与执行组件关系的元数据。
indexedAt
 indexedAt date-time

为列表编制索引时的时间戳。

viewerMetadata

有关查看器与执行组件关系的元数据。

名称 路径 类型 说明
温和
 muted boolean

指示查看器是否静音了执行组件。
blockedBy
 blockedBy boolean

指示查看器是否阻止了执行组件。
阻塞
 blocking string

指示查看器是否正在阻止执行组件。
以后
 following string

指示查看器是否正在关注执行组件。
followedBy
 followedBy string

指示执行组件是否正在关注查看器。
mutedByList
 mutedByList mutedByList

使执行组件静音的列表的详细信息。
blockingByList
 blockingByList blockingByList

阻止执行组件的列表的详细信息。

postView

名称 路径 类型 说明
object

feedReplyRef

名称 路径 类型 说明
根
 root object

根文章引用，可以是 postView、notFoundPost 或 blockedPost。
父级
 parent object

父帖子引用，可以是 postView、notFoundPost 或 blockedPost。
祖父母Author
 grandparentAuthor appProfileViewBasic

strongRef

使用 URI 和 CID 定义强引用。

名称 路径 类型 说明
uri
 uri string

强引用的 URI。
cid
 cid string

强引用的 CID。

profileAssociated

名称 路径 类型 说明
列表
 lists integer
feedgens
 feedgens integer
starterPacks
 starterPacks integer
贴 标 机
 labeler boolean
聊天
 chat profileAssociatedChat

appViewerState

有关请求帐户与使用者帐户关系的元数据。

名称 路径 类型 说明
温和
 muted boolean
mutedByList
 mutedByList listViewBasic
blockedBy
 blockedBy boolean
阻塞
 blocking string
blockingByList
 blockingByList listViewBasic
以后
 following string
followedBy
 followedBy string
knownFollowers
 knownFollowers knownFollowers

主题的追随者，你也关注该主题。

profileAssociatedChat

名称 路径 类型 说明
allowIncoming
 allowIncoming string

listView

名称 路径 类型 说明
uri
 uri string
cid
 cid string
创建者
 creator profileView

有关配置文件的基本信息。
姓名
 name string
purpose
 purpose listPurpose

定义列表的用途。
描述
 description string
descriptionFacets
 descriptionFacets array of richtextFacet
化身
 avatar string
listItemCount
 listItemCount integer
labels
 labels array of label
查看器
 viewer listViewerState
indexedAt
 indexedAt date-time

listItemView

名称 路径 类型 说明
uri
 uri string
主题
 subject profileView

有关配置文件的基本信息。

listViewBasic

名称 路径 类型 说明
uri
 uri string
cid
 cid string
姓名
 name string
purpose
 purpose listPurpose

定义列表的用途。
化身
 avatar string
listItemCount
 listItemCount integer
labels
 labels array of label
查看器
 viewer listViewerState
indexedAt
 indexedAt string

标签

atproto 资源（例如存储库或记录）上的元数据标记。

名称 路径 类型 说明
ver
 ver integer
src
 src string

创建此标签的参与者的 DID。
uri
 uri string

此标签适用的记录、存储库（帐户）或其他资源的 AT URI。
cid
 cid string

（可选）指定此标签适用的特定版本的“uri”资源的 CID。
瓦尔
 val string

此标签的值或类型的短字符串名称。
neg
 neg boolean

如果为 true，则这是否定标签，覆盖以前的标签。
cts
 cts date-time

创建此标签时的时间戳。
exp
 exp date-time

此标签过期的时间戳（不再适用）。
sig
 sig byte

dag-cbor 编码标签的签名。

ActorMetadata

名称 路径 类型 说明
messagesSent
 messagesSent integer

执行组件发送的消息数。
messagesReceived
 messagesReceived integer

执行组件收到的消息数。
车队
 convos integer

参与者参与的对话总数。
convosStarted
 convosStarted integer

执行组件启动的对话数。

knownFollowers

主题的追随者，你也关注该主题。

名称 路径 类型 说明
计数
 count integer
追随 者
 followers array of appProfileViewBasic

appProfileViewBasic

名称 路径 类型 说明
did
 did string

执行组件的分散标识符（DID）。
句柄
 handle string

执行组件的唯一句柄。
displayName
 displayName string

执行组件的显示名称。
化身
 avatar string

执行组件的头像图像的 URI。
createdAt
 createdAt date-time

创建执行组件的配置文件的时间戳。

chatProfileViewBasic

名称 路径 类型 说明
did
 did string
句柄
 handle string

执行组件的句柄。
displayName
 displayName string

执行组件的显示名称。
化身
 avatar string

执行组件的头像的 URI。
相关
 associated profileAssociated
查看器
 viewer appViewerState

有关请求帐户与使用者帐户关系的元数据。
labels
 labels array of label

与执行组件关联的标签数组。
chatDisabled
 chatDisabled boolean

指示执行组件是否无法积极参与对话。

listPurpose

定义列表的用途。

名称 路径 类型 说明
类型
 type string

列表用途的类型。
Modlist 属性
 modlistProperty string

特定于 modlist 的属性。
Curatelist 属性
 curatelistProperty string

特定于特选列表的属性。
Referencelist 属性
 referencelistProperty string

特定于引用列表的属性。

listViewerState

名称 路径 类型 说明
温和
 muted boolean
封锁
 blocked string

convoView

表示会话的视图。

名称 路径 类型 说明
会话 ID
 id string

会话的唯一标识符。
对话修订
 rev string

会话的修订标识符。
对话成员
 members array of chatProfileViewBasic

对话中的成员列表。
id
 lastMessage.id string

消息的唯一标识符。
内容
 lastMessage.content string

最后一条消息的内容。
时间戳
 lastMessage.timestamp date-time

发送最后一条消息的时间。
对话静音
 muted boolean

指示对话是否已静音。
是否打开对话
 opened boolean

指示是否已打开对话。
未读消息计数
 unreadCount integer

会话中未读消息的计数。

messageViewSender

名称 路径 类型 说明
did
 did string

发送方的分散标识符。

richtextFacet

格式文本中子字符串的注释。

名称 路径 类型 说明
索引
 index richTextFacetByteSlice

指定分面功能应用于的子字符串范围。
features
 features array of object
featureType
 features.featureType string

功能的类型。
details
 features.details object

有关该功能的详细信息。

richTextFacetByteSlice

指定分面功能应用于的子字符串范围。

名称 路径 类型 说明
byteStart
 byteStart integer

范围的起始字节。
byteEnd
 byteEnd integer

范围的结束字节。

deletedMessageView

名称 路径 类型 说明
id
 id string

已删除消息的 ID。
转速
 rev string

已删除邮件的修订 ID。
发送方
 sender messageViewSender
sentAt
 sentAt date-time

发送消息时的时间戳。

lastMessage

表示对话中的最后一条消息。

名称 路径 类型 说明
id
 id string

消息的唯一标识符。
文本消息
 text string

消息的文本内容。
发送方
 sender string

邮件发件人的标识符。
sentAt
 sentAt date-time

发送消息的时间。

accountView

名称 路径 类型 说明
did
 did string
句柄
 handle string
电子邮件
 email string
relatedRecords
 relatedRecords array of
indexedAt
 indexedAt date-time
invitedBy
 invitedBy inviteCode
邀请
 invites array of inviteCode
invitesDisabled
 invitesDisabled boolean
emailConfirmedAt
 emailConfirmedAt date-time
inviteNote
 inviteNote string
deactivatedAt
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

inviteCode

名称 路径 类型 说明
代码
 code string
可用
 available integer
禁用的
 disabled boolean
forAccount
 forAccount string
createdBy
 createdBy string
createdAt
 createdAt date-time
使用
 uses array of inviteCodeUse

threatSignature

名称 路径 类型 说明
属性
 property string
value
 value string

inviteCodeUse

名称 路径 类型 说明
usedBy
 usedBy string
usedAt
 usedAt date-time

statusAttr

名称 路径 类型 说明
应用的
 applied boolean
ref
 ref string

createAppPassword

名称 路径 类型 说明
姓名
 name string
密码
 password string
createdAt
 createdAt date-time
特权
 privileged boolean

listAppPassword

名称 路径 类型 说明
姓名
 name string
createdAt
 createdAt string
特权
 privileged boolean
名称 路径 类型 说明
隐私政策
 privacyPolicy string
服务条款
 termsOfService string

serviceConfig

名称 路径 类型 说明
网址
 url string

viewerConfig

名称 路径 类型 说明
角色
 role string

describeServerContact

名称 路径 类型 说明
电子邮件
 email string

describeFeedGeneratorFeed

名称 路径 类型 说明
uri
 uri string
名称 路径 类型 说明
隐私政策
 privacyPolicy string
服务条款
 termsOfService string

feedViewPost

名称 路径 类型 说明
发布
 post postView
答
 reply feedReplyRef
类型
 reason.type string
details
 reason.details object

特定于原因类型的其他详细信息。 匹配 reasonRepost 或 reasonPin。
feedContext
 feedContext string

源生成器提供的上下文，这些源生成器可能与交互一起传递回来。

generatorView

名称 路径 类型 说明
uri
 uri string
cid
 cid string
did
 did string
创建者
 creator profileView

有关配置文件的基本信息。
displayName
 displayName string
描述
 description string
descriptionFacets
 descriptionFacets array of richtextFacet
化身
 avatar string
likeCount
 likeCount integer
acceptsInteractions
 acceptsInteractions boolean
labels
 labels array of label
查看器
 viewer generatorViewerState
indexedAt
 indexedAt date-time

generatorViewerState

名称 路径 类型 说明
赞
 like string

threadgateView

名称 路径 类型 说明
uri
 uri string
cid
 cid string
记录
 record
列表
 lists array of listViewBasic

getLikesLike

名称 路径 类型 说明
indexedAt
 indexedAt date-time
createdAt
 createdAt date-time
参与者
 actor profileView

有关配置文件的基本信息。

skeletonFeedPost

名称 路径 类型 说明
发布
 post string

帖子 AT-URI。
reasonRepost
 reasonRepost skeletonReasonRepost
reasonPin
 reasonPin skeletonReasonPin
feedContext
 feedContext string

上下文传递到客户端，并返回源生成器以及交互。

skeletonReasonRepost

名称 路径 类型 说明
repost
 repost string

skeletonReasonPin

reasonType

审查报告的原因类型。 预定义原因之一。

名称 路径 类型 说明
reasonSpam
 reasonSpam reasonSpam

垃圾邮件：频繁的不需要的促销、回复、提及
reasonViolation
 reasonViolation reasonViolation

直接违反服务器规则、法律、服务条款
reasonMisleading
 reasonMisleading reasonMisleading

误导性标识、附属关系或内容
reasonSexual
 reasonSexual reasonSexual

不需要或错误标记的性内容
reasonRude
 reasonRude reasonRude

粗鲁、骚扰、显式或其他不令人不安的行为
reasonOther
 reasonOther reasonOther

其他：报表未属于另一个报表类别
reasonAppeal
 reasonAppeal reasonAppeal

上诉：上诉之前采取适度行动

reasonSpam

垃圾邮件：频繁的不需要的促销、回复、提及

垃圾邮件：频繁的不需要的促销、回复、提及

string

reasonViolation

直接违反服务器规则、法律、服务条款

直接违反服务器规则、法律、服务条款

string

reasonMisleading

误导性标识、附属关系或内容

误导性标识、附属关系或内容

string

reasonSexual

不需要或错误标记的性内容

不需要或错误标记的性内容

string

reasonRude

粗鲁、骚扰、显式或其他不令人不安的行为

粗鲁、骚扰、显式或其他不令人不安的行为

string

reasonOther

其他：报表未属于另一个报表类别

其他：报表未属于另一个报表类别

string

reasonAppeal

上诉：上诉之前采取适度行动

上诉：上诉之前采取适度行动

string

repoRef

名称 路径 类型 说明
did
 did string

repoBlobRef

名称 路径 类型 说明
did
 did string
cid
 cid string
recordUri
 recordUri string

通知

名称 路径 类型 说明
uri
 uri string
cid
 cid string
作者
 author profileView

有关配置文件的基本信息。
原因
 reason string

预期值为“like”、“repost”、“follow”、“mention”、“reply”、“quote”和“starterpack-joined”。
reasonSubject
 reasonSubject string
记录
 record
isRead
 isRead boolean
indexedAt
 indexedAt date-time
labels
 labels array of label

labelerView

名称 路径 类型 说明
uri
 uri string
cid
 cid string
创建者
 creator profileView

有关配置文件的基本信息。
likeCount
 likeCount integer
查看器
 viewer labelerViewerState
indexedAt
 indexedAt date-time
labels
 labels array of label

labelerViewerState

名称 路径 类型 说明
赞
 like string

jobStatus

名称 路径 类型 说明
jobId
 jobId string
did
 did string
状态
 state string

视频处理作业的状态。
进展
 progress integer
blob
 blob binary
错误
 error string
消息
 message string

templateView

名称 路径 类型 说明
id
 id string
姓名
 name string

模板的名称。
主题
 subject string

模板的内容，可以包含 markdown 和变量占位符。
contentMarkdown
 contentMarkdown string

电子邮件中使用的邮件主题。
禁用的
 disabled boolean
lang
 lang string

消息语言。
lastUpdatedBy
 lastUpdatedBy string

上次更新模板的用户的 DID。
createdAt
 createdAt date-time
updatedAt
 updatedAt date-time

repoView

名称 路径 类型 说明
did
 did string
句柄
 handle string
电子邮件
 email string
relatedRecords
 relatedRecords array of
indexedAt
 indexedAt date-time
moderation
 moderation moderation
invitedBy
 invitedBy inviteCode
invitesDisabled
 invitesDisabled boolean
inviteNote
 inviteNote string
deactivatedAt
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

moderation

名称 路径 类型 说明
subjectStatus
 subjectStatus subjectStatusView

subjectStatusView

名称 路径 类型 说明
id
 id integer

主题状态的唯一标识符。
类型
 subject.type string

主题引用的类型。
repoRef
 subject.repoRef repoRef
strongRef
 subject.strongRef strongRef

使用 URI 和 CID 定义强引用。
类型
 hosting.type string

宿主的类型。
状态
 hosting.accountHosting.status string
updatedAt
 hosting.accountHosting.updatedAt date-time
createdAt
 hosting.accountHosting.createdAt date-time
状态
 hosting.recordHosting.status string
updatedAt
 hosting.recordHosting.updatedAt date-time
createdAt
 hosting.recordHosting.createdAt date-time
createdAt
 createdAt date-time

创建主题状态时的时间戳。
updatedAt
 updatedAt date-time

上次更新主题状态的时间戳。
reviewState
 reviewState string

主题的审阅状态。

modEventView

名称 路径 类型 说明
id
 id integer
类型
 event.type string
类型
 subject.type string
subjectBlobCids
 subjectBlobCids array of string
createdBy
 createdBy string
createdAt
 createdAt date-time
creatorHandle
 creatorHandle string
subjectHandle
 subjectHandle string

applyWrites.result

名称 路径 类型 说明
类型
 type string

写入作的结果类型。
createResult
 createResult applyWrites.createResult
updateResult
 updateResult applyWrites.updateResult
删除作结果
 deleteResult applyWrites.deleteResult

applyWrites.createResult

名称 路径 类型 说明
uri
 uri string
cid
 cid string
validationStatus
 validationStatus string

applyWrites.updateResult

名称 路径 类型 说明
uri
 uri string
cid
 cid string
validationStatus
 validationStatus string

applyWrites.deleteResult

名称 路径 类型 说明
id
 id string

已删除实体的标识符。
deletedAt
 deletedAt date-time

删除实体时的时间戳。

commitMeta

名称 路径 类型 说明
cid
 cid string
转速
 rev string

modEventViewDetail

名称 路径 类型 说明
id
 id integer

审查事件的唯一标识符。
类型
 event.type string

事件类型。
类型
 subject.type string

主题的类型。
subjectBlobs
 subjectBlobs array of blobView

有关与主题关联的 Blob 的详细信息。
createdBy
 createdBy string

创建事件的用户的 DID。
createdAt
 createdAt date-time

创建事件的时间戳。

blobView

名称 路径 类型 说明
cid
 cid string

Blob 的内容标识符。
MIME类型
 mimeType string

Blob 的 MIME 类型。
size
 size integer

blob 的大小（以字节为单位）。
createdAt
 createdAt date-time

创建 Blob 时的时间戳。
类型
 details.type string

Blob 详细信息的类型。
图片详情
 details.imageDetails imageDetails
videoDetails
 details.videoDetails videoDetails
moderation
 moderation moderation

图片详情

名称 路径 类型 说明
width
 width integer

图像的宽度（以像素为单位）。
身高
 height integer

图像的高度（以像素为单位）。

videoDetails

名称 路径 类型 说明
width
 width integer

视频的宽度（以像素为单位）。
身高
 height integer

视频的高度（以像素为单位）。
length
 length integer

视频长度（以秒为单位）。

recordViewDetail

名称 路径 类型 说明
uri
 uri string
cid
 cid string
value
 value
blobs
 blobs array of blobView
labels
 labels array of label
indexedAt
 indexedAt date-time
moderation
 moderation moderationDetail
存储库
 repo repoView

moderationDetail

名称 路径 类型 说明
subjectStatus
 subjectStatus subjectStatusView

repoViewDetail

名称 路径 类型 说明
did
 did string
句柄
 handle string
电子邮件
 email string
relatedRecords
 relatedRecords array of
indexedAt
 indexedAt date-time
moderation
 moderation moderationDetail
labels
 labels array of label
invitedBy
 invitedBy inviteCode
邀请
 invites array of inviteCode
invitesDisabled
 invitesDisabled boolean
inviteNote
 inviteNote string
emailConfirmedAt
 emailConfirmedAt date-time
deactivatedAt
 deactivatedAt date-time
threatSignatures
 threatSignatures array of threatSignature

成员

名称 路径 类型 说明
did
 did string
禁用的
 disabled boolean
个人资料
 profile profileViewDetailed
createdAt
 createdAt date-time
updatedAt
 updatedAt date-time
lastUpdatedBy
 lastUpdatedBy string
角色
 role string

listMissingBlobs.recordBlob

名称 路径 类型 说明
cid
 cid string
recordUri
 recordUri string

listRecords.record

名称 路径 类型 说明
uri
 uri string
cid
 cid string
value
 value

listRepos.repo

名称 路径 类型 说明
did
 did string
头
 head string

当前存储库提交 CID
转速
 rev string
活跃
 active boolean
状态
 status string

True 或 false 值，指示帐户为何处于非活动状态。

setView

名称 路径 类型 说明
姓名
 name string
描述
 description string
setSize
 setSize integer
createdAt
 createdAt date-time
updatedAt
 updatedAt date-time

sigDetail

名称 路径 类型 说明
属性
 property string
value
 value string

findRelatedAccounts.relatedAccount

名称 路径 类型 说明
帐户
 account accountView
相似 之 处
 similarities array of sigDetail

二进制

这是基本数据类型“binary”。

文件

这是基本数据类型“file”。