Partilhar via


Bluesky Social (Editora Independente) (Pré-visualização)

Especificação para os endpoints Bluesky Social. Inclui endpoints para interação soprocial, admin, chat, ATProto e ozônio.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Dan Romano
Email dan.romano@swolcat.com
Metadados do conector
Editora Krautrocker
Sítio Web https://docs.bsky.app/
Política de privacidade https://example.com/privacy-policy
Categorias Redes Sociais

Conector API Bluesky

  • **Este conector personalizado permite que os aplicativos da Power Platform interajam com a API da Bluesky, suportando operações para gerenciar feeds, conversas, notificações, uploads de vídeo e dados da conta.

Editora: Dan Romano

Pré-requisitos

  • **Para utilizar este conector, necessitará de:

    • **Uma conta Bluesky.
    • **Acesso API ao Bluesky com App Password.

Operações suportadas

  • **Este conector inclui as seguintes operações:

Pontos de extremidade de feed

  • **GET /app.bsky.feed.getTimeline Recupere as postagens da linha do tempo de um usuário.
  • **GET /app.bsky.feed.getFeed Recupere postagens de um feed ou tag específico.
  • **GET /app.bsky.feed.searchPosts Pesquise publicações que correspondam a uma consulta.
  • **GET /app.bsky.feed.getActorFeeds Recuperar feeds postados por um ator específico.
  • **GET /app.bsky.feed.getActorLikes Recuperar posts curtidos por um ator específico.
  • **GET /app.bsky.feed.getAuthorFeed Recuperar posts do feed de um autor específico.
  • **GET /app.bsky.feed.getFeedGenerator Recupere um feed gerado para um usuário.
  • **GET /app.bsky.feed.getFeedGenerators Recupere metadados sobre todos os geradores de feed.
  • **GET /app.bsky.feed.getFeedSkeleton Recupere uma versão esquelética mínima de um feed.
  • **GET /app.bsky.feed.getListFeed Recuperar posts de uma lista específica.
  • **GET /app.bsky.feed.getPosts Recupere uma lista de postagens específicas por seus IDs.
  • **GET /app.bsky.feed.getPostThread Recupere o segmento de postagens relacionadas a uma postagem específica.
  • **GET /app.bsky.feed.getLikes Recupere usuários que curtiram uma publicação específica.
  • **GET /app.bsky.feed.getQuotes Recupere posts que citam uma postagem específica.
  • **GET /app.bsky.feed.getRepostedBy Recuperar usuários que repostaram uma postagem específica.
  • **GET /app.bsky.feed.getSuggestedFeeds Recupere feeds sugeridos para o usuário.
  • **POST /app.bsky.feed.sendInteractions Enviar interações (curtir ou repostar) para uma postagem.

Pontos finais do ator

  • **GET /app.bsky.ator.getPreferences Recupere as preferências do usuário.
  • **GET /app.bsky.ator.getProfile Recupere o perfil de um usuário específico.
  • **GET /app.bsky.ator.getProfiles Recupere vários perfis de usuário.
  • **GET /app.bsky.ator.getSuggestions Recuperar sugestões de conta para o usuário.
  • **POST /app.bsky.ator.putPreferences Atualize as preferências do usuário.
  • **GET /app.bsky.ator.searchActors Pesquise contas de usuário por consulta.
  • **GET /app.bsky.ator.searchActorsTypeahead Recupere sugestões de pesquisa para contas de usuário.

Pontos finais do gráfico

  • **GET /app.bsky.graph.getActorStarterPacks Recupere pacotes iniciais de contas para um novo usuário.
  • **GET /app.bsky.graph.getKnownFollowers Obtenha seguidores conhecidos pelo usuário autenticado.
  • **GET /app.bsky.graph.getFollowers Recupere uma lista de seguidores para um usuário.
  • **GET /app.bsky.graph.getFollows Recuperar usuários seguidos por um usuário específico.
  • **GET /app.bsky.graph.getBlocks Recuperar usuários bloqueados pelo usuário autenticado.
  • **GET /app.bsky.graph.getList Recupere uma lista específica de usuários.
  • **GET /app.bsky.graph.getLists Recupere todas as listas para o usuário autenticado.
  • **GET /app.bsky.graph.getListBlocks Recuperar usuários bloqueados dentro de uma lista específica.
  • **GET /app.bsky.graph.getListMutes Recuperar listas silenciadas para o usuário autenticado.
  • **GET /app.bsky.graph.getMutes Recuperar usuários silenciados.
  • **GET /app.bsky.graph.getRelationships Recuperar relações entre o usuário autenticado e contas especificadas.
  • **GET /app.bsky.graph.getStarterPack Recupere um único pacote inicial para um novo usuário.
  • **GET /app.bsky.graph.getStarterPacks Recupere todos os pacotes iniciais para novos usuários.
  • **GET /app.bsky.graph.getSuggestedFollowsByActor Recupere contas sugeridas a seguir, filtradas por um ator.
  • **POST /app.bsky.graph.muteActor Silenciar um ator específico.
  • **POST /app.bsky.graph.unmuteActor Desative o mudo de um ator específico.
  • **POST /app.bsky.graph.muteActorList Silencie uma lista específica de atores.
  • **POST /app.bsky.graph.unmuteActorList Desative o mudo de uma lista específica de atores.
  • **POST /app.bsky.graph.muteThread Silencie um thread inteiro de posts.
  • **POST /app.bsky.graph.unmuteThread Remova o mudo de um thread inteiro de posts.

Pontos finais do rotulador

  • **GET /app.bsky.labeler.getServices Recupere a lista de serviços de etiquetagem disponíveis para o usuário.

Pontos finais de notificação

  • **GET /app.bsky.notification.getUnreadCount Recupere a contagem de notificações não lidas.
  • **GET /app.bsky.notification.listNotifications List notifications para o usuário autenticado.
  • **POST /app.bsky.notification.putPreferences Atualize as preferências de notificação.
  • **POST /app.bsky.notification.registerPush Register para notificações push.
  • **POST /app.bsky.notification.updateSeen Marque as notificações como vistas.

Pontos finais de vídeo

  • **GET /app.bsky.video.getJobStatus Recupere o status de um trabalho de upload de vídeo.
  • **GET /app.bsky.video.getUploadLimits Recupere os limites de upload de vídeo para o usuário.
  • **POST /app.bsky.video.uploadVideo Carregue um arquivo de vídeo.

chat.bsky Parâmetros de avaliação

  • **DELETE /chat.bsky.ator.deleteAccount Exclua permanentemente a conta de um ator e os dados associados.
  • **GET /chat.bsky.ator.exportAccountData Exporte dados da conta para um ator específico.
  • **DELETE /chat.bsky.convo.deleteMessageForSelf Exclua uma mensagem apenas da visualização do usuário.
  • **GET /chat.bsky.convo.getConvo Recupere uma conversa específica.
  • **GET /chat.bsky.convo.getConvoForMembers Obtenha uma conversa entre membros específicos.
  • **GET /chat.bsky.convo.getLog Recupere o log de uma conversa.
  • **GET /chat.bsky.convo.getMessages Recuperar mensagens dentro de uma conversa.
  • **POST /chat.bsky.convo.leaveConvo Deixe uma conversa.
  • **GET /chat.bsky.convo.listConvos Liste todas as conversas de um usuário.
  • **POST /chat.bsky.convo.muteConvo Silenciar notificações para uma conversa.
  • **POST /chat.bsky.convo.sendMessage Envie uma mensagem em uma conversa.
  • **POST /chat.bsky.convo.sendMessageBatch Envie várias mensagens em um lote.
  • **POST /chat.bsky.convo.unmuteConvo Unmute notifications for a conversation.
  • **POST /chat.bsky.convo.updateLeia Marque uma conversa como lida.
  • **GET /chat.bsky.moderation.getActorMetadata Recuperar metadados associados ao status de moderação de um ator.
  • **GET /chat.bsky.moderation.getMessageContext Recuperar contexto para moderação de uma mensagem.
  • **POST /chat.bsky.moderation.updateActorAccess Atualize as permissões de acesso para um ator especificado.

com.atproto.admin Parâmetros de avaliação

  • **DELETE /com.atproto.admin.deleteAccount Exclua permanentemente uma conta.
  • **POST /com.atproto.admin.disableAccountInvites Desativar convites para uma conta.
  • **POST /com.atproto.admin.disableInviteCodes Desative os códigos de convite.
  • **POST /com.atproto.admin.enableAccountInvites Ativar convites para uma conta.
  • **GET /com.atproto.admin.getAccountInfo Obtenha informações sobre uma conta específica.
  • **GET /com.atproto.admin.getAccountInfos Recupere informações sobre várias contas.
  • **GET /com.atproto.admin.getInviteCodes Recuperar códigos de convite para uma conta.
  • **GET /com.atproto.admin.getSubjectStatus Recuperar informações de status de um assunto.
  • **GET /com.atproto.admin.searchAccounts Pesquise contas.
  • **POST /com.atproto.admin.sendEmail Envie um e-mail para uma conta.
  • **POST /com.atproto.admin.updateAccountEmail Atualize o endereço de e-mail associado a uma conta.
  • **POST /com.atproto.admin.updateAccountHandle Atualize o identificador associado a uma conta.
  • **POST /com.atproto.admin.updateAccountPassword Atualize a senha de uma conta.
  • **POST /com.atproto.admin.updateSubjectStatus Status de um assunto.

com.atproto.identity Parâmetros de avaliação

  • **GET /com.atproto.identity.getRecommendedDidCredentials Recuperar credenciais DID recomendadas.
  • **POST /com.atproto.identity.requestPlcOperationSignature Solicite uma assinatura para uma operação PLC.
  • **GET /com.atproto.identity.resolveHandle Resolva um identificador de conta.
  • **POST /com.atproto.identity.signPlcOperation Assinar uma operação PLC.
  • **POST /com.atproto.identity.submitPlcOperation Envie uma operação PLC.
  • **POST /com.atproto.identity.updateHandle Atualize o identificador para uma identidade.

com.atproto.label Parâmetros de avaliação

  • **GET /com.atproto.label.queryLabels Consulta de rótulos para conteúdo ou atores.

com.atproto.moderation Parâmetros de avaliação

  • **POST /com.atproto.moderation.createReport Crie um relatório para moderação.
  • **GET /com.atproto.moderation.getActorMetadata Recupere metadados para fins de moderação.

com.atproto.repo Parâmetros de avaliação

  • **POST /com.atproto.repo.applyWrites Apply grava em um repositório.
  • **POST /com.atproto.repo.createRecord Crie um registro em um repositório.
  • **DELETE /com.atproto.repo.deleteRecord Exclua um registro de um repositório.
  • **GET /com.atproto.repo.describeRepo Descreva um repositório.
  • **GET /com.atproto.repo.getRecord Recupere um registro por ID.
  • **POST /com.atproto.repo.importRepo Importe dados para um repositório.
  • **GET /com.atproto.repo.listMissingBlobs List blobs ausentes.
  • **GET /com.atproto.repo.listRecords Liste todos os registros em um repositório.
  • **POST /com.atproto.repo.putRecord Atualize um registro no repositório.
  • **POST /com.atproto.repo.uploadBlob Carregue um blob binário para um repositório.

com.atproto.server Parâmetros de avaliação

  • **POST /com.atproto.server.activateAccount Ative uma conta.
  • **GET /com.atproto.server.checkAccountStatus Verifique o status da conta.
  • **POST /com.atproto.server.confirmEmail Confirme um endereço de e-mail.
  • **POST /com.atproto.server.createAccount Crie uma nova conta.
  • **POST /com.atproto.server.createAppPassword Crie uma senha específica do aplicativo.
  • **POST /com.atproto.server.createInviteCode Crie um único código de convite.
  • **POST /com.atproto.server.createInviteCodes Crie vários códigos de convite.
  • **POST /com.atproto.server.createSession Crie uma sessão.
  • **POST /com.atproto.server.deactivateAccount Desative uma conta.
  • **DELETE /com.atproto.server.deleteAccount Excluir permanentemente uma conta.
  • **DELETE /com.atproto.server.deleteSession Exclua uma sessão.
  • **GET /com.atproto.server.describeServer Descreva as informações do servidor.
  • **GET /com.atproto.server.getAccountInviteCodes Recuperar códigos de convite para uma conta.
  • **GET /com.atproto.server.getServiceAuth Recuperar informações de autenticação do serviço.
  • **GET /com.atproto.server.getSession Recuperar informações da sessão.
  • **GET /com.atproto.server.listAppPasswords Listar senhas específicas do aplicativo.
  • **POST /com.atproto.server.refreshSession Atualize uma sessão.
  • **POST /com.atproto.server.requestAccountDelete Solicitar exclusão de uma conta.
  • **POST /com.atproto.server.requestEmailConfirmation: Solicitar confirmação por e-mail.
  • **POST /com.atproto.server.requestEmailUpdate Solicitar atualização de e-mail.
  • **POST /com.atproto.server.requestPasswordReset Redefinição de senha de solicitação.
  • **POST /com.atproto.server.reserveSigningKey Reserve uma chave de assinatura.
  • **POST /com.atproto.server.resetPassword Redefinir senha.
  • **POST /com.atproto.server.revokeAppPassword Revogar uma senha específica do aplicativo.
  • **POST /com.atproto.server.updateEmail Atualize o e-mail associado a uma conta.

com.atproto.sync Parâmetros de avaliação

  • **GET /com.atproto.sync.getBlob Recuperar um blob por ID.
  • **GET /com.atproto.sync.getBlocks Recuperar blocos por ID.
  • **GET /com.atproto.sync.getLatestCommit Obtenha a confirmação mais recente.
  • **GET /com.atproto.sync.getRecord Recupere um registro para sincronização.
  • **GET /com.atproto.sync.getRepo Recupere dados do repositório para sincronização.
  • **GET /com.atproto.sync.getRepoStatus Recuperar status do repositório.
  • **GET /com.atproto.sync.listBlobs Listar blobs em um repositório.
  • **GET /com.atproto.sync.listRepos Listar repositórios para sincronização.
  • **POST /com.atproto.sync.notifyOfUpdate Notifique uma atualização no sistema.
  • **POST /com.atproto.sync.requestCrawl Solicite um rastreamento para sincronização.

tools.ozone.communication Parâmetros de avaliação

  • **POST /tools.ozone.communication.createTemplate Crie um modelo de comunicação.
  • **DELETE /tools.ozone.communication.deleteTemplate Exclua um modelo de comunicação.
  • **GET /tools.ozone.communication.listTemplates Listar modelos de comunicação.
  • **POST /tools.ozone.communication.updateTemplate Atualize um modelo de comunicação.

tools.ozone.moderation Parâmetros de avaliação

  • **POST /tools.ozone.moderation.emitEvent Emita um evento de moderação.
  • **GET /tools.ozone.moderation.getEvent Recuperar um evento de moderação específico.
  • **GET /tools.ozone.moderation.getRecord Recupere um registro de moderação.
  • **GET /tools.ozone.moderation.getRecords List registros de moderação.
  • **GET /tools.ozone.moderation.getRepo Recupere informações de moderação para um repositório.
  • **GET /tools.ozone.moderation.getRepos Recupere dados de moderação para vários repositórios.
  • **GET /tools.ozone.moderation.queryEvents Eventos de moderação de consulta.
  • **GET /tools.ozone.moderation.queryStatuses Consultar estados de moderação.
  • **POST /tools.ozone.moderation.searchRepos Pesquise repositórios para moderação.

tools.ozone.server Parâmetros de avaliação

  • **GET /tools.ozone.server.getConfig Recuperar informações de configuração do servidor.

tools.ozone.set Parâmetros de avaliação

  • **POST /tools.ozone.set.addValues Adicione valores a um conjunto.
  • **DELETE /tools.ozone.set.deleteSet Excluir um conjunto especificado.
  • **DELETE /tools.ozone.set.deleteValues Exclua valores específicos de um conjunto.
  • **GET /tools.ozone.set.getValues Recuperar valores de um conjunto.
  • **GET /tools.ozone.set.querySets Conjuntos de consultas baseados em filtros.
  • **POST /tools.ozone.set.upsertSet Crie ou atualize um conjunto.

tools.ozone.signature Parâmetros de avaliação

  • **GET /tools.ozone.signature.findCorrelation Encontre correlações relacionadas a uma assinatura.
  • **GET /tools.ozone.signature.findRelatedAccounts Encontre contas relacionadas a uma assinatura.
  • **GET /tools.ozone.signature.searchAccounts Pesquise contas por assinatura.

tools.ozone.team Parâmetros de avaliação

  • **POST /tools.ozone.team.addMember Adicione um membro a uma equipa.
  • **DELETE /tools.ozone.team.deleteMember Remova um membro de uma equipe.
  • **GET /tools.ozone.team.listMembros Listar membros em uma equipe.
  • **POST /tools.ozone.team.updateMember Update informações do membro da equipe.

Pontos finais não especificados

  • **POST /app.bsky.unspecced.uploadBlob Carregue um blob binário na conta do usuário.
  • **GET /app.bsky.unspecced.getBlob Recupere um blob binário da conta do usuário.

Obtenção de credenciais

  • Vá para o Bluesky Developer Portal.
  • Gere uma senha de aplicativo em "Configurações da conta".
  • Salve a senha do aplicativo para uso na configuração do conector.

Introdução

  • **Alguns pontos finais requerem parâmetros específicos (como IDs de ator/utilizador, por exemplo).

    • **Autenticar: Comece autenticando com suas credenciais Bluesky.
    • **Escolha o ponto de extremidade: selecione o ponto de extremidade desejado, como recuperar um feed ou listar notificações.
    • **Definir parâmetros: Forneça os parâmetros necessários, como IDs de usuário, limites ou cadeias de caracteres de consulta.
    • **Executar solicitação: execute a solicitação para recuperar dados ou executar ações em seu aplicativo Power Platform.

Problemas conhecidos e limitações

Perguntas Frequentes

  • P: Como posso gerar uma palavra-passe de aplicação?
    R: Visite o Bluesky Developer Portal e gere uma nova senha de aplicativo. Use a senha para gerar um token.

  • P: Quais são os limites de taxa de API?
    R: Bluesky impõe um limite de taxa de 100 solicitações por minuto por conta.

  • P: Quais são alguns termos e definições úteis, como ator ou DID?
    Um: Termos úteis para saber:

    • Ator: Uma entidade, normalmente um usuário, que interage com o sistema. Isso pode representar uma pessoa, organização ou sistema automatizado.
    • Pacote inicial: Um conjunto selecionado de contas ou conteúdo sugerido projetado para ajudar novos usuários a começar a usar a plataforma.
    • Assinatura: Uma prova criptográfica usada para verificar a autenticidade e integridade de uma transação ou operação dentro do sistema.
    • PLC (Cadeia Ligada Pessoal): Uma estrutura semelhante a um blockchain usada para manter um histórico verificável de operações de conta (por exemplo, lidar com atualizações, rotações de chave). Garante transparência e fiabilidade.
    • DID (Identificador Descentralizado): Um identificador global exclusivo para um ator que não está vinculado a um registro centralizado. Os DIDs são fundamentais para a natureza descentralizada do Bluesky.

Support

  • **dan.romano@swolcat.com ou torin@imp.sh (proprietário original)

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar um membro da equipa

Adicione um membro à equipa de ozono.

Adicionar valores a um conjunto

Adicione valores a um conjunto específico.

Aplicar gravações no repositório

Aplique uma transação em lote de cria, atualiza e exclui repositórios.

Ativar Conta

Ativa uma conta atualmente desativada.

Ativar convites de conta

Reative a capacidade de uma conta de receber códigos de convite.

Ativar Mudo de Conversa

Desative o som de uma conversa.

Ativar Mudo Lista de Atores

Desativa o mudo da lista de contas especificada.

Ativar thread

Desativa o mudo do thread especificado.

Ator mudo

Cria uma relação de mudo para a conta especificada.

Atualizar e-mail

Atualize o e-mail de uma conta.

Atualizar e-mail da conta

Ação administrativa para atualizar o e-mail de uma conta.

Atualizar identificador de conta

Ação administrativa para atualizar o identificador de uma conta.

Atualizar o acesso do ator

Atualize as permissões de acesso de um ator.

Atualizar palavra-passe da conta

Atualize a senha de uma conta de usuário como administrador.

Atualizar sessão de autenticação

Atualize uma sessão de autenticação para obter um novo token de acesso e um token de atualização.

Atualizar status de leitura da conversa

Atualize um item em uma conversa para marcá-lo como lido.

Atualizar status do assunto

Atualize o status de administrador específico do serviço de um assunto.

Atualizar um membro no serviço de ozônio

Atualize um membro no serviço de ozônio.

Atualizar um modelo de comunicação existente

Ação administrativa para atualizar um modelo de comunicação existente.

Carregar um novo blob

Carregue um novo blob.

Carregar vídeo

Carregue um vídeo para ser processado e armazenado no PDS.

Chave de assinatura de reserva

Reserve uma chave de assinatura de repositório para uso com a criação de conta.

Confirmar e-mail

Confirme um e-mail usando um token gerado pelo processo requestEmailConfirmation.

Consultar conjuntos disponíveis

Consultar conjuntos disponíveis.

Contar o número de notificações não lidas para a conta solicitante

Conte o número de notificações não lidas para a conta solicitante.

Criar Conta

Crie uma conta com os detalhes fornecidos.

Criar código de convite

Crie um código de convite para casos de uso especificados.

Criar códigos de convite

Crie vários códigos de convite com limites de uso especificados.

Criar ou atualizar metadados do conjunto

Crie ou atualize metadados do conjunto.

Criar palavra-passe da aplicação

Crie uma senha de aplicativo.

Criar relatório

Envie um relatório de moderação sobre uma conta ou registro atproto. Implementado por serviços de moderação (com proxy PDS), e requer auth.

Criar sessão de autenticação

Criar uma sessão de autenticação

Criar um modelo de comunicação reutilizável

Ação do administrador para criar um novo modelo de comunicação reutilizável.

Criar um único novo registro de repositório

Crie um único novo registro de repositório.

Definir preferências de conta

Defina as preferências privadas associadas à conta.

Definir preferências de notificação

Defina preferências relacionadas a notificações para uma conta.

Desativar conta

Desativa uma conta atualmente ativa após a migração ser finalizada.

Desativar códigos de convite

Desative códigos de convite específicos para evitar mais uso.

Descrever o servidor

Descreve os requisitos e os recursos de criação de conta do servidor.

Download da exportação do repositório

Faça o download de uma exportação de repositório como arquivo CAR.

Eliminar um membro da equipa de ozono

Exclua um membro da equipe de ozônio.

Encontrar atores (perfis) que correspondam aos critérios de pesquisa

Encontre atores (perfis) que correspondam aos critérios de pesquisa.

Encontrar contas relacionadas

Obtenha contas que compartilham algumas assinaturas de ameaças correspondentes com a conta root.

Encontrar correlação de assinaturas de ameaças

Encontre todas as assinaturas de ameaças correlacionadas entre 2 ou mais contas.

Encontre rótulos relevantes para os padrões de AT-URI fornecidos

Encontre rótulos relevantes para os padrões de AT-URI fornecidos.

Enviar e-mail para o endereço de e-mail da conta de um usuário

Enviar e-mail para o endereço de e-mail da conta de um usuário.

Enviar interações

Envie informações sobre interações.

Enviar Mensagem

Envie uma única mensagem para uma conversa específica.

Enviar mensagens em lote

Envie um lote de mensagens para várias conversas.

Excluir conta

Exclua uma conta de usuário como administrador.

Excluir conta

Exclua a conta de um ator com um token e senha.

Excluir conta

Excluir uma conta.

Excluir mensagem para si mesmo

Exclua uma mensagem do usuário que a enviou.

Excluir sessão

Exclua a sessão atual.

Excluir um conjunto

Exclua um conjunto inteiro.

Excluir um modelo de comunicação

Exclua um modelo de comunicação por sua ID exclusiva.

Excluir um registro de repositório ou garantir que ele não exista

Exclua um registro de repositório ou verifique se ele não existe.

Excluir valores de um conjunto

Excluir valores de um conjunto específico.

Exportar dados da conta

Exportar dados da conta.

GetRecommendedDidCredentials

Descreva as credenciais que devem ser incluídas no documento DID de uma conta que está migrando para este serviço.

Gravar um registro de repositório

Escreva um registro de repositório, criando-o ou atualizando-o conforme necessário.

Importar um repositório na forma de um arquivo CAR

Importe um repositório na forma de um arquivo CAR. Cabeçalho Content-Length necessário.

Lista de todos os membros com acesso ao serviço de ozono

Listar todos os membros com acesso ao serviço de ozono.

Listar blobs ausentes para a conta solicitante

Retorna uma lista de blobs ausentes para a conta solicitante.

Listar CIDs de blob de conta

Listar CIDs de blob de conta desde uma revisão de repo.

Listar conversas

Listar conversas.

Listar eventos de moderação relacionados a um assunto

Listar eventos de moderação relacionados a um assunto.

Listar notificações

Enumerar notificações para a conta solicitante.

Listar registros em um repositório

Liste um intervalo de registros em um repositório, correspondendo a uma coleção específica.

Listar repositórios

Enumera todos os CID DID, rev e commit para todos os repositórios

Listar senhas de aplicativos

Liste todas as senhas de aplicativos.

Localizar repositórios com base num termo de pesquisa

Encontre repositórios com base em um termo de pesquisa.

Notificar a atualização

Notifique um serviço de rastreamento sobre uma atualização recente e esse rastreamento deve ser retomado.

Notificar o servidor de que a conta solicitante recebeu notificações

Notifique o servidor de que a conta solicitante viu notificações.

Obtenha uma lista de pacotes iniciais criados pelo ator

Obtenha uma lista de pacotes iniciais criados pelo ator.

Obter a confirmação atual de um repositório

Obtenha o CID de confirmação atual e a revisão do repositório especificado.

Obter Atores Sugeridos

Obtenha uma lista de atores sugeridos.

Obter blocos de dados de um repositório

Obter blocos de dados de um determinado repositório, por CID.

Obter configuração do servidor

Obtenha detalhes sobre a configuração do servidor de ozono.

Obter contexto de mensagem

Buscar mensagens ao redor de uma conversa

Obter conversa

Obtenha uma conversa com base no ID de conversação fornecido.

Obter Convo para Membros

Obtenha uma conversa para um ou vários membros.

Obter códigos de convite

Obtenha uma vista de administrador dos códigos de convite.

Obter códigos de convite de conta

Obtenha todos os códigos de convite para a conta corrente.

Obter detalhes de status para um trabalho de processamento de vídeo

Obtenha detalhes de status para um trabalho de processamento de vídeo.

Obter detalhes sobre alguns registos

Obtenha detalhes sobre alguns registros.

Obter detalhes sobre um evento de moderação

Obtenha detalhes sobre um evento de moderação.

Obter detalhes sobre um registo

Obtenha detalhes sobre um registo.

Obter detalhes sobre um repositório

Obtenha detalhes sobre um repositório.

Obter feed

Obtenha uma alimentação hidratada do gerador de alimentação selecionado por um ator.

Obter feed de lista

Obtenha um feed de publicações recentes de uma lista.

Obter feed do autor

Obtenha uma visão do "feed do autor" de um ator.

Obter Feed Skeleton

Obtenha um esqueleto de uma alimentação fornecida por um gerador de alimentação.

Obter feeds de atores

Obtenha uma lista de feeds criados pelo ator.

Obter feeds sugeridos

Recupere uma lista de feeds sugeridos para a conta solicitante.

Obter Gostos

Obtenha registros semelhantes que fazem referência a um assunto (por AT-URI e CID).

Obter informações da conta

Obtenha detalhes sobre uma conta.

Obter informações da conta

Obtenha detalhes sobre algumas contas.

Obter informações da sessão atual

Obtenha informações sobre a sessão autenticada.

Obter informações do gerador de alimentação

Obtenha informações sobre um gerador de alimentação.

Obter informações sobre geradores de alimentação

Obtenha informações sobre uma lista de geradores de alimentação.

Obter informações sobre um feed

Obtenha informações sobre um gerador de alimentação.

Obter informações sobre uma conta e repositório

Obtenha informações sobre uma conta e um repositório, incluindo a lista de coleções.

Obter informações sobre uma lista de serviços de etiquetagem

Obtenha informações sobre uma lista de serviços de rotulagem.

Obter limites de upload de vídeo para o usuário autenticado

Obtenha limites de upload de vídeo para o usuário autenticado.

Obter Linha do Tempo

Obtenha uma visão da linha do tempo inicial da conta solicitante.

Obter lista de modelos de comunicação

Recupere uma lista de todos os modelos de comunicação disponíveis.

Obter listas

Enumera as listas criadas por uma conta especificada.

Obter Listas de Bloqueios

Obter listas de mod que a conta solicitante (ator) está bloqueando.

Obter listas silenciadas

Obter listas de mod que a conta solicitante tem silenciado no momento.

Obter Log

Recupere o registro de ações e mensagens em uma conversa.

Obter metadados do ator

Buscar metadados relacionados à moderação para um ator via DID

Obter Mudos

Enumera as contas que a conta solicitante silenciou no momento.

Obter Orçamentos

Obtenha uma lista de citações para um determinado post.

Obter Pacotes Iniciais

Obtenha visualizações detalhadas para obter uma lista de pacotes iniciais com base nos URIs fornecidos.

Obter perfil

Recupere uma visualização de perfil detalhada de um ator usando seu identificador ou DID.

Obter perfis

Obtenha visualizações detalhadas do perfil de vários atores.

Obter Post Thread

Receba publicações em um tópico.

Obter Posts

Obtém visualizações de postagem para uma lista especificada de postagens.

Obter preferências

Obtenha preferências privadas associadas à conta corrente.

Obter relações públicas entre uma conta e uma lista de outras contas

Obtenha relações públicas entre uma conta e uma lista de outras contas.

Obter repositórios de moderação

Obtenha uma lista de todos os repositórios de moderação.

Obter seguidores

Enumere contas que seguem um ator especificado.

Obter Seguidores

Enumera contas que um ator especificado segue.

Obter seguidores conhecidos

Recupere seguidores para uma conta específica que também são seguidos pelo visualizador.

Obter Starter Pack

Obtém uma visão de um pacote inicial com base na referência fornecida (AT-URI).

Obter status de hospedagem do repositório

Obtenha o status de hospedagem de um repositório, neste servidor.

Obter sugestões de seguidores por ator

Enumera segue semelhante a uma determinada conta.

Obter token de autenticação de serviço

Obtenha um token assinado em nome do DID solicitante para o serviço solicitado.

Obter um blob associado a uma conta

Obtenha um blob associado a uma determinada conta.

Obter um registro do repositório

Recupere um registro do repositório por seu identificador exclusivo.

Obter um único registro de um repositório

Obtenha um único registro de um repositório.

Obter uma lista de posts curtidos por um ator

Obtenha uma lista de posts curtidos por um ator.

Obter valores definidos

Obtenha um conjunto específico e seus valores.

Obter vista de lista

Obtém uma 'vista' (com contexto adicional) de uma lista especificada.

Pesquisar Atores para Typeahead

Recupere sugestões de conta para pesquisa de digitação.

Pesquisar Contas

Obtenha uma lista de contas que corresponda à sua consulta de pesquisa.

Pesquisar Posts

Encontre publicações que correspondam aos critérios de pesquisa, retornando visualizações dessas publicações.

Receber mensagens

Obtenha uma lista de mensagens de uma conversa específica.

Recuperar visualização de registro

Retorna informações de esquema dinâmico para a exibição de registro.

Redefinir Palavra-passe

Redefina a senha de uma conta de usuário usando um token.

Registe-se para receber notificações push

Registe-se para receber notificações push.

RequestPlcOperationSignature

Solicite um e-mail com um código para solicitar uma operação de PLC assinada.

ResolveHandle

Resolve um identificador (nome de domínio) para um DID.

Revogar senha do aplicativo

Revogue uma senha de aplicativo pelo nome.

Sair da conversa

Saia de uma conversa especificando seu ID.

Seja repostado por

Obtenha uma lista de republicações para uma determinada publicação.

SignPlcOperation

Assina uma operação de PLC para atualizar alguns(s) valor(es) no documento do DID solicitante.

Silenciar conversa

Silencie uma conversa.

Silenciar Lista de Atores

Cria uma relação de mudo para a lista de contas especificada.

Silenciar thread

Silencia um thread impedindo notificações do thread e de qualquer um de seus filhos.

Solicitar atualização por e-mail

Solicite um token para atualizar o e-mail.

Solicitar confirmação por e-mail

Solicite um e-mail com um código para confirmar a propriedade do e-mail.

Solicitar exclusão de conta

Inicie a exclusão de uma conta de usuário por e-mail.

Solicitar rastreamento

Solicite um serviço para rastrear persistentemente repositórios hospedados.

Solicitar redefinição de senha

Inicie uma redefinição de senha de conta de usuário por e-mail.

SubmitPlcOperation

Valida uma operação de PLC para garantir que ela não viole as restrições de um serviço.

Tome uma ação de moderação em um ator

Tome uma ação de moderação em um ator

Unmute Ator

Cancela o mudo da conta especificada.

UpdateHandle

Atualiza o identificador da conta atual. Verifica a validade do identificador e atualiza o documento did:plc, se necessário.

Ver estados de moderação de assuntos

Veja os estados de moderação dos assuntos (record ou repo).

Verificar o status da conta

Devolve o estado de uma conta, especialmente no que diz respeito à importação ou recuperação.

Adicionar um membro da equipa

Adicione um membro à equipa de ozono.

Parâmetros

Name Chave Necessário Tipo Description
fez
did True string

O DID do membro a acrescentar.

função
role True string

Papel do membro a adicionar.

Devoluções

Body
member

Adicionar valores a um conjunto

Adicione valores a um conjunto específico.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string

Nome do conjunto a que adicionar valores

values
values True array of string

Valores a adicionar ao conjunto

Aplicar gravações no repositório

Aplique uma transação em lote de cria, atualiza e exclui repositórios.

Devoluções

Name Caminho Tipo Description
consolidação
commit commitMeta
results
results array of applyWrites.result

Ativar Conta

Ativa uma conta atualmente desativada.

Ativar convites de conta

Reative a capacidade de uma conta de receber códigos de convite.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de conta
account True string

A conta/DID para a qual os convites estão sendo habilitados.

Motivo da habilitação
note string

Motivo opcional para ativar convites.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

mensagem
message string

Mensagem opcional detalhando o resultado.

Ativar Mudo de Conversa

Desative o som de uma conversa.

Parâmetros

Name Chave Necessário Tipo Description
convoId
convoId True string

O ID da conversa a ser desativado.

Devoluções

Name Caminho Tipo Description
Modo de Exibição de Conversa
convo convoView

Representa uma exibição de uma conversa.

Ativar Mudo Lista de Atores

Desativa o mudo da lista de contas especificada.

Parâmetros

Name Chave Necessário Tipo Description
URI de lista
list True string

O URI da lista a ser desativado.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

Ativar thread

Desativa o mudo do thread especificado.

Parâmetros

Name Chave Necessário Tipo Description
URI de thread raiz
root True string

O URI do thread raiz a ser desativado.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

Ator mudo

Cria uma relação de mudo para a conta especificada.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de conta
actor True string

Identificador da conta a ser silenciada.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

Atualizar e-mail

Atualize o e-mail de uma conta.

Parâmetros

Name Chave Necessário Tipo Description
e-mail
email True string

O novo endereço de e-mail com o qual atualizar a conta.

emailAuthFactor
emailAuthFactor boolean

Se o e-mail é usado como um fator de autenticação.

token
token string

Um token de requestEmailUpdate se o e-mail da conta tiver sido confirmado.

Atualizar e-mail da conta

Ação administrativa para atualizar o e-mail de uma conta.

Parâmetros

Name Chave Necessário Tipo Description
conta
account True string

A alça ou DID do repo.

e-mail
email True string

O novo endereço de e-mail da conta.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a atualização foi bem-sucedida.

mensagem
message string

Mensagem opcional com informações adicionais.

Atualizar identificador de conta

Ação administrativa para atualizar o identificador de uma conta.

Parâmetros

Name Chave Necessário Tipo Description
fez
did True string

O DID da conta.

alça
handle True string

O novo identificador para a conta.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a atualização foi bem-sucedida.

mensagem
message string

Mensagem opcional com informações adicionais.

Atualizar o acesso do ator

Atualize as permissões de acesso de um ator.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string
Permitir acesso
allowAccess True boolean
ID de Referência
ref string

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a atualização de acesso foi bem-sucedida.

mensagem
message string

Mensagem opcional detalhando o resultado.

Atualizar palavra-passe da conta

Atualize a senha de uma conta de usuário como administrador.

Parâmetros

Name Chave Necessário Tipo Description
fez
did True string

O DID da conta a atualizar.

palavra-passe
password True string

A nova senha da conta.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

mensagem
message string

Detalhes adicionais sobre o resultado da operação.

Atualizar sessão de autenticação

Atualize uma sessão de autenticação para obter um novo token de acesso e um token de atualização.

Parâmetros

Name Chave Necessário Tipo Description
atualizarJwt
refreshJwt True string

O token de atualização fornecido durante a criação da sessão

Devoluções

Name Caminho Tipo Description
acessoJwt
accessJwt string

Token de acesso JWT.

atualizarJwt
refreshJwt string

Token de atualização JWT.

alça
handle string

O identificador do usuário.

fez
did string

Identificador descentralizado (DID).

didDoc
didDoc object

Documento DID opcional.

active
active boolean

Indica se a sessão está ativa.

estado
status string

Estado de alojamento da conta.

Atualizar status de leitura da conversa

Atualize um item em uma conversa para marcá-lo como lido.

Parâmetros

Name Chave Necessário Tipo Description
convoId
convoId True string

O ID da conversa.

ID da mensagem
messageId string

O ID da mensagem a ser marcada como lida.

Devoluções

Name Caminho Tipo Description
Modo de Exibição de Conversa
convo convoView

Representa uma exibição de uma conversa.

Atualizar status do assunto

Atualize o status de administrador específico do serviço de um assunto.

Parâmetros

Name Chave Necessário Tipo Description
fez
did True string
URI
uri True string

O URI da referência forte.

CID
cid True string

O CID da referência forte.

fez
did True string
CID
cid True string
recordUri
recordUri string
aplicada
applied True boolean
refª
ref string
aplicada
applied True boolean
refª
ref string

Devoluções

Name Caminho Tipo Description
repoRef
subject.repoRef repoRef
strongRef
subject.strongRef strongRef

Define uma referência forte com um URI e CID.

repoBlobRef
subject.repoBlobRef repoBlobRef
Retirada
takedown statusAttr

Atualizar um membro no serviço de ozônio

Atualize um membro no serviço de ozônio.

Parâmetros

Name Chave Necessário Tipo Description
fez
did True string

O DID do membro.

desactivado
disabled boolean

Indica se o membro está desativado.

função
role string

A função atribuída ao membro.

Devoluções

Body
member

Atualizar um modelo de comunicação existente

Ação administrativa para atualizar um modelo de comunicação existente.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

ID do modelo a ser atualizado.

nome
name string

Nome do modelo.

idioma
lang string

Idioma da mensagem.

contentMarkdown
contentMarkdown string

O conteúdo do modelo, com suporte para marcação, pode conter espaços reservados variáveis.

Assunto
subject string

Assunto da mensagem, usado em e-mails.

atualizadoPor
updatedBy string

DID do usuário que está atualizando o modelo.

desactivado
disabled boolean

Se o modelo está desativado.

Devoluções

Carregar um novo blob

Carregue um novo blob.

Parâmetros

Name Chave Necessário Tipo Description
Ficheiro a carregar
file True file

O arquivo de blob a ser carregado.

Devoluções

Name Caminho Tipo Description
blob
blob string

O ID de blob carregado.

Carregar vídeo

Carregue um vídeo para ser processado e armazenado no PDS.

Parâmetros

Name Chave Necessário Tipo Description
Arquivo de vídeo
file True file

Arquivo de vídeo binário a ser carregado e processado.

Devoluções

As saídas desta operação são dinâmicas.

Chave de assinatura de reserva

Reserve uma chave de assinatura de repositório para uso com a criação de conta.

Parâmetros

Name Chave Necessário Tipo Description
fez
did string

O Identificador Descentralizado (DID) para reservar uma chave de assinatura.

Devoluções

Name Caminho Tipo Description
chave de assinatura
signingKey string

A chave pública para a chave de assinatura reservada.

Confirmar e-mail

Confirme um e-mail usando um token gerado pelo processo requestEmailConfirmation.

Parâmetros

Name Chave Necessário Tipo Description
e-mail
email True string

O endereço de e-mail a confirmar.

token
token True string

O token de confirmação enviado para o e-mail do usuário.

Consultar conjuntos disponíveis

Consultar conjuntos disponíveis.

Parâmetros

Name Chave Necessário Tipo Description
Limite de resultados
limit integer

Número máximo de conjuntos a serem retornados.

Cursor de paginação
cursor string

Cursor para paginação.

Prefixo do nome
namePrefix string

Filtros definidos por um prefixo de nome.

Ordenar por campo
sortBy string

Campo pelo qual ordenar os resultados.

Direção de classificação
sortDirection string

Direção de classificação, padrão para ordem crescente do campo de nome.

Devoluções

Name Caminho Tipo Description
sets
sets array of setView
cursor
cursor string

Contar o número de notificações não lidas para a conta solicitante

Conte o número de notificações não lidas para a conta solicitante.

Parâmetros

Name Chave Necessário Tipo Description
Priority
priority boolean

Especifica se apenas as notificações de alta prioridade devem ser contadas.

Visto em
seenAt date-time

Contar notificações vistas após o carimbo de data/hora fornecido.

Devoluções

Name Caminho Tipo Description
count
count integer

O número de notificações não lidas.

Criar Conta

Crie uma conta com os detalhes fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
e-mail
email string

Endereço de e-mail da conta.

alça
handle True string

Identificador solicitado para a conta.

fez
did string

Atproto DID pré-existente, sendo importado para uma nova conta.

Código de convite
inviteCode string

Convidar código para a criação de conta.

Código de verificação
verificationCode string

Código para verificar o e-mail ou telefone.

verificaçãoTelefone
verificationPhone string

Número de telefone para verificação de conta.

palavra-passe
password string

Senha inicial da conta. Pode ser necessário atender aos requisitos de força da senha específicos da instância.

recoveryKey
recoveryKey string

Chave de rotação do PLC DID (chave de recuperação) a ser incluída na operação de criação do PLC.

plcOp
plcOp object

Dados de operação do PLC opcionais.

Devoluções

Name Caminho Tipo Description
acessoJwt
accessJwt string

Acesse o token JWT para autenticação.

atualizarJwt
refreshJwt string

Atualize o token JWT para renovação de sessão.

alça
handle string

Identificador da nova conta.

fez
did string

DID da nova conta.

didDoc
didDoc object

Documento DID associado à nova conta.

Criar código de convite

Crie um código de convite para casos de uso especificados.

Parâmetros

Name Chave Necessário Tipo Description
useCount
useCount True integer

O número de vezes que o código de convite pode ser usado.

paraConta
forAccount string

O DID da conta para a qual o código de convite está sendo gerado.

Devoluções

Name Caminho Tipo Description
código
code string

O código de convite gerado.

Criar códigos de convite

Crie vários códigos de convite com limites de uso especificados.

Parâmetros

Name Chave Necessário Tipo Description
codeCount
codeCount True integer

O número de códigos de convite a serem gerados.

useCount
useCount True integer

O número de vezes que cada código de convite pode ser usado.

paraContas
forAccounts array of string

Uma matriz de DIDs para contas para as quais os códigos de convite são destinados.

Devoluções

Name Caminho Tipo Description
codes
codes array of object

Os códigos de convite gerados.

conta
codes.account string

O DID da conta associada ao código de convite.

código
codes.code string

O código de convite gerado.

Criar ou atualizar metadados do conjunto

Crie ou atualize metadados do conjunto.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string
descrição
description string

Devoluções

Body
setView

Criar palavra-passe da aplicação

Crie uma senha de aplicativo.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string

Um nome curto para a palavra-passe da aplicação, para ajudar a distingui-los.

privilegiado
privileged boolean

Se uma palavra-passe de aplicação tiver acesso "privilegiado" a um estado de conta possivelmente sensível. Destinado ao uso com clientes confiáveis.

Devoluções

Criar relatório

Envie um relatório de moderação sobre uma conta ou registro atproto. Implementado por serviços de moderação (com proxy PDS), e requer auth.

Parâmetros

Name Chave Necessário Tipo Description
reasonSpam
reasonSpam string

Spam: promoção indesejada frequente, respostas, menções

razãoViolação
reasonViolation string

Violação direta das regras do servidor, leis, termos de serviço

razãoEnganosa
reasonMisleading string

Identidade, afiliação ou conteúdo enganoso

razãoSexual
reasonSexual string

Conteúdo sexual indesejado ou rotulado incorretamente

razãoRude
reasonRude string

Comportamento rude, assediador, explícito ou de outra forma não acolhedor

razãoOutro
reasonOther string

Outros: relatórios não abrangidos por outra categoria de relatório

razãoRecurso
reasonAppeal string

Recurso: recorrer de uma ação de moderação previamente tomada

razão
reason string

Contexto adicional sobre o conteúdo e a violação.

fez
did True string
URI
uri True string

O URI da referência forte.

CID
cid True string

O CID da referência forte.

Devoluções

Name Caminho Tipo Description
id
id integer

Identificador exclusivo do relatório.

reasonType
reasonType reasonType

Tipo de motivo para o relatório de moderação. Uma das razões pré-definidas.

razão
reason string

Contexto adicional sobre o conteúdo e a violação.

repoRef
subject.repoRef repoRef
strongRef
subject.strongRef strongRef

Define uma referência forte com um URI e CID.

relatadoPor
reportedBy string

DID do usuário que enviou o relatório.

criadosAt
createdAt date-time

Carimbo de data/hora quando o relatório foi criado.

Criar sessão de autenticação

Criar uma sessão de autenticação

Parâmetros

Name Chave Necessário Tipo Description
Host
pdshost True string

Anfitrião Bluesky

Nome de utilizador
identifier True string

Identificador ou outro identificador

Palavra-passe
password True string

Senha do usuário autenticador

Token de fator de autenticação
authFactorToken string

Token opcional para autenticação multifator

Devoluções

Name Caminho Tipo Description
acessoJwt
accessJwt string

Token de acesso JWT.

atualizarJwt
refreshJwt string

Token de atualização JWT.

alça
handle string

Alça do usuário.

fez
did string

Identificador descentralizado (DID) do utilizador.

didDoc
didDoc object

Documento DID opcional.

e-mail
email string

Endereço de e-mail do usuário.

e-mailConfirmado
emailConfirmed boolean

Indicador se o e-mail está confirmado.

emailAuthFactor
emailAuthFactor boolean

Indicador se o e-mail é usado para autenticação.

active
active boolean

Indica se a sessão está ativa.

estado
status string

Status da conta de usuário.

Criar um modelo de comunicação reutilizável

Ação do administrador para criar um novo modelo de comunicação reutilizável.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string

Nome do modelo.

contentMarkdown
contentMarkdown True string

O conteúdo do modelo, com suporte para marcação, pode conter espaços reservados variáveis.

Assunto
subject True string

Assunto da mensagem, usado em e-mails.

idioma
lang string

Idioma da mensagem.

criado por
createdBy string

DID do usuário que está criando o modelo.

Devoluções

Criar um único novo registro de repositório

Crie um único novo registro de repositório.

Parâmetros

Name Chave Necessário Tipo Description
repositório
repo True string

O identificador ou DID do recompra (também conhecido como conta corrente).

coleção
collection True string

O NSID da coleção de registros.

rkey
rkey string

A chave de registro.

validar
validate boolean

Valor verdadeiro ou falso definido para ignorar a validação do esquema do léxico.

registo
record True object

O objeto de registro.

swapCommit
swapCommit string

Compare e troque com a confirmação anterior do CID.

Devoluções

Name Caminho Tipo Description
URI
uri string

O URI do registro criado.

CID
cid string

O CID do registro criado.

consolidação
commit commitMeta
validationStatus
validationStatus string

Definir preferências de conta

Defina as preferências privadas associadas à conta.

Parâmetros

Name Chave Necessário Tipo Description
enabled
enabled True boolean
rotuladorFez
labelerDid string

A que rotuladora se aplica esta preferência?

etiqueta
label True string
Visibilidade
visibility True string
fixado
pinned True array of string
Salvo
saved True array of string
timelineIndex
timelineIndex integer
id
id True string
tipo
type True string
valor
value True string
fixado
pinned True boolean
Data de nascimento
birthDate date-time

A data de nascimento do proprietário da conta.

feed
feed True string

O URI do feed ou um identificador que descreve o feed.

ocultarRespostas
hideReplies boolean

Ocultar respostas no feed.

hideRepliesByUnfollowed
hideRepliesByUnfollowed boolean

Oculte as respostas no feed se elas não forem de usuários seguidos.

hideRepliesByLikeCount
hideRepliesByLikeCount integer
ocultarReposts
hideReposts boolean

Ocultar republicações no feed.

ocultarQuotePosts
hideQuotePosts boolean

Ocultar publicações de citações no feed.

ordenar
sort string

Modo de classificação para threads.

priorizarUsuários Seguidos
prioritizeFollowedUsers boolean

Mostrar usuários seguidos na parte superior de todas as respostas.

tags
tags True array of string
id
id string
valor
value True string

A própria palavra silenciada.

targets
targets string
actorAlvo
actorTarget string

Grupos de usuários aos quais aplicar a palavra silenciada. Se indefinido, aplica-se a todos os usuários.

expira em
expiresAt date-time

A data e a hora em que a palavra silenciada expirará e não será mais aplicada.

items
items True array of string
guia
guide True string
queuedNudges
queuedNudges array of string
id
id True string
concluída
completed True boolean
dados
data string

Dados arbitrários para o NUX. Limite de 300 caracteres.

expira em
expiresAt date-time

A data e hora em que o NUX expirará e será concluído.

fez
did True string

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

mensagem
message string

Mensagem de sucesso opcional.

Definir preferências de notificação

Defina preferências relacionadas a notificações para uma conta.

Parâmetros

Name Chave Necessário Tipo Description
priority
priority True boolean

Indica se as notificações de prioridade devem ser habilitadas.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

mensagem
message string

Mensagem de sucesso opcional.

Desativar conta

Desativa uma conta atualmente ativa após a migração ser finalizada.

Parâmetros

Name Chave Necessário Tipo Description
deleteAfter
deleteAfter date-time

Janela de tempo para reter a conta desativada.

Desativar códigos de convite

Desative códigos de convite específicos para evitar mais uso.

Parâmetros

Name Chave Necessário Tipo Description
inviteCodes
inviteCodes array of string

Uma lista de códigos de convite a serem desativados.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica a operação bem-sucedida.

Descrever o servidor

Descreve os requisitos e os recursos de criação de conta do servidor.

Devoluções

Name Caminho Tipo Description
inviteCodeRequired
inviteCodeRequired boolean

Se verdadeiro, um código de convite deve ser fornecido para criar uma conta nesta instância.

phoneVerificationRequired
phoneVerificationRequired boolean

Se verdadeiro, um token de verificação de telefone deve ser fornecido para criar uma conta nesta instância.

availableUserDomains
availableUserDomains array of string
links
links describeServerLinks
contato
contact describeServerContact
fez
did string

Identificador descentralizado (DID) do servidor.

Download da exportação do repositório

Faça o download de uma exportação de repositório como arquivo CAR.

Parâmetros

Name Chave Necessário Tipo Description
Repo FEZ
did True string

O DID do repo.

Revisão
since string

A revisão ('rev') do repo para criar um diff de.

Devoluções

response
binary

Eliminar um membro da equipa de ozono

Exclua um membro da equipe de ozônio.

Parâmetros

Name Chave Necessário Tipo Description
fez
did True string

O DID do membro.

Encontrar atores (perfis) que correspondam aos critérios de pesquisa

Encontre atores (perfis) que correspondam aos critérios de pesquisa.

Parâmetros

Name Chave Necessário Tipo Description
Consulta de pesquisa
q string

Cadeia de caracteres de consulta de pesquisa. Sintaxe, frase, booleano e faceta não são especificados, mas a sintaxe da consulta Lucene é recomendada.

Limite de resultados
limit integer

O número máximo de atores a retornar.

Cursor de paginação
cursor string

Cursor para paginação para buscar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para paginação.

intervenientes
actors array of profileView

Lista de perfis de atores correspondentes.

Encontrar contas relacionadas

Obtenha contas que compartilham algumas assinaturas de ameaças correspondentes com a conta root.

Parâmetros

Name Chave Necessário Tipo Description
Conta DID
did True string

O DID da conta root.

Cursor de paginação
cursor string

Cursor de paginação para o próximo conjunto de resultados.

Limite de resultados
limit integer

O número máximo de resultados a serem retornados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string
accounts
accounts array of findRelatedAccounts.relatedAccount

Encontrar correlação de assinaturas de ameaças

Encontre todas as assinaturas de ameaças correlacionadas entre 2 ou mais contas.

Parâmetros

Name Chave Necessário Tipo Description
DIDs de conta
dids True array

Lista de DIDs para contas para encontrar assinaturas correlacionadas.

Devoluções

Name Caminho Tipo Description
details
details array of sigDetail

Encontre rótulos relevantes para os padrões de AT-URI fornecidos

Encontre rótulos relevantes para os padrões de AT-URI fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
Lista de padrões de URI AT a serem correspondidos
uriPatterns True array

Lista de padrões AT URI a serem correspondidos (booleano 'OR').

DIDs para filtrar
sources array

Lista opcional de fontes de etiquetas (DIDs) para filtrar.

Limite
limit integer

O número máximo de etiquetas a devolver.

Cursor de paginação
cursor string

Um cursor para paginação.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para paginação.

labels
labels array of label

Enviar e-mail para o endereço de e-mail da conta de um usuário

Enviar e-mail para o endereço de e-mail da conta de um usuário.

Parâmetros

Name Chave Necessário Tipo Description
Destinatário DID
recipientDid True string

Identificador descentralizado (DID) do destinatário.

Content
content True string

Conteúdo do e-mail.

Assunto
subject string

Assunto do e-mail.

Remetente DID
senderDid True string

DID do remetente.

Comentário adicional
comment string

Comentário adicional do remetente que não será usado no próprio e-mail.

Devoluções

Name Caminho Tipo Description
enviado
sent boolean

Indica se o e-mail foi enviado com êxito.

Enviar interações

Envie informações sobre interações.

Parâmetros

Name Chave Necessário Tipo Description
item
item string
evento
event string
feedContext
feedContext string

Contexto em um item de feed originalmente fornecido pelo gerador de feed em getFeedSkeleton.

Enviar Mensagem

Envie uma única mensagem para uma conversa específica.

Parâmetros

Name Chave Necessário Tipo Description
convoId
convoId True string

O ID da conversa.

enviar SMS
text True string
byteStart
byteStart True integer

O byte inicial do intervalo.

byteEnd
byteEnd True integer

O byte final do intervalo.

Tipo de recurso
featureType string

Tipo do recurso.

details
details object

Detalhes sobre o recurso.

URI
uri True string

O URI da referência forte.

CID
cid True string

O CID da referência forte.

Devoluções

As saídas desta operação são dinâmicas.

Enviar mensagens em lote

Envie um lote de mensagens para várias conversas.

Parâmetros

Name Chave Necessário Tipo Description
convoId
convoId True string
enviar SMS
text True string
byteStart
byteStart True integer

O byte inicial do intervalo.

byteEnd
byteEnd True integer

O byte final do intervalo.

Tipo de recurso
featureType string

Tipo do recurso.

details
details object

Detalhes sobre o recurso.

URI
uri True string

O URI da referência forte.

CID
cid True string

O CID da referência forte.

Devoluções

As saídas desta operação são dinâmicas.

Excluir conta

Exclua uma conta de usuário como administrador.

Parâmetros

Name Chave Necessário Tipo Description
Identificador descentralizado (DID)
did True string

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a conta foi excluída com êxito.

mensagem
message string

Mensagem opcional detalhando o resultado.

Excluir conta

Exclua a conta de um ator com um token e senha.

Parâmetros

Name Chave Necessário Tipo Description
fez
did True string

Identificador descentralizado (DID) da conta a ser excluída.

palavra-passe
password True string

Senha da conta.

token
token True string

Token associado à conta.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a exclusão da conta foi bem-sucedida.

mensagem
message string

Mensagem de sucesso opcional.

Excluir conta

Excluir uma conta.

Excluir mensagem para si mesmo

Exclua uma mensagem do usuário que a enviou.

Parâmetros

Name Chave Necessário Tipo Description
convoId
convoId True string

O ID da conversa que contém a mensagem a ser excluída.

ID da mensagem
messageId True string

O ID da mensagem a ser excluída.

Devoluções

Excluir sessão

Exclua a sessão atual.

Excluir um conjunto

Exclua um conjunto inteiro.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string

Nome do conjunto a excluir

Excluir um modelo de comunicação

Exclua um modelo de comunicação por sua ID exclusiva.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

O identificador exclusivo do modelo a ser excluído.

Excluir um registro de repositório ou garantir que ele não exista

Exclua um registro de repositório ou verifique se ele não existe.

Parâmetros

Name Chave Necessário Tipo Description
repositório
repo True string

O identificador ou DID do recompra (também conhecido como conta corrente).

coleção
collection True string

O NSID da coleção de registros.

rkey
rkey True string

A chave de registro.

swapRecord
swapRecord string

Compare e troque com o registro anterior pelo CID.

swapCommit
swapCommit string

Compare e troque com a confirmação anterior do CID.

Devoluções

Name Caminho Tipo Description
consolidação
commit commitMeta

Excluir valores de um conjunto

Excluir valores de um conjunto específico.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string

Nome do conjunto do qual excluir valores.

values
values True array of string

Exportar dados da conta

Exportar dados da conta.

Devoluções

response
file

GetRecommendedDidCredentials

Descreva as credenciais que devem ser incluídas no documento DID de uma conta que está migrando para este serviço.

Devoluções

Name Caminho Tipo Description
Teclas de rotação
rotationKeys array of string
tambémConhecidoComo
alsoKnownAs array of string
verificaçãoMétodos
verificationMethods object
services
services object

Gravar um registro de repositório

Escreva um registro de repositório, criando-o ou atualizando-o conforme necessário.

Parâmetros

Name Chave Necessário Tipo Description
repositório
repo True string

O identificador ou DID do recompra (também conhecido como conta corrente).

coleção
collection True string

O NSID da coleção de registros.

rkey
rkey True string

A chave de registro.

validar
validate boolean

Valor verdadeiro/falso para ignorar a validação do esquema Lexicon.

registo
record True object

O conteúdo do registo.

swapRecord
swapRecord string

Compare e troque com o registro anterior pelo CID.

swapCommit
swapCommit string

Compare e troque com a confirmação anterior do CID.

Devoluções

Name Caminho Tipo Description
URI
uri string
CID
cid string
consolidação
commit commitMeta
validationStatus
validationStatus string

Importar um repositório na forma de um arquivo CAR

Importe um repositório na forma de um arquivo CAR. Cabeçalho Content-Length necessário.

Parâmetros

Name Chave Necessário Tipo Description
Detalhes do arquivo CAR
body True string

O arquivo CAR a ser importado.

Devoluções

Name Caminho Tipo Description
mensagem
message string

Mensagem de sucesso indicando que o repositório foi importado.

repoId
repoId string

O identificador exclusivo do repositório importado.

Lista de todos os membros com acesso ao serviço de ozono

Listar todos os membros com acesso ao serviço de ozono.

Parâmetros

Name Chave Necessário Tipo Description
Limitar resultados
limit integer

O número máximo de resultados a serem retornados.

Cursor de paginação
cursor string

Cursor para paginar resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para a próxima página de resultados.

Membros
members array of member

Listar blobs ausentes para a conta solicitante

Retorna uma lista de blobs ausentes para a conta solicitante.

Parâmetros

Name Chave Necessário Tipo Description
Limitar resultados
limit integer

O número máximo de resultados a serem retornados.

Cursor de paginação
cursor string

Cursor para paginar resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para a próxima página de resultados.

manchas
blobs array of listMissingBlobs.recordBlob

Listar CIDs de blob de conta

Listar CIDs de blob de conta desde uma revisão de repo.

Parâmetros

Name Chave Necessário Tipo Description
Repo FEZ
did True string

O DID do repo.

Revisão
since string

Revisão opcional do repositório para listar blobs desde então.

Limite de resultados
limit integer

O número máximo de resultados a serem retornados.

Cursor
cursor string

Cursor de paginação para o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string
CIDs
cids array of string

Listar conversas

Listar conversas.

Parâmetros

Name Chave Necessário Tipo Description
Limite de paginação
limit integer

O número máximo de conversas a serem retornadas (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para paginação.

Convos
convos array of object
id
convos.id string

O identificador exclusivo da conversa.

rev
convos.rev string

O identificador de revisão da conversa.

Membros
convos.members array of chatProfileViewBasic

Lista de membros na conversa.

Última mensagem
convos.lastMessage lastMessage

Representa a última mensagem de uma conversa.

silenciado
convos.muted boolean

Indica se a conversa está silenciada.

aberto
convos.opened boolean

Indica se a conversa foi aberta.

unreadCount
convos.unreadCount integer

A contagem de mensagens não lidas na conversa.

Listar eventos de moderação relacionados a um assunto

Listar eventos de moderação relacionados a um assunto.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de evento para filtragem
types array

Tipo de evento para filtrar por: defs#modEvent<name>

Criado por
createdBy string

Criado pelo usuário

Ordem de classificação
sortDirection string

Ordenar a direção dos eventos.

Eventos criados após um carimbo de data/hora
createdAfter date-time

Recupere eventos criados após um determinado carimbo de data/hora.

Eventos criados antes de um carimbo de data/hora
createdBefore date-time

Recupere eventos criados antes de um determinado carimbo de data/hora.

Assunto
subject string

Assunto

Recolha de eventos
collections array

Retorna eventos em que o assunto pertence às coleções fornecidas.

Tipo de assunto
subjectType string

Retorna eventos em que o assunto é conta ou registro.

Devolve eventos de todos os tipos
includeAllUserRecords boolean

Retorna eventos em todos os tipos de registro de determinado parâmetro 'coleções'.

Limite
limit integer

Limite

Tem comentário, sim/não
hasComment boolean

Se verdadeiro, apenas os eventos com comentários são retornados.

Comment
comment string

Retorna eventos com comentários contendo a palavra-chave.

Rótulos adicionados
addedLabels array

Os eventos de retorno em que todos esses rótulos foram adicionados são retornados.

Eventos com etiquetas removidas
removedLabels array

Retorna eventos em que os rótulos foram removidos.

Etiquetas removidas
addedTags array

Retorna eventos em que os rótulos foram removidos.

Tags removidas
removedTags array

Retorna eventos em que as tags foram removidas.

Tipos de relatório
reportTypes array

Tipo de relatório para evento de moderação

Cursor de paginação
cursor string

Cursor de paginação

Devoluções

Name Caminho Tipo Description
cursor
cursor string
events
events array of modEventView

Listar notificações

Enumerar notificações para a conta solicitante.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit integer

O número máximo de notificações a serem retornadas.

Priority
priority boolean

Filtre as notificações por status de prioridade.

Cursor
cursor string

Cursor de paginação para recuperar o próximo conjunto de notificações.

Visto em
seenAt date-time

Filtrar notificações vistas na data e hora especificada ou após ela.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para o próximo conjunto de resultados.

Notificações
notifications array of notification

Lista de notificações.

priority
priority boolean

Indica se as notificações de prioridade estão incluídas.

seenAt
seenAt date-time

Carimbo de data/hora que indica quando as notificações foram vistas pela última vez.

Listar registros em um repositório

Liste um intervalo de registros em um repositório, correspondendo a uma coleção específica.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do repositório
repo True string

A alça ou DID do repo.

Tipo de coleção
collection True string

O NSID do tipo de registro.

Limitar resultados
limit integer

O número de registos a devolver.

Cursor de paginação
cursor string

Cursor para paginar resultados.

Ordem inversa
reverse boolean

Sinalizador para inverter a ordem dos registros retornados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para a próxima página de resultados.

registos
records array of listRecords.record

Listar repositórios

Enumera todos os CID DID, rev e commit para todos os repositórios

Parâmetros

Name Chave Necessário Tipo Description
Limite de resultados
limit integer

O número máximo de resultados a serem retornados.

Cursor
cursor string

Cursor de paginação para o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string
repos
repos array of listRepos.repo

Listar senhas de aplicativos

Liste todas as senhas de aplicativos.

Devoluções

Name Caminho Tipo Description
palavras-passe
passwords array of listAppPassword

Localizar repositórios com base num termo de pesquisa

Encontre repositórios com base em um termo de pesquisa.

Parâmetros

Name Chave Necessário Tipo Description
Termo de pesquisa
q string

O termo de pesquisa para encontrar repositórios.

Limitar resultados
limit integer

O número máximo de resultados a serem retornados.

Cursor de paginação
cursor string

Cursor para paginar resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para a próxima página de resultados.

repos
repos array of repoView

Notificar a atualização

Notifique um serviço de rastreamento sobre uma atualização recente e esse rastreamento deve ser retomado.

Parâmetros

Name Chave Necessário Tipo Description
nome do anfitrião
hostname True string

Nome do host do serviço atual notificando a atualização.

Notificar o servidor de que a conta solicitante recebeu notificações

Notifique o servidor de que a conta solicitante viu notificações.

Parâmetros

Name Chave Necessário Tipo Description
seenAt
seenAt True date-time

Carimbo de data/hora que indica quando as notificações foram vistas.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

Obtenha uma lista de pacotes iniciais criados pelo ator

Obtenha uma lista de pacotes iniciais criados pelo ator.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

O identificador do ator para o qual recuperar pacotes iniciais.

Limite de resultados
limit integer

O número máximo de pacotes iniciais a devolver.

Cursor de paginação
cursor string

Cursor para paginação para buscar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para paginação.

starterPacks
starterPacks array of starterPackViewBasic

Obter a confirmação atual de um repositório

Obtenha o CID de confirmação atual e a revisão do repositório especificado.

Parâmetros

Name Chave Necessário Tipo Description
Repo FEZ
did True string

O DID do repo.

Devoluções

Name Caminho Tipo Description
CID
cid string
rev
rev string

Identificador de revisão do repositório.

Obter Atores Sugeridos

Obtenha uma lista de atores sugeridos.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit integer

O número máximo de resultados a serem retornados.

Cursor
cursor string

Um cursor para paginação.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para o próximo conjunto de resultados.

intervenientes
actors array of profileView

Lista de perfis de atores sugeridos.

Obter blocos de dados de um repositório

Obter blocos de dados de um determinado repositório, por CID.

Parâmetros

Name Chave Necessário Tipo Description
Repo FEZ
did True string

O DID do repo.

Bloquear CIDs
cids True array

Os CIDs dos blocos para buscar.

Devoluções

Name Caminho Tipo Description
blocos
blocks array of string

Lista de blocos buscados.

Obter configuração do servidor

Obtenha detalhes sobre a configuração do servidor de ozono.

Devoluções

Name Caminho Tipo Description
appview
appview serviceConfig
PDS
pds serviceConfig
blobDivert
blobDivert serviceConfig
chat
chat serviceConfig
espetador
viewer viewerConfig

Obter contexto de mensagem

Buscar mensagens ao redor de uma conversa

Parâmetros

Name Chave Necessário Tipo Description
ID da Conversação
convoId string

Conversa de onde vem a mensagem.

ID da mensagem
messageId True string

O ID da mensagem.

Número de mensagens a serem incluídas antes da mensagem especificada.
before integer

Número de mensagens a serem incluídas antes da mensagem especificada.

Número de mensagens a serem incluídas após a mensagem especificada.
after integer

Número de mensagens a serem incluídas após a mensagem especificada.

Devoluções

As saídas desta operação são dinâmicas.

Obter conversa

Obtenha uma conversa com base no ID de conversação fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID da conversação
convoId True string

O ID da conversa a ser recuperada.

Devoluções

Name Caminho Tipo Description
Modo de Exibição de Conversa
convo convoView

Representa uma exibição de uma conversa.

Obter Convo para Membros

Obtenha uma conversa para um ou vários membros.

Parâmetros

Name Chave Necessário Tipo Description
Membros Identificadores DID
members True array

Lista de identificadores DID para os membros da conversa.

Devoluções

Name Caminho Tipo Description
Modo de Exibição de Conversa
convo convoView

Representa uma exibição de uma conversa.

Obter códigos de convite

Obtenha uma vista de administrador dos códigos de convite.

Parâmetros

Name Chave Necessário Tipo Description
Método Sort
sort string

Método de classificação para códigos de convite.

Limite
limit integer

Número máximo de resultados a devolver.

Cursor de paginação
cursor string

Cursor para paginação.

Devoluções

Name Caminho Tipo Description
Cursor para paginação.
cursor string
codes
codes array of inviteCode

Obter códigos de convite de conta

Obtenha todos os códigos de convite para a conta corrente.

Parâmetros

Name Chave Necessário Tipo Description
Incluir Usado
includeUsed boolean

Inclua códigos de convite usados na resposta.

Criar disponível
createAvailable boolean

Controla se novos convites "ganhos", mas não "criados", devem ser criados.

Devoluções

Name Caminho Tipo Description
codes
codes array of inviteCode

Obter detalhes de status para um trabalho de processamento de vídeo

Obtenha detalhes de status para um trabalho de processamento de vídeo.

Parâmetros

Name Chave Necessário Tipo Description
ID do trabalho
jobId True string

A ID do trabalho de processamento de vídeo para recuperar o status.

Devoluções

Name Caminho Tipo Description
situação do emprego
jobStatus jobStatus

Obter detalhes sobre alguns registos

Obtenha detalhes sobre alguns registros.

Parâmetros

Name Chave Necessário Tipo Description
URIs dos registros a serem recuperados
uris True array

Uma lista de URIs para os registros.

Devoluções

Name Caminho Tipo Description
registos
records array of object
items
records object

Obter detalhes sobre um evento de moderação

Obtenha detalhes sobre um evento de moderação.

Parâmetros

Name Chave Necessário Tipo Description
A ID do evento de moderação a ser recuperado
id True integer

A ID do evento de moderação a ser recuperado.

Devoluções

Obter detalhes sobre um registo

Obtenha detalhes sobre um registo.

Parâmetros

Name Chave Necessário Tipo Description
URI do registro a ser recuperado
uri True string

O URI do registro.

CID da versão específica
cid string

O CID da versão do registro.

Devoluções

Obter detalhes sobre um repositório

Obtenha detalhes sobre um repositório.

Parâmetros

Name Chave Necessário Tipo Description
DID do repositório
did True string

O DID do repositório.

Devoluções

Obter feed

Obtenha uma alimentação hidratada do gerador de alimentação selecionado por um ator.

Parâmetros

Name Chave Necessário Tipo Description
URI do gerador de alimentação
feed True string

O URI do gerador de alimentação.

Identificador do ator
actor True string

A alça ou DID do ator que solicita o feed.

Limite
limit integer

O número máximo de postagens a serem retornadas (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

As saídas desta operação são dinâmicas.

Obter feed de lista

Obtenha um feed de publicações recentes de uma lista.

Parâmetros

Name Chave Necessário Tipo Description
Referência da lista
list True string

Referência (AT-URI) ao registo da lista.

Limite de resultados
limit integer

Número máximo de lugares a recuperar.

Cursor de paginação
cursor string

Mecanismo de paginação opcional.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para o próximo conjunto de resultados.

feed
feed array of feedViewPost

Matriz de postagens no feed.

Obter feed do autor

Obtenha uma visão do "feed do autor" de um ator.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

O identificador do ator cujo autor alimenta para buscar.

Limite
limit integer

Número máximo de itens a buscar.

Curose de paginação
cursor string

Cursor de paginação para buscar o próximo conjunto de resultados.

Critérios de filtragem
filter string

Combinações de tipos de postagem/repostagem a serem incluídas na resposta.

Incluir mensagens fixadas
includePins boolean

Se as publicações fixas devem ser incluídas na resposta.

Devoluções

Name Caminho Tipo Description
cursor
cursor string
feed
feed array of feedViewPost

Obter Feed Skeleton

Obtenha um esqueleto de uma alimentação fornecida por um gerador de alimentação.

Parâmetros

Name Chave Necessário Tipo Description
Referência do gerador de alimentação.
feed True string

Referência ao registo do gerador de alimentação que descreve a alimentação específica que está a ser solicitada.

Número de resultados a recuperar.
limit integer

Limite

Cursor de paginação.
cursor string

Cursor de paginação

Devoluções

Name Caminho Tipo Description
cursor
cursor string
feed
feed array of skeletonFeedPost

Obter feeds de atores

Obtenha uma lista de feeds criados pelo ator.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

O identificador ou DID do ator cujos feeds devem ser recuperados.

Limite
limit integer

O número máximo de feeds a retornar (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

As saídas desta operação são dinâmicas.

Obter feeds sugeridos

Recupere uma lista de feeds sugeridos para a conta solicitante.

Parâmetros

Name Chave Necessário Tipo Description
Limite
limit integer

O número máximo de feeds sugeridos para retornar (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

As saídas desta operação são dinâmicas.

Obter Gostos

Obtenha registros semelhantes que fazem referência a um assunto (por AT-URI e CID).

Parâmetros

Name Chave Necessário Tipo Description
AT-URI do assunto.
uri True string

AT-URI do assunto (por exemplo, um registro postal).

CID do registo do sujeito.
cid string

CID do registro de assunto (versão específica do registro), para filtrar likes.

Limite o número de resultados.
limit integer

Limite

Cursor de paginação.
cursor string

Cursor de paginação

Devoluções

Name Caminho Tipo Description
URI
uri string
CID
cid string
cursor
cursor string
gosta
likes array of getLikesLike

Obter informações da conta

Obtenha detalhes sobre uma conta.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de conta
did True string

Identificador descentralizado (DID) da conta.

Devoluções

Obter informações da conta

Obtenha detalhes sobre algumas contas.

Parâmetros

Name Chave Necessário Tipo Description
Identificadores de conta
dids True array

Matriz de identificadores de conta (DIDs).

Devoluções

Name Caminho Tipo Description
informações
infos array of accountView

Obter informações da sessão atual

Obtenha informações sobre a sessão autenticada.

Devoluções

Name Caminho Tipo Description
alça
handle string

Alça do usuário.

fez
did string

Identificador descentralizado (DID) do utilizador.

e-mail
email string

Endereço de e-mail do usuário.

e-mailConfirmado
emailConfirmed boolean

Indica se o e-mail está confirmado.

emailAuthFactor
emailAuthFactor boolean

Indica se o email é usado como um fator de autenticação.

didDoc
didDoc object

Documento DID opcional.

active
active boolean

Indica se a sessão está ativa.

estado
status string

O status da conta de usuário.

Obter informações do gerador de alimentação

Obtenha informações sobre um gerador de alimentação.

Parâmetros

Name Chave Necessário Tipo Description
Gerador de alimentação AT-URI
feed True string

AT-URI do registo do gerador de alimentação.

Devoluções

Name Caminho Tipo Description
vista
view generatorView
isOnline
isOnline boolean

Indica se o serviço do gerador de alimentação esteve online recentemente.

isValid
isValid boolean

Indica se o serviço do gerador de alimentação é compatível com a declaração de registro.

Obter informações sobre geradores de alimentação

Obtenha informações sobre uma lista de geradores de alimentação.

Parâmetros

Name Chave Necessário Tipo Description
Lista de AT-URIs do gerador de alimentação
feeds True array

Uma lista de AT-URIs que representam os geradores de alimentação para recuperar informações.

Devoluções

Name Caminho Tipo Description
Alimentação
feeds array of generatorView

Obter informações sobre um feed

Obtenha informações sobre um gerador de alimentação.

Devoluções

Name Caminho Tipo Description
fez
did string
Alimentação
feeds array of describeFeedGeneratorFeed
links
links describeFeedGeneratorLinks

Obter informações sobre uma conta e repositório

Obtenha informações sobre uma conta e um repositório, incluindo a lista de coleções.

Parâmetros

Name Chave Necessário Tipo Description
A alça ou DID do repo.
repo True string

A alça ou DID do repo.

Devoluções

Name Caminho Tipo Description
alça
handle string
fez
did string
didDoc
didDoc object
collections
collections array of string
handleIsCorrect
handleIsCorrect boolean

Indica se o identificador é válido no momento.

Obter informações sobre uma lista de serviços de etiquetagem

Obtenha informações sobre uma lista de serviços de rotulagem.

Parâmetros

Name Chave Necessário Tipo Description
DIDs
dids True array

DIDs

Detalhado
detailed boolean

Detalhado

Devoluções

Name Caminho Tipo Description
views
views array of labelerView

Obter limites de upload de vídeo para o usuário autenticado

Obtenha limites de upload de vídeo para o usuário autenticado.

Devoluções

Name Caminho Tipo Description
canUpload
canUpload boolean

Indica se o usuário pode carregar vídeos.

restanteDailyVideos
remainingDailyVideos integer

Número de vídeos que o usuário ainda pode carregar hoje.

remainingDailyBytes
remainingDailyBytes integer

Tamanho de dados restante em bytes disponível para uploads hoje.

mensagem
message string

Informações adicionais sobre os limites de upload.

erro
error string

Mensagem de erro, se aplicável.

Obter Linha do Tempo

Obtenha uma visão da linha do tempo inicial da conta solicitante.

Parâmetros

Name Chave Necessário Tipo Description
Variante do algoritmo
algorithm string

Variante 'algoritmo' para a linha do tempo.

Limite
limit integer

O número máximo de postagens a serem retornadas (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

As saídas desta operação são dinâmicas.

Obter lista de modelos de comunicação

Recupere uma lista de todos os modelos de comunicação disponíveis.

Devoluções

Name Caminho Tipo Description
comunicaçãoModelos
communicationTemplates array of templateView

Obter listas

Enumera as listas criadas por uma conta especificada.

Parâmetros

Name Chave Necessário Tipo Description
Identificador de conta
actor True string

A conta (ator) a partir da qual enumerar listas.

Limitar resultados
limit integer

Número máximo de resultados a devolver.

Cursor de paginação
cursor string

Cursor para recuperar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para o próximo conjunto de resultados.

listas
lists array of listView

Obter Listas de Bloqueios

Obter listas de mod que a conta solicitante (ator) está bloqueando.

Parâmetros

Name Chave Necessário Tipo Description
Limitar resultados
limit integer

Número máximo de resultados a devolver.

Cursor de paginação
cursor string

Cursor para recuperar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para o próximo conjunto de resultados.

listas
lists array of listView

Obter listas silenciadas

Obter listas de mod que a conta solicitante tem silenciado no momento.

Parâmetros

Name Chave Necessário Tipo Description
Limitar resultados
limit integer

Número máximo de resultados a devolver.

Cursor de paginação
cursor string

Cursor para recuperar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para o próximo conjunto de resultados.

listas
lists array of listView

Obter Log

Recupere o registro de ações e mensagens em uma conversa.

Parâmetros

Name Chave Necessário Tipo Description
Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de logs.

Devoluções

As saídas desta operação são dinâmicas.

Obter metadados do ator

Buscar metadados relacionados à moderação para um ator via DID

Parâmetros

Name Chave Necessário Tipo Description
DID
actor True string

O Identificador Descentralizado (DID) do ator.

Devoluções

Name Caminho Tipo Description
day
day ActorMetadata
mês
month ActorMetadata
all
all ActorMetadata

Obter Mudos

Enumera as contas que a conta solicitante silenciou no momento.

Parâmetros

Name Chave Necessário Tipo Description
Limitar resultados
limit integer

Número máximo de resultados a devolver.

Cursor de paginação
cursor string

Cursor para recuperar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para o próximo conjunto de resultados.

mudos
mutes array of profileView

Obter Orçamentos

Obtenha uma lista de citações para um determinado post.

Parâmetros

Name Chave Necessário Tipo Description
URI de referência do post
uri True string

Referência (AT-URI) do registo postal.

Versão específica CID
cid string

Se fornecido, filtra para citações de versão específica (por CID) do registro postal.

Limite de resultados
limit integer

Número máximo de cotações a recuperar.

Cursor de paginação
cursor string

Mecanismo de paginação opcional.

Devoluções

Name Caminho Tipo Description
URI
uri string

Referência (AT-URI) do registo postal.

CID
cid string

Versão específica (CID) do registo postal.

cursor
cursor string

Cursor de paginação para o próximo conjunto de resultados.

publicações
posts array of postView

Matriz de visualizações de postagem para cotações.

Obter Pacotes Iniciais

Obtenha visualizações detalhadas para obter uma lista de pacotes iniciais com base nos URIs fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
Starter Pack URIs
uris True string

Lista de AT-URIs para os pacotes iniciais (máximo 25 itens).

Devoluções

As saídas desta operação são dinâmicas.

Obter perfil

Recupere uma visualização de perfil detalhada de um ator usando seu identificador ou DID.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

Manipular ou FEZ da conta para buscar o perfil de.

Devoluções

As saídas desta operação são dinâmicas.

Obter perfis

Obtenha visualizações detalhadas do perfil de vários atores.

Parâmetros

Name Chave Necessário Tipo Description
Lista de identificadores de atores
actors True array

Identificador do ator

Devoluções

Name Caminho Tipo Description
profiles
profiles array of profileViewDetailed

Obter Post Thread

Receba publicações em um tópico.

Parâmetros

Name Chave Necessário Tipo Description
Publicar AT-URI
uri True string

Referência (AT-URI) ao registo postado.

Profundidade da resposta
depth integer

Quantos níveis de profundidade de resposta devem ser incluídos na resposta.

Níveis de postagem pai
parentHeight integer

Quantos níveis de pai (e avós, etc) postar para incluir.

Devoluções

Name Caminho Tipo Description
estado
thread.status string
Threadgate
threadgate threadgateView

Obter Posts

Obtém visualizações de postagem para uma lista especificada de postagens.

Parâmetros

Name Chave Necessário Tipo Description
Publicar AT-URIs
uris True array

Lista de AT-URIs de post para retornar visualizações hidratadas.

Devoluções

Name Caminho Tipo Description
publicações
posts array of postView

Obter preferências

Obtenha preferências privadas associadas à conta corrente.

Devoluções

Name Caminho Tipo Description
preferences
preferences preferences

Obter relações públicas entre uma conta e uma lista de outras contas

Obtenha relações públicas entre uma conta e uma lista de outras contas.

Parâmetros

Name Chave Necessário Tipo Description
Conta Principal
actor True string

Conta principal solicitando relacionamentos para.

Outras Contas
others string

Lista de «outras» contas a relacionar com a primária.

Devoluções

Name Caminho Tipo Description
ator
actor string

O DID da conta primária.

relationships
relationships array of object

Lista de relações entre o ator e outras contas.

tipo
relationships.type string

O tipo de relacionamento ou status.

Obter repositórios de moderação

Obtenha uma lista de todos os repositórios de moderação.

Devoluções

Name Caminho Tipo Description
repositories
repositories array of object

Lista de repositórios de moderação.

id
repositories.id string

Identificador exclusivo do repositório.

estado
repositories.status string

O status do repositório.

Obter seguidores

Enumere contas que seguem um ator especificado.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

A alça ou DID do ator cujos seguidores estão sendo recuperados.

Limite de paginação
limit integer

O número máximo de seguidores a retornar (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

As saídas desta operação são dinâmicas.

Obter Seguidores

Enumera contas que um ator especificado segue.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

A alça ou DID do ator cujos seguidores estão sendo recuperados.

Máximo de contas a recuperar
limit integer

O número máximo de contas a devolver (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

As saídas desta operação são dinâmicas.

Obter seguidores conhecidos

Recupere seguidores para uma conta específica que também são seguidos pelo visualizador.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

A alça ou DID do ator cujos seguidores estão sendo recuperados.

Limite de seguidores
limit integer

O número máximo de seguidores a retornar (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de resultados.

Devoluções

As saídas desta operação são dinâmicas.

Obter Starter Pack

Obtém uma visão de um pacote inicial com base na referência fornecida (AT-URI).

Parâmetros

Name Chave Necessário Tipo Description
Identificador do Starter Pack
starterPack True string

Referência (AT-URI) do registo da embalagem inicial.

Devoluções

Name Caminho Tipo Description
Pacote inicial
starterPack starterPackView

Obter status de hospedagem do repositório

Obtenha o status de hospedagem de um repositório, neste servidor.

Parâmetros

Name Chave Necessário Tipo Description
Repo FEZ
did True string

O DID do repo.

Devoluções

Name Caminho Tipo Description
fez
did string
active
active boolean
estado
status string

Valor verdadeiro ou falso indicando o status da atividade.

rev
rev string

Campo opcional, a rev atual do repo, if ative=true

Obter sugestões de seguidores por ator

Enumera segue semelhante a uma determinada conta.

Parâmetros

Name Chave Necessário Tipo Description
Actor
actor True string

O identificador de conta para o qual segue semelhante é sugerido.

Devoluções

Name Caminho Tipo Description
Sugestões
suggestions array of profileView

Lista de perfis sugeridos a seguir.

isFallback
isFallback boolean

Indica se os resultados são sugestões genéricas de fallback.

Obter token de autenticação de serviço

Obtenha um token assinado em nome do DID solicitante para o serviço solicitado.

Parâmetros

Name Chave Necessário Tipo Description
DID
aud True string

O DID do serviço com o qual o token será usado para autenticar.

Expiração
exp integer

O tempo em Unix Epoch segundos que o JWT expira. Padrões = 60 segundos

Método Lexicon
lxm string

Método Lexicon (XRPC) ao qual vincular o token solicitado.

Devoluções

Name Caminho Tipo Description
token
token string

O token de autenticação assinado.

Obter um blob associado a uma conta

Obtenha um blob associado a uma determinada conta.

Parâmetros

Name Chave Necessário Tipo Description
Conta DID
did True string

O DID da conta.

Blob CID
cid True string

O CID do blob para buscar.

Devoluções

Name Caminho Tipo Description
blob
blob string

Conteúdo de blob codificado em Base64.

Obter um registro do repositório

Recupere um registro do repositório por seu identificador exclusivo.

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
did True string

Identificador único do registo.

Devoluções

Name Caminho Tipo Description
id
record.id string

Identificador único do registo.

conteúdo
record.content string

O conteúdo do registo.

Obter um único registro de um repositório

Obtenha um único registro de um repositório.

Parâmetros

Name Chave Necessário Tipo Description
O identificador ou DID do repositório
repo True string

A alça ou DID do repo.

O NSID da coleção de registros
collection True string

O NSID da coleção de registros.

A chave de registro
rkey True string

A chave de registro.

O CID da versão do registo
cid string

O CID da versão do registro.

Devoluções

Name Caminho Tipo Description
URI
uri string

O URI do registro.

CID
cid string

O CID do registro.

valor
value object

O valor do registro.

Obter uma lista de posts curtidos por um ator

Obtenha uma lista de posts curtidos por um ator.

Parâmetros

Name Chave Necessário Tipo Description
Identificador do ator
actor True string

Identificador do ator cujos gostos estão a ser recuperados.

Limite de resultados
limit integer

Número máximo de resultados a devolver.

Cursor de paginação
cursor string

Cursor para paginação.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para a próxima página de resultados.

feed
feed array of feedViewPost

Lista de posts curtidos pelo ator.

Obter valores definidos

Obtenha um conjunto específico e seus valores.

Parâmetros

Name Chave Necessário Tipo Description
Nome do conjunto
name True string

O nome do conjunto a ser recuperado.

Limite de resultados
limit integer

Número máximo de valores a devolver.

Cursor de paginação
cursor string

Cursor para paginação.

Devoluções

Name Caminho Tipo Description
set
set setView
values
values array of string
cursor
cursor string

Obter vista de lista

Obtém uma 'vista' (com contexto adicional) de uma lista especificada.

Parâmetros

Name Chave Necessário Tipo Description
Referência da lista
list True string

Referência (AT-URI) do registo da lista a hidratar.

Limitar resultados
limit integer

O número máximo de resultados a serem retornados.

Cursor para paginação
cursor string

Cursor para recuperar o próximo conjunto de resultados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para o próximo conjunto de resultados.

lista
list listView
items
items array of listItemView

Pesquisar Atores para Typeahead

Recupere sugestões de conta para pesquisa de digitação.

Parâmetros

Name Chave Necessário Tipo Description
Termo de Pesquisa
q string

O termo de pesquisa usado para resultados de digitação.

Limite
limit integer

Número máximo de resultados a recuperar.

Devoluções

Name Caminho Tipo Description
intervenientes
actors array of appProfileViewBasic

Uma matriz de detalhes mínimos do ator que correspondem à pesquisa de digitação.

Pesquisar Contas

Obtenha uma lista de contas que corresponda à sua consulta de pesquisa.

Parâmetros

Name Chave Necessário Tipo Description
Endereço de e-mail para pesquisar.
email string

O endereço de e-mail a pesquisar.

Cursor de paginação para os próximos resultados.
cursor string

Cursor de paginação para o próximo conjunto de resultados.

Número máximo de resultados a recuperar.
limit integer

O número máximo de resultados a recuperar

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor para recuperar o próximo conjunto de resultados.

accounts
accounts array of accountView

Lista de contas correspondentes.

Pesquisar Posts

Encontre publicações que correspondam aos critérios de pesquisa, retornando visualizações dessas publicações.

Parâmetros

Name Chave Necessário Tipo Description
Consulta de pesquisa
q True string

Cadeia de caracteres de consulta de pesquisa.

Ordem de classificação
sort string

Especifica a ordem de classificação dos resultados.

Desde Datetime
since string

Filtre os resultados das publicações após a data/hora indicada (inclusive).

Até Datetime
until string

Filtre os resultados das publicações antes da data/hora indicada (não inclusive).

Conta de Menções
mentions string

Filtre para publicações que mencionem a conta fornecida.

Conta de Autor
author string

Filtre as publicações pela conta fornecida. Os identificadores são resolvidos para DID antes do tempo de consulta.

Filtro de idioma
lang string

Filtrar para publicações no idioma determinado.

Filtro de Domínio
domain string

Filtre para publicações com URLs.

Filtro de URL
url string

Filtre para posts com links.

Filtro de hashtag
tag array

Filtre para publicações com a tag fornecida (hashtag).

Limite de resultados
limit integer

Número máximo de resultados a devolver.

Cursor de paginação
cursor string

Mecanismo de paginação opcional.

Devoluções

Name Caminho Tipo Description
cursor
cursor string
acertosTotal
hitsTotal integer
publicações
posts array of postView

Receber mensagens

Obtenha uma lista de mensagens de uma conversa específica.

Parâmetros

Name Chave Necessário Tipo Description
ID da conversação
convoId True string

O ID da conversa a partir da qual recuperar mensagens.

Limite de paginação
limit integer

O número máximo de mensagens a serem retornadas (padrão: 50, máx: 100).

Cursor de paginação
cursor string

Cursor de paginação para recuperar o próximo conjunto de mensagens.

Devoluções

As saídas desta operação são dinâmicas.

Recuperar visualização de registro

Retorna informações de esquema dinâmico para a exibição de registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do registo
recordId True string

Identificador do registo.

Devoluções

Name Caminho Tipo Description
registo
record object

Detalhes da visualização do registro.

Redefinir Palavra-passe

Redefina a senha de uma conta de usuário usando um token.

Parâmetros

Name Chave Necessário Tipo Description
token
token True string

O token fornecido para a redefinição de senha.

palavra-passe
password True string

A nova senha para a conta de usuário.

Registe-se para receber notificações push

Registe-se para receber notificações push.

Parâmetros

Name Chave Necessário Tipo Description
serviçoFez
serviceDid True string

O DID do serviço de notificação push.

token
token True string

Token de notificação por push.

plataforma
platform True string

A plataforma para a notificação push.

ID do aplicativo
appId True string

Identificador do aplicativo que solicita notificações por push.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se o registro foi bem-sucedido.

RequestPlcOperationSignature

Solicite um e-mail com um código para solicitar uma operação de PLC assinada.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a solicitação foi bem-sucedida.

ResolveHandle

Resolve um identificador (nome de domínio) para um DID.

Parâmetros

Name Chave Necessário Tipo Description
A alça a resolver.
handle True string

A alça a resolver.

Devoluções

Name Caminho Tipo Description
fez
did string

O resolvido FEZ.

Revogar senha do aplicativo

Revogue uma senha de aplicativo pelo nome.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string

O nome da senha do aplicativo a ser revogada.

Sair da conversa

Saia de uma conversa especificando seu ID.

Parâmetros

Name Chave Necessário Tipo Description
convoId
convoId True string

O ID da conversa para sair.

Devoluções

Name Caminho Tipo Description
convoId
convoId string

O ID da conversa que foi deixada.

rev
rev string

O identificador de revisão da conversa.

Seja repostado por

Obtenha uma lista de republicações para uma determinada publicação.

Parâmetros

Name Chave Necessário Tipo Description
URI de referência do post
uri True string

Referência (AT-URI) do registo postal.

Versão específica CID
cid string

Se fornecido, filtra para reposts de versão específica (por CID) do registro de postagem.

Limite de resultados
limit integer

Número máximo de reposts a recuperar.

Cursor de paginação
cursor string

Mecanismo de paginação opcional.

Devoluções

Name Caminho Tipo Description
URI
uri string

Referência (AT-URI) do registo postal.

CID
cid string

Versão específica (CID) do registo postal.

cursor
cursor string

Cursor de paginação para o próximo conjunto de resultados.

repostadoPor
repostedBy array of profileView

Variedade de perfis que repostaram a postagem.

SignPlcOperation

Assina uma operação de PLC para atualizar alguns(s) valor(es) no documento do DID solicitante.

Parâmetros

Name Chave Necessário Tipo Description
token
token True string

Um token recebido através de com.atproto.identity.requestPlcOperationSignature.

Teclas de rotação
rotationKeys array of string
tambémConhecidoComo
alsoKnownAs array of string
verificaçãoMétodos
verificationMethods object
services
services object

Devoluções

Name Caminho Tipo Description
operação
operation object

Silenciar conversa

Silencie uma conversa.

Parâmetros

Name Chave Necessário Tipo Description
convoId
convoId True string

O ID da conversa a ser silenciada.

Devoluções

Name Caminho Tipo Description
Modo de Exibição de Conversa
convo convoView

Representa uma exibição de uma conversa.

Silenciar Lista de Atores

Cria uma relação de mudo para a lista de contas especificada.

Parâmetros

Name Chave Necessário Tipo Description
URI de lista
list True string

Referência de URI à lista de contas a serem silenciadas.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

Silenciar thread

Silencia um thread impedindo notificações do thread e de qualquer um de seus filhos.

Parâmetros

Name Chave Necessário Tipo Description
URI raiz
root True string

Referência de URI à raiz do thread a ser silenciado.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

Solicitar atualização por e-mail

Solicite um token para atualizar o e-mail.

Devoluções

Name Caminho Tipo Description
tokenObrigatório
tokenRequired boolean

Indica se um token é necessário para a atualização de email.

Solicitar confirmação por e-mail

Solicite um e-mail com um código para confirmar a propriedade do e-mail.

Solicitar exclusão de conta

Inicie a exclusão de uma conta de usuário por e-mail.

Solicitar rastreamento

Solicite um serviço para rastrear persistentemente repositórios hospedados.

Parâmetros

Name Chave Necessário Tipo Description
nome do anfitrião
hostname True string

Nome do host do serviço atual que está solicitando ser rastreado.

Solicitar redefinição de senha

Inicie uma redefinição de senha de conta de usuário por e-mail.

Parâmetros

Name Chave Necessário Tipo Description
e-mail
email True string

O endereço de e-mail associado à conta de usuário.

SubmitPlcOperation

Valida uma operação de PLC para garantir que ela não viole as restrições de um serviço.

Parâmetros

Name Chave Necessário Tipo Description
operação
operation True object

A operação do PLC a ser validada.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi validada com êxito.

Tome uma ação de moderação em um ator

Tome uma ação de moderação em um ator

Parâmetros

Name Chave Necessário Tipo Description
evento
event True string

O evento de moderação a emitir.

Assunto
subject True string

O assunto do evento de moderação.

assuntoBlobCids
subjectBlobCids array of string
criado por
createdBy True string

Devoluções

Unmute Ator

Cancela o mudo da conta especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID do ator
actor True string

O identificador (AT-identifier) do ator a ser desativado.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se a operação foi bem-sucedida.

UpdateHandle

Atualiza o identificador da conta atual. Verifica a validade do identificador e atualiza o documento did:plc, se necessário.

Parâmetros

Name Chave Necessário Tipo Description
alça
handle True string

A nova alça.

Devoluções

Name Caminho Tipo Description
sucesso
success boolean

Indica se o identificador foi atualizado com êxito.

mensagem
message string

Informações adicionais sobre a operação.

Ver estados de moderação de assuntos

Veja os estados de moderação dos assuntos (record ou repo).

Parâmetros

Name Chave Necessário Tipo Description
Incluir todos os registros de usuário
includeAllUserRecords boolean

Devolve assuntos, ou assuntos de 'coleções' param, pertencentes à conta especificada.

URI do assunto
subject string

O assunto para obter o status.

Palavra-chave Comment
comment string

Pesquise assuntos por palavra-chave a partir de comentários.

Relatado após o carimbo de data/hora
reportedAfter date-time

Pesquise assuntos relatados após um determinado carimbo de data/hora.

Relatado antes do carimbo de data/hora
reportedBefore date-time

Pesquise assuntos relatados antes de um determinado carimbo de data/hora.

Revisado após carimbo de data/hora
reviewedAfter date-time

Pesquisar assuntos revisados após um determinado carimbo de data/hora.

Revisado antes do carimbo de data/hora
reviewedBefore date-time

Pesquisar assuntos revisados antes de um determinado carimbo de data/hora.

Hospedagem excluída após carimbo de data/hora
hostingDeletedAfter date-time

Pesquise assuntos em que o registro/conta associado foi excluído após o carimbo de data/hora.

Hospedagem excluída antes do carimbo de data/hora
hostingDeletedBefore date-time

Pesquise assuntos em que o registro/conta associado foi excluído antes do carimbo de data/hora.

Hospedagem atualizada após carimbo de data/hora
hostingUpdatedAfter date-time

Pesquise assuntos em que o registro/conta associado foi atualizado após o carimbo de data/hora.

Hospedagem atualizada antes do carimbo de data/hora
hostingUpdatedBefore date-time

Pesquise assuntos em que o registro/conta associado foi atualizado antes do carimbo de data/hora.

Status de hospedagem
hostingStatuses array

Pesquise assuntos pelo estado do registo/conta associado.

Incluir assuntos silenciados
includeMuted boolean

Por padrão, não incluímos assuntos silenciados nos resultados.

Estado da revisão
reviewState string

Especifique ao buscar assuntos em um determinado estado.

Limitar resultados
limit integer

O número máximo de resultados a serem retornados.

Devoluções

Name Caminho Tipo Description
cursor
cursor string

Cursor de paginação para a próxima página de resultados.

assuntoEstatutos
subjectStatuses array of subjectStatusView

Verificar o status da conta

Devolve o estado de uma conta, especialmente no que diz respeito à importação ou recuperação.

Devoluções

Name Caminho Tipo Description
ativado
activated boolean

Indica se a conta está ativada.

validFez
validDid boolean

Indica se o DID é válido.

repoCommit
repoCommit string

Identificador de confirmação para o repositório da conta.

repoRev
repoRev string

Informações de revisão do repositório.

repoBlocks
repoBlocks integer

Número de blocos de repositório.

indexedRecords
indexedRecords integer

Número de registos indexados na conta.

privateStateValues
privateStateValues integer

Número de valores privados do Estado.

Blobs esperados
expectedBlobs integer

Número esperado de blobs.

Blobs importados
importedBlobs integer

Número de blobs importados.

Definições

preferences

Name Caminho Tipo Description
adultoContentPref
adultContentPref adultContentPref
contentLabelPref
contentLabelPref contentLabelPref
savedFeedsPref
savedFeedsPref savedFeedsPref
savedFeedsPrefV2
savedFeedsPrefV2 savedFeedsPrefV2
pessoalDetalhesPref
personalDetailsPref personalDetailsPref
feedViewPref
feedViewPref feedViewPref
threadViewPref
threadViewPref threadViewPref
interessesPref
interestsPref interestsPref
mutedWordsPref
mutedWordsPref mutedWordsPref
hiddenPostsPref
hiddenPostsPref hiddenPostsPref
bskyAppStatePref
bskyAppStatePref bskyAppStatePref

Um pacote de estado específico para o programa bsky.app.

rotuladorasPref
labelersPref labelersPref

adultoContentPref

Name Caminho Tipo Description
enabled
enabled boolean

contentLabelPref

Name Caminho Tipo Description
rotuladorFez
labelerDid string

A que rotuladora se aplica esta preferência?

etiqueta
label string
Visibilidade
visibility string

savedFeed

Name Caminho Tipo Description
id
id string
tipo
type string
valor
value string
fixado
pinned boolean

savedFeedsPrefV2

Name Caminho Tipo Description
items
items array of savedFeed

savedFeedsPref

Name Caminho Tipo Description
fixado
pinned array of string
Salvo
saved array of string
timelineIndex
timelineIndex integer

pessoalDetalhesPref

Name Caminho Tipo Description
Data de nascimento
birthDate date-time

A data de nascimento do proprietário da conta.

feedViewPref

Name Caminho Tipo Description
feed
feed string

O URI do feed ou um identificador que descreve o feed.

ocultarRespostas
hideReplies boolean

Ocultar respostas no feed.

hideRepliesByUnfollowed
hideRepliesByUnfollowed boolean

Oculte as respostas no feed se elas não forem de usuários seguidos.

hideRepliesByLikeCount
hideRepliesByLikeCount integer
ocultarReposts
hideReposts boolean

Ocultar republicações no feed.

ocultarQuotePosts
hideQuotePosts boolean

Ocultar publicações de citações no feed.

threadViewPref

Name Caminho Tipo Description
ordenar
sort string

Modo de classificação para threads.

priorizarUsuários Seguidos
prioritizeFollowedUsers boolean

Mostrar usuários seguidos na parte superior de todas as respostas.

interessesPref

Name Caminho Tipo Description
tags
tags array of string

mutedWordTarget

MudoWord

Uma palavra que o proprietário da conta silenciou.

Name Caminho Tipo Description
id
id string
valor
value string

A própria palavra silenciada.

targets
targets array of mutedWordTarget
actorAlvo
actorTarget string

Grupos de usuários aos quais aplicar a palavra silenciada. Se indefinido, aplica-se a todos os usuários.

expira em
expiresAt date-time

A data e a hora em que a palavra silenciada expirará e não será mais aplicada.

mutedWordsPref

Name Caminho Tipo Description
items
items array of mutedWord

hiddenPostsPref

Name Caminho Tipo Description
items
items array of string

rotuladorasPref

Name Caminho Tipo Description
rotuladoras
labelers array of labelerPrefItem

labelerPrefItem

Name Caminho Tipo Description
fez
did string

starterPackView [en]

Name Caminho Tipo Description
URI
uri string
CID
cid string
registo
record
criador
creator appProfileViewBasic
lista
list listViewBasic
listItemsSample
listItemsSample array of listItemView
Alimentação
feeds array of generatorView
joinedWeekCount
joinedWeekCount integer
juntouAllTimeCount
joinedAllTimeCount integer
labels
labels array of label
indexadoEm
indexedAt date-time

starterPackViewBasic

Name Caminho Tipo Description
URI
uri string
CID
cid string
registo
record
criador
creator appProfileViewBasic
listItemCount
listItemCount integer
joinedWeekCount
joinedWeekCount integer
juntouAllTimeCount
joinedAllTimeCount integer
labels
labels array of label
indexadoEm
indexedAt date-time

bskyAppStatePref

Um pacote de estado específico para o programa bsky.app.

Name Caminho Tipo Description
activeProgressGuide
activeProgressGuide bskyAppProgressGuide

Se definido, um guia de progresso ativo.

queuedNudges
queuedNudges array of string
nuxs
nuxs array of nux

bskyAppProgressGuide

Se definido, um guia de progresso ativo.

Name Caminho Tipo Description
guia
guide string

Nux

Um novo objeto de armazenamento de experiências do usuário (NUX)

Name Caminho Tipo Description
id
id string
concluída
completed boolean
dados
data string

Dados arbitrários para o NUX. Limite de 300 caracteres.

expira em
expiresAt date-time

A data e hora em que o NUX expirará e será concluído.

profileViewDetailed

Name Caminho Tipo Description
fez
did string
alça
handle string
nome de exibição
displayName string
descrição
description string
Avatar
avatar string
estandarte
banner string
seguidoresContagem
followersCount integer
segueContagem
followsCount integer
postsContagem
postsCount integer
associados
associated profileAssociated
joinedViaStarterPack
joinedViaStarterPack starterPackViewBasic
indexadoEm
indexedAt date-time
criadosAt
createdAt date-time
espetador
viewer appViewerState

Metadados sobre a relação da conta requerente com a conta do titular.

labels
labels array of label
pinnedPost
pinnedPost strongRef

Define uma referência forte com um URI e CID.

perfilVer perfil

Informações básicas sobre um perfil.

Name Caminho Tipo Description
fez
did string

Identificador descentralizado (DID) do perfil.

alça
handle string

O identificador do perfil.

nome de exibição
displayName string

Nome para exibição do perfil.

Avatar
avatar string

URL do avatar do perfil.

associados
associated associatedMetadata

Metadados associados para um perfil.

espetador
viewer viewerMetadata

Metadados sobre a relação do espectador com o ator.

labels
labels array of label

Etiquetas associadas ao perfil.

criadosAt
createdAt date-time

Carimbo de data/hora quando o perfil foi criado.

Metadados associados

Metadados associados para um perfil.

Name Caminho Tipo Description
listas
lists integer

Número de listas associadas.

Alimentadores
feedgens integer

Número de geradores de alimentação associados.

starterPacks
starterPacks integer

Número de pacotes iniciais.

rotuladora
labeler boolean

Indica se o perfil é um rotulador.

allowIncoming
chat.allowIncoming string

Configurações de bate-papo de entrada permitidas (por exemplo, "todos").

mutedByList

Detalhes de uma lista que silenciou o ator.

Name Caminho Tipo Description
URI
uri string

URI da lista que silenciou o ator.

CID
cid string

Identificador de conteúdo (CID) da lista.

nome
name string

Nome da lista.

purpose
purpose string

Objetivo da lista.

Avatar
avatar string

URI da imagem do avatar para a lista.

listItemCount
listItemCount integer

Número de itens na lista.

labels
labels array of label

Rótulos associados à lista.

espetador
viewer viewerMetadata

Metadados sobre a relação do espectador com o ator.

indexadoEm
indexedAt date-time

O carimbo de data/hora quando a lista foi indexada.

blockingByList

Detalhes de uma lista que bloqueia o ator.

Name Caminho Tipo Description
URI
uri string

URI da lista que bloqueia o ator.

CID
cid string

Identificador de conteúdo (CID) da lista.

nome
name string

Nome da lista.

purpose
purpose string

Objetivo da lista.

Avatar
avatar string

URI da imagem do avatar para a lista.

listItemCount
listItemCount integer

Número de itens na lista.

labels
labels array of label

Rótulos associados à lista.

espetador
viewer viewerMetadata

Metadados sobre a relação do espectador com o ator.

indexadoEm
indexedAt date-time

O carimbo de data/hora quando a lista foi indexada.

viewerMetadados

Metadados sobre a relação do espectador com o ator.

Name Caminho Tipo Description
silenciado
muted boolean

Indica se o ator está silenciado pelo espectador.

bloqueadoPor
blockedBy boolean

Indica se o ator está bloqueado pelo espectador.

bloqueio
blocking string

Indica se o espectador está bloqueando o ator.

a seguir
following string

Indica se o espectador está seguindo o ator.

seguidoPor
followedBy string

Indica se o ator está seguindo o espectador.

mutedByList
mutedByList mutedByList

Detalhes de uma lista que silenciou o ator.

blockingByList
blockingByList blockingByList

Detalhes de uma lista que bloqueia o ator.

pósVer

Name Caminho Tipo Description
object

feedReplyRef

Name Caminho Tipo Description
raiz
root object

Referência de postagem raiz, que pode ser postView, notFoundPost ou blockedPost.

elemento principal
parent object

Referência de post pai, que pode ser postView, notFoundPost ou blockedPost.

avôAutor
grandparentAuthor appProfileViewBasic

strongRef

Define uma referência forte com um URI e CID.

Name Caminho Tipo Description
URI
uri string

O URI da referência forte.

CID
cid string

O CID da referência forte.

perfilAssociado

Name Caminho Tipo Description
listas
lists integer
Alimentadores
feedgens integer
starterPacks
starterPacks integer
rotuladora
labeler boolean
chat
chat profileAssociatedChat

appViewerState

Metadados sobre a relação da conta requerente com a conta do titular.

Name Caminho Tipo Description
silenciado
muted boolean
mutedByList
mutedByList listViewBasic
bloqueadoPor
blockedBy boolean
bloqueio
blocking string
blockingByList
blockingByList listViewBasic
a seguir
following string
seguidoPor
followedBy string
conhecidosSeguidores
knownFollowers knownFollowers

Os seguidores do sujeito que você também segue.

perfilAssociatedChat

Name Caminho Tipo Description
allowIncoming
allowIncoming string

listView

Name Caminho Tipo Description
URI
uri string
CID
cid string
criador
creator profileView

Informações básicas sobre um perfil.

nome
name string
purpose
purpose listPurpose

Define a finalidade da lista.

descrição
description string
descriçãoFacetas
descriptionFacets array of richtextFacet
Avatar
avatar string
listItemCount
listItemCount integer
labels
labels array of label
espetador
viewer listViewerState
indexadoEm
indexedAt date-time

listItemView

Name Caminho Tipo Description
URI
uri string
Assunto
subject profileView

Informações básicas sobre um perfil.

listViewBasic

Name Caminho Tipo Description
URI
uri string
CID
cid string
nome
name string
purpose
purpose listPurpose

Define a finalidade da lista.

Avatar
avatar string
listItemCount
listItemCount integer
labels
labels array of label
espetador
viewer listViewerState
indexadoEm
indexedAt string

etiqueta

Tag de metadados em um recurso atproto (por exemplo, repo ou registro).

Name Caminho Tipo Description
ver
ver integer
SRC
src string

DID do ator que criou este selo.

URI
uri string

AT URI do registro, repo (conta) ou outro recurso ao qual esse rótulo se aplica.

CID
cid string

Opcionalmente, CID especificando a versão específica do recurso 'uri' ao qual esse rótulo se aplica.

Val
val string

O nome da cadeia de caracteres curta do valor ou tipo desse rótulo.

neg
neg boolean

Se verdadeiro, este é um rótulo de negação, substituindo um rótulo anterior.

CTS
cts date-time

Carimbo de data/hora quando este rótulo foi criado.

exp
exp date-time

Carimbo de data/hora no qual este rótulo expira (não se aplica mais).

sig
sig byte

Assinatura do rótulo codificado dag-cbor.

ActorMetadata

Name Caminho Tipo Description
mensagensEnviadas
messagesSent integer

O número de mensagens enviadas pelo ator.

mensagensRecebidas
messagesReceived integer

O número de mensagens recebidas pelo ator.

Convos
convos integer

O número total de conversas em que o ator participou.

convosIniciado
convosStarted integer

O número de conversas iniciadas pelo ator.

conhecidosSeguidores

Os seguidores do sujeito que você também segue.

Name Caminho Tipo Description
count
count integer
seguidores
followers array of appProfileViewBasic

appProfileViewBasic

Name Caminho Tipo Description
fez
did string

Identificador Descentralizado (DID) do ator.

alça
handle string

Alça única do ator.

nome de exibição
displayName string

Nome de exibição do ator.

Avatar
avatar string

URI da imagem do avatar do ator.

criadosAt
createdAt date-time

O carimbo de data/hora da criação do perfil do ator.

chatProfileViewBasic

Name Caminho Tipo Description
fez
did string
alça
handle string

Alça do ator.

nome de exibição
displayName string

Nome de exibição do ator.

Avatar
avatar string

URI do avatar do ator.

associados
associated profileAssociated
espetador
viewer appViewerState

Metadados sobre a relação da conta requerente com a conta do titular.

labels
labels array of label

Matriz de rótulos associados ao ator.

chatDesativado
chatDisabled boolean

Indica se o ator não pode participar ativamente das conversas.

listFinalidade

Define a finalidade da lista.

Name Caminho Tipo Description
tipo
type string

O tipo de finalidade da lista.

Propriedade Modlist
modlistProperty string

Uma propriedade específica para modlist.

Propriedade Curatelist
curatelistProperty string

Uma propriedade específica para curatelist.

Propriedade Referencelist
referencelistProperty string

Uma propriedade específica para referencelist.

listViewerState

Name Caminho Tipo Description
silenciado
muted boolean
bloqueado
blocked string

convoVer

Representa uma exibição de uma conversa.

Name Caminho Tipo Description
ID da conversação
id string

O identificador exclusivo da conversa.

Revisão de Conversação
rev string

O identificador de revisão da conversa.

Membros da conversa
members array of chatProfileViewBasic

Lista de membros na conversa.

id
lastMessage.id string

O identificador exclusivo da mensagem.

conteúdo
lastMessage.content string

O conteúdo da última mensagem.

carimbo de data/hora
lastMessage.timestamp date-time

A hora em que a última mensagem foi enviada.

A conversa é silenciada
muted boolean

Indica se a conversa está silenciada.

A conversa está aberta
opened boolean

Indica se a conversa foi aberta.

Contagem de mensagens não lidas
unreadCount integer

A contagem de mensagens não lidas na conversa.

messageViewSender

Name Caminho Tipo Description
fez
did string

Identificador descentralizado do remetente.

richtextFacet

Anotação de uma subcadeia de caracteres dentro de rich text.

Name Caminho Tipo Description
indexar
index richTextFacetByteSlice

Especifica o intervalo de subcadeia de caracteres ao qual um recurso de faceta se aplica.

features
features array of object
Tipo de recurso
features.featureType string

Tipo do recurso.

details
features.details object

Detalhes sobre o recurso.

richTextFacetByteSlice

Especifica o intervalo de subcadeia de caracteres ao qual um recurso de faceta se aplica.

Name Caminho Tipo Description
byteStart
byteStart integer

O byte inicial do intervalo.

byteEnd
byteEnd integer

O byte final do intervalo.

deletedMessageView

Name Caminho Tipo Description
id
id string

O ID da mensagem excluída.

rev
rev string

A ID de revisão da mensagem excluída.

remetente
sender messageViewSender
enviado.
sentAt date-time

O carimbo de data/hora quando a mensagem foi enviada.

Última mensagem

Representa a última mensagem de uma conversa.

Name Caminho Tipo Description
id
id string

O identificador exclusivo da mensagem.

enviar SMS
text string

O conteúdo de texto da mensagem.

remetente
sender string

O identificador do remetente da mensagem.

enviado.
sentAt date-time

A hora em que a mensagem foi enviada.

accountView

Name Caminho Tipo Description
fez
did string
alça
handle string
e-mail
email string
relatedRecords
relatedRecords array of
indexadoEm
indexedAt date-time
convidadoPor
invitedBy inviteCode
convida
invites array of inviteCode
convidadosDesativado
invitesDisabled boolean
emailConfirmado
emailConfirmedAt date-time
ConvidarNota
inviteNote string
desativadoAT
deactivatedAt date-time
ameaçaAssinaturas
threatSignatures array of threatSignature

Código de convite

Name Caminho Tipo Description
código
code string
available
available integer
desactivado
disabled boolean
paraConta
forAccount string
criado por
createdBy string
criadosAt
createdAt date-time
Utilizações
uses array of inviteCodeUse

threatSignature

Name Caminho Tipo Description
propriedade
property string
valor
value string

inviteCodeUse

Name Caminho Tipo Description
usadoPor
usedBy string
usadosEm
usedAt date-time

statusAttr

Name Caminho Tipo Description
aplicada
applied boolean
refª
ref string

createAppPassword

Name Caminho Tipo Description
nome
name string
palavra-passe
password string
criadosAt
createdAt date-time
privilegiado
privileged boolean

listAppPassword

Name Caminho Tipo Description
nome
name string
criadosAt
createdAt string
privilegiado
privileged boolean
Name Caminho Tipo Description
Política de Privacidade
privacyPolicy string
termosdeserviço
termsOfService string

serviceConfig

Name Caminho Tipo Description
URL
url string

viewerConfig

Name Caminho Tipo Description
função
role string

describeServerContact

Name Caminho Tipo Description
e-mail
email string

describeFeedGeneratorFeed

Name Caminho Tipo Description
URI
uri string
Name Caminho Tipo Description
Política de Privacidade
privacyPolicy string
termosdeserviço
termsOfService string

feedViewPost

Name Caminho Tipo Description
mensagem
post postView
Responder
reply feedReplyRef
tipo
reason.type string
details
reason.details object

Detalhes adicionais específicos para o tipo de motivo. Corresponde a reasonRepost ou reasonPin.

feedContext
feedContext string

Contexto fornecido pelo gerador de alimentação que pode ser passado de volta junto com as interações.

geradorVer

Name Caminho Tipo Description
URI
uri string
CID
cid string
fez
did string
criador
creator profileView

Informações básicas sobre um perfil.

nome de exibição
displayName string
descrição
description string
descriçãoFacetas
descriptionFacets array of richtextFacet
Avatar
avatar string
likeCount
likeCount integer
aceitaInterações
acceptsInteractions boolean
labels
labels array of label
espetador
viewer generatorViewerState
indexadoEm
indexedAt date-time

generatorViewerState

Name Caminho Tipo Description
gostar
like string

threadgateVer

Name Caminho Tipo Description
URI
uri string
CID
cid string
registo
record
listas
lists array of listViewBasic

getLikesLike

Name Caminho Tipo Description
indexadoEm
indexedAt date-time
criadosAt
createdAt date-time
ator
actor profileView

Informações básicas sobre um perfil.

esqueletoFeedPost

Name Caminho Tipo Description
mensagem
post string

O AT-URI do post.

reasonRepost
reasonRepost skeletonReasonRepost
razãoPin
reasonPin skeletonReasonPin
feedContext
feedContext string

O contexto passou para o cliente e retornou ao gerador de feed junto com as interações.

esqueletoReasonRepost

Name Caminho Tipo Description
repost
repost string

esqueletoReasonPin

reasonType

Tipo de motivo para o relatório de moderação. Uma das razões pré-definidas.

Name Caminho Tipo Description
reasonSpam
reasonSpam reasonSpam

Spam: promoção indesejada frequente, respostas, menções

razãoViolação
reasonViolation reasonViolation

Violação direta das regras do servidor, leis, termos de serviço

razãoEnganosa
reasonMisleading reasonMisleading

Identidade, afiliação ou conteúdo enganoso

razãoSexual
reasonSexual reasonSexual

Conteúdo sexual indesejado ou rotulado incorretamente

razãoRude
reasonRude reasonRude

Comportamento rude, assediador, explícito ou de outra forma não acolhedor

razãoOutro
reasonOther reasonOther

Outros: relatórios não abrangidos por outra categoria de relatório

razãoRecurso
reasonAppeal reasonAppeal

Recurso: recorrer de uma ação de moderação previamente tomada

reasonSpam

Spam: promoção indesejada frequente, respostas, menções

Spam: promoção indesejada frequente, respostas, menções

razãoViolação

Violação direta das regras do servidor, leis, termos de serviço

Violação direta das regras do servidor, leis, termos de serviço

razãoEnganosa

Identidade, afiliação ou conteúdo enganoso

Identidade, afiliação ou conteúdo enganoso

razãoSexual

Conteúdo sexual indesejado ou rotulado incorretamente

Conteúdo sexual indesejado ou rotulado incorretamente

razãoRude

Comportamento rude, assediador, explícito ou de outra forma não acolhedor

Comportamento rude, assediador, explícito ou de outra forma não acolhedor

razãoOutro

Outros: relatórios não abrangidos por outra categoria de relatório

Outros: relatórios não abrangidos por outra categoria de relatório

razãoRecurso

Recurso: recorrer de uma ação de moderação previamente tomada

Recurso: recorrer de uma ação de moderação previamente tomada

repoRef

Name Caminho Tipo Description
fez
did string

repoBlobRef

Name Caminho Tipo Description
fez
did string
CID
cid string
recordUri
recordUri string

notificação

Name Caminho Tipo Description
URI
uri string
CID
cid string
autor
author profileView

Informações básicas sobre um perfil.

razão
reason string

Os valores esperados são 'like', 'repost', 'follow', 'mention', 'reply', 'quote' e 'starterpack-joined'.

razãoAssunto
reasonSubject string
registo
record
isRead
isRead boolean
indexadoEm
indexedAt date-time
labels
labels array of label

labelerVer

Name Caminho Tipo Description
URI
uri string
CID
cid string
criador
creator profileView

Informações básicas sobre um perfil.

likeCount
likeCount integer
espetador
viewer labelerViewerState
indexadoEm
indexedAt date-time
labels
labels array of label

labelerViewerState

Name Caminho Tipo Description
gostar
like string

situação do emprego

Name Caminho Tipo Description
jobId
jobId string
fez
did string
state
state string

O estado do trabalho de processamento de vídeo.

Progressos
progress integer
blob
blob binary
erro
error string
mensagem
message string

modeloVer

Name Caminho Tipo Description
id
id string
nome
name string

Nome do modelo.

Assunto
subject string

Conteúdo do modelo, pode conter markdown e espaços reservados variáveis.

contentMarkdown
contentMarkdown string

Assunto da mensagem, usado em e-mails.

desactivado
disabled boolean
idioma
lang string

Idioma da mensagem.

lastUpdatedBy
lastUpdatedBy string

DID do usuário que atualizou o modelo pela última vez.

criadosAt
createdAt date-time
atualizadoem
updatedAt date-time

repoVer

Name Caminho Tipo Description
fez
did string
alça
handle string
e-mail
email string
relatedRecords
relatedRecords array of
indexadoEm
indexedAt date-time
moderation
moderation moderation
convidadoPor
invitedBy inviteCode
convidadosDesativado
invitesDisabled boolean
ConvidarNota
inviteNote string
desativadoAT
deactivatedAt date-time
ameaçaAssinaturas
threatSignatures array of threatSignature

moderation

Name Caminho Tipo Description
subjectStatus
subjectStatus subjectStatusView

subjectStatusView

Name Caminho Tipo Description
id
id integer

O identificador exclusivo do status do assunto.

tipo
subject.type string

O tipo de referência de assunto.

repoRef
subject.repoRef repoRef
strongRef
subject.strongRef strongRef

Define uma referência forte com um URI e CID.

tipo
hosting.type string

O tipo de hospedagem.

estado
hosting.accountHosting.status string
atualizadoem
hosting.accountHosting.updatedAt date-time
criadosAt
hosting.accountHosting.createdAt date-time
estado
hosting.recordHosting.status string
atualizadoem
hosting.recordHosting.updatedAt date-time
criadosAt
hosting.recordHosting.createdAt date-time
criadosAt
createdAt date-time

Carimbo de data/hora de quando o status do assunto foi criado.

atualizadoem
updatedAt date-time

Carimbo de data/hora de quando o status do assunto foi atualizado pela última vez.

revisãoEstado
reviewState string

O estado de revisão do assunto.

modEventView

Name Caminho Tipo Description
id
id integer
tipo
event.type string
tipo
subject.type string
assuntoBlobCids
subjectBlobCids array of string
criado por
createdBy string
criadosAt
createdAt date-time
creatorHandle
creatorHandle string
subjectHandle
subjectHandle string

applyWrites.result

Name Caminho Tipo Description
tipo
type string

Tipo de resultado para a operação de gravação.

createResult
createResult applyWrites.createResult
updateResult
updateResult applyWrites.updateResult
Excluir resultado da operação
deleteResult applyWrites.deleteResult

applyWrites.createResult

Name Caminho Tipo Description
URI
uri string
CID
cid string
validationStatus
validationStatus string

applyWrites.updateResult

Name Caminho Tipo Description
URI
uri string
CID
cid string
validationStatus
validationStatus string

applyWrites.deleteResult

Name Caminho Tipo Description
id
id string

Identificador da entidade excluída.

suprimidoEm
deletedAt date-time

Carimbo de data/hora de quando a entidade foi excluída.

commitMeta

Name Caminho Tipo Description
CID
cid string
rev
rev string

modEventViewDetail

Name Caminho Tipo Description
id
id integer

O identificador exclusivo para o evento de moderação.

tipo
event.type string

O tipo de evento.

tipo
subject.type string

O tipo de assunto.

assuntoBlobs
subjectBlobs array of blobView

Detalhes sobre as bolhas associadas ao assunto.

criado por
createdBy string

O DID do usuário que criou o evento.

criadosAt
createdAt date-time

O carimbo de data/hora quando o evento foi criado.

blobVer

Name Caminho Tipo Description
CID
cid string

Identificador de conteúdo para o blob.

mimeType
mimeType string

Tipo MIME do blob.

size
size integer

Tamanho do blob em bytes.

criadosAt
createdAt date-time

Carimbo de data/hora quando o blob foi criado.

tipo
details.type string

Tipo de detalhes de blob.

imageDetails
details.imageDetails imageDetails
vídeoDetalhes
details.videoDetails videoDetails
moderation
moderation moderation

imageDetails

Name Caminho Tipo Description
Largura
width integer

Largura da imagem em pixels.

altura
height integer

Altura da imagem em pixels.

vídeoDetalhes

Name Caminho Tipo Description
Largura
width integer

Largura do vídeo em pixels.

altura
height integer

Altura do vídeo em pixels.

length
length integer

Duração do vídeo em segundos.

recordViewDetail

Name Caminho Tipo Description
URI
uri string
CID
cid string
valor
value
manchas
blobs array of blobView
labels
labels array of label
indexadoEm
indexedAt date-time
moderation
moderation moderationDetail
repositório
repo repoView

moderaçãoDetalhe

Name Caminho Tipo Description
subjectStatus
subjectStatus subjectStatusView

repoViewDetail

Name Caminho Tipo Description
fez
did string
alça
handle string
e-mail
email string
relatedRecords
relatedRecords array of
indexadoEm
indexedAt date-time
moderation
moderation moderationDetail
labels
labels array of label
convidadoPor
invitedBy inviteCode
convida
invites array of inviteCode
convidadosDesativado
invitesDisabled boolean
ConvidarNota
inviteNote string
emailConfirmado
emailConfirmedAt date-time
desativadoAT
deactivatedAt date-time
ameaçaAssinaturas
threatSignatures array of threatSignature

Membro

Name Caminho Tipo Description
fez
did string
desactivado
disabled boolean
perfil
profile profileViewDetailed
criadosAt
createdAt date-time
atualizadoem
updatedAt date-time
lastUpdatedBy
lastUpdatedBy string
função
role string

listMissingBlobs.recordBlob

Name Caminho Tipo Description
CID
cid string
recordUri
recordUri string

listRecords.record

Name Caminho Tipo Description
URI
uri string
CID
cid string
valor
value

listRepos.repo

Name Caminho Tipo Description
fez
did string
cabeçalho
head string

Repo atual compromete CID

rev
rev string
active
active boolean
estado
status string

Valor verdadeiro ou falso indicando por que a conta está inativa.

setVer

Name Caminho Tipo Description
nome
name string
descrição
description string
setTamanho
setSize integer
criadosAt
createdAt date-time
atualizadoem
updatedAt date-time

sigDetalhe

Name Caminho Tipo Description
propriedade
property string
valor
value string

findRelatedAccounts.relatedAccount

Name Caminho Tipo Description
conta
account accountView
semelhanças
similarities array of sigDetail

binário

Este é o tipo de dados básico 'binário'.

ficheiro

Este é o tipo de dados básicos 'arquivo'.