PicChat

Bases de conhecimento

Listar bases de conhecimento

GEThttps://api.picchat.com.br/v1/knowledge-bases

Lista as bases de conhecimento da conta (excluídas ficam de fora), ordenadas por updated_at, com os canais que as usam e o total de itens. O conteúdo dos itens não é devolvido.

Autenticação: Bearer tokenPermissão: Base de conhecimento › ver

Parâmetros de consulta (query)

  • pageintegerpadrão 1

    Página, começando em 1. Valor ausente, inválido ou menor que 1 vira 1.

  • limitintegerpadrão 20

    Itens por página. Padrão 20, máximo 100: acima disso é reduzido para 100 sem erro; valor inválido ou menor que 1 vira 20.

  • channel_idstring (uuid)

    Só bases ligadas a este canal (vínculo ativo).

  • searchstring

    Busca parcial no título, sem diferenciar maiúsculas.

  • orderstringpadrão "desc"

    Direção da ordenação por `updated_at`. Qualquer outro valor usa o padrão.

Respostas

200OK

  • itemsarray<KnowledgeBase>obrigatório

    Registros da página.

  • items[].idstring (uuid)obrigatório

    ID da base.

  • items[].titlestringobrigatório

    Título.

  • items[].fontstring | nullobrigatório

    Origem da base.

  • items[].created_atstring (date-time)obrigatório

    Criação.

  • items[].updated_atstring (date-time)obrigatório

    Última atualização.

  • items[].usersobjectobrigatório

    Usuário resumido (só nome).

  • items[].users.idstring (uuid)obrigatório

    ID do usuário.

  • items[].users.namestringobrigatório

    Nome.

  • items[].channelsarray<ChannelRef>obrigatório

    Canais que usam a base.

  • items[].channels[].idstring (uuid)obrigatório

    ID do canal.

  • items[].channels[].namestringobrigatório

    Nome do canal.

  • items[].channels[].typestringobrigatório

    Tipo do canal.

    whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs

  • items[].items_countintegerobrigatório

    Quantidade de itens na base.

  • totalintegerobrigatório

    Total de registros que casam com os filtros (todas as páginas).

  • pageintegerobrigatório

    Página devolvida (começa em 1).

  • limitintegerobrigatório

    Itens por página efetivamente usados (1–100).

  • pagesintegerobrigatório

    Total de páginas: `max(1, ceil(total / limit))`. Nunca é 0, mesmo sem resultados.

403Acesso negado: usuário do token sem a permissão da rota (`permission_denied`) ou token não ligado a um usuário ativo (`token_without_user`) — para token de integração da conta isso só é aplicado quando `access.enforced` é true (veja GET /v1/me); token pessoal e JWT de sessão são sempre verificados; `account_id` na query diferente da conta do token; conta do tipo INFRA.

498Token ausente, inválido, de outra finalidade (ex.: token do canal chat) ou revogado. Note o status não padrão 498.