NodaroAccount
Docs do Nodaro
DocumentaçãoReferência de nósModelosTemplatesAgentes de IA (MCP)DesenvolvedoresAuto-hospedagemPesquisaComparações
SDK para TypeScript

Biblioteca da comunidade

Explore a biblioteca da comunidade do Nodaro em TypeScript, clone na sua conta personagens, locais e objetos, favorite-os e denuncie uma publicação.

Disponível em Nodaro Cloud · Business edition

client.community lê a biblioteca da comunidade, a coleção compartilhada de personagens, locais e objetos selecionados pela equipe do Nodaro. Você pode explorar a biblioteca e buscar nela, ler uma publicação, clonar uma publicação na sua própria conta, favoritá-la e denunciá-la para moderação. Os métodos chamam a API REST da comunidade. Veja Biblioteca da comunidade para conhecer o recurso e as regras de direito de imagem e de consentimento.

A biblioteca da comunidade existe nas instalações multiusuário: Nodaro Cloud e Business edition. Uma instalação da Community Edition, de um único usuário, responde a todas as chamadas com NotFoundError. Uma implantação que não permite trabalhos públicos não oferece nenhuma publicação: browse() e favorites() retornam listas vazias, e get(), getFull() e clone() lançam NotFoundError.

Métodos

MétodoO que faz
browse(params?)Explora as publicações e busca nelas
get(slug)Lê uma publicação
getFull(slug)Lê uma publicação com o instantâneo público completo
favorites()Lista as publicações que você favoritou
clone(id, entityType)Copia uma publicação para a sua conta
favorite(id)Adiciona ou remove um favorito
report(id, reason)Denuncia uma publicação para moderação

Publicar não faz parte do SDK: os tokens pessoais e OAuth do SDK não podem publicar.

client.community

Uma publicação é um CommunityCard. Os campos dela usam snake_case, como a API os envia. CommunityEntityType é "character", "location" ou "object".

browse(params?)

Retorna uma página de publicações públicas e um nextCursor (GET /v1/community/browse). Passe nextCursor de volta como cursor para obter a próxima página; ele é null na última página.

browse(params?: BrowseCommunityParams): Promise<{ data: CommunityCard[]; nextCursor: string | null }>

Propriedade

Tipo

const { data: listings, nextCursor } = await client.community.browse({
  entityType: "character",
  sort: "popular",
  limit: 20,
})

get(slug)

Lê uma publicação pelo slug (GET /v1/community/detail/:slug).

get(slug: string): Promise<{ data: CommunityCard }>

Propriedade

Tipo

const { data: listing } = await client.community.get("detective-mara")

Lança NotFoundError quando a publicação não existe ou não está mais ativa.

getFull(slug)

Lê uma publicação com o instantâneo público completo: imagens, voz e texto, como uma página de detalhes os mostra (GET /v1/community/detail/:slug/full).

getFull(slug: string): Promise<{ data: CommunityFullDetail }>

Propriedade

Tipo

const { data: detail } = await client.community.getFull("detective-mara")

favorites()

Lista as publicações que você favoritou (GET /v1/community/favorites).

favorites(): Promise<{ data: CommunityCard[] }>
const { data: favorites } = await client.community.favorites()

clone(id, entityType)

Copia uma publicação para a sua biblioteca como uma cópia independente (POST /v1/community/listings/:id/clone). Os arquivos dela são copiados para o seu próprio armazenamento, então a cópia continua existindo quando o original muda ou é removido. Retorna o tipo e o ID da sua nova entidade.

clone(id: string, entityType: "character" | "location" | "object"): Promise<{ entityType: string; id: string }>

Propriedade

Tipo

const { id: characterId } = await client.community.clone(listingId, "character")
const character = await client.characters.get(characterId)

Um token OAuth precisa do escopo assets:write. Lança StorageExceededError quando o seu armazenamento está cheio.

favorite(id)

Adiciona uma publicação aos seus favoritos, ou a remove quando ela já está lá (POST /v1/community/listings/:id/favorite). Retorna o novo estado.

favorite(id: string): Promise<{ favorited: boolean }>

Propriedade

Tipo

const { favorited } = await client.community.favorite(listingId)

report(id, reason)

Denuncia uma publicação para moderação (POST /v1/community/listings/:id/report).

report(id: string, reason: CommunityReportReason): Promise<{ ok: true }>

Propriedade

Tipo

await client.community.report(listingId, "real_person_no_consent")

client.keepers

client.keepers lê o Nodaro Keepers, a prateleira compartilhada de personagens, criaturas, locais e objetos que os administradores da plataforma escolhem, e copia um item para a sua conta. Os métodos chamam as rotas do Keepers. Ler a prateleira não precisa de credencial, então um visitante pode explorá-la. Ler e copiar não custam créditos.

catalog(params?)

Retorna uma página da prateleira: { data: KeeperCatalogItem[], next }.

catalog(params?: { kind?: KeeperKind; cursor?: string; limit?: number }): Promise<KeeperCatalogPage>

Propriedade

Tipo

Cada item é { id, kind, name, description, imageUrl, previewUrl, category, sort, createdAt }. previewUrl é uma cópia da imagem principal com 480 pixels de largura, para um bloco. category é o título da seção na prateleira, e sort é a ordem na prateleira. A prateleira contém apenas campos de exibição. Ela fica em cache por um minuto, e um endereço pode lê-la 60 vezes por minuto.

const { data, next } = await client.keepers.catalog({ kind: "character" })

copy(kind, id)

Copia um item da prateleira para a sua conta e retorna { id, name, kind, created }. id é a sua própria linha: leia-a com client.characters.get(id) e com os outros métodos de entidades.

copy(kind: KeeperKind, id: string): Promise<CopyKeeperResult>
  • A cópia contém o texto público, a imagem principal e as mídias de variação. Todo arquivo é copiado para o seu próprio armazenamento e conta no limite dele.
  • Uma voz pronta ou da biblioteca é levada junto. Uma voz personalizada ou clonada fica reduzida ao nome e à amostra. As escolhas de seletores do dono, as fotos de referência e os campos de modelo treinado nunca são levados.
  • A cópia vai para o seu projeto padrão. Ela não muda quando a original muda.
  • Uma cópia por pessoa e item: uma chamada posterior retorna a mesma cópia com created: false. Uma cópia que você arquivou volta desarquivada, e uma cópia que você já tem continua sua, esteja o item ainda na prateleira ou não.
  • Lança NotFoundError para um item que não está na prateleira quando você não tem nenhuma cópia dele. Lança um 413 storage_limit_exceeded quando os arquivos dele não cabem no seu armazenamento, e ForbiddenError com personal_space_disabled quando a sua organização fechou o espaço pessoal.
  • Um token de app OAuth precisa do escopo assets:write.
const { id } = await client.keepers.copy("character", item.id)
const mine = await client.characters.get(id)

Perguntas frequentes

Como copiar um personagem da comunidade para a minha conta?

Chame client.community.clone com o ID da publicação e o tipo de entidade, como character. A cópia é sua e não muda quando o original muda. Ela conta no seu armazenamento.

Posso publicar na biblioteca da comunidade com o SDK?

Não. Publicar não faz parte do SDK. O SDK pode explorar, ler, clonar, favoritar e denunciar publicações.

Por que client.community responde 404 na minha instalação?

A biblioteca da comunidade existe no Nodaro Cloud e nas instalações da Business edition. Uma instalação da Community Edition, de um único usuário, não tem as rotas da comunidade e responde 404.

Como denunciar uma publicação que mostra uma pessoa real sem consentimento?

Chame client.community.report com o ID da publicação e o motivo real_person_no_consent. A publicação vai para moderação.

Como usar um personagem do Nodaro Keepers pelo SDK?

Leia a prateleira com client.keepers.catalog e depois chame client.keepers.copy com o tipo e o ID do item. A cópia é um personagem seu, e não custa créditos.

Última atualização

Nesta página