PicChat

Assistentes de IA

Listar assistentes de IA

GEThttps://api.picchat.com.br/v1/assistants

Lista os assistentes de IA da conta (excluídos e modelos de assistente ficam de fora) em ordem alfabética, com instruções, canais, ferramentas (sem autenticação nem schemas) e total de itens de conhecimento. channel_id casa tanto o canal principal quanto os vínculos ativos. Não aceita order.

Autenticação: Bearer tokenPermissão: Assistentes › 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ó assistentes que atendem neste canal.

  • typestring

    Função do assistente.

  • statusstring

    Status (igualdade exata, ex.: `active`).

  • searchstring

    Busca parcial no nome, sem diferenciar maiúsculas.

Respostas

200OK

  • itemsarray<Assistant>obrigatório

    Registros da página.

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

    ID do assistente.

  • items[].namestringobrigatório

    Nome.

  • items[].descriptionstring | nullobrigatório

    Descrição.

  • items[].typestring | nullobrigatório

    Função do assistente.

    chatbotsuggestionsummarynpstranscriptiontaggingtext_improvementpipelineresearchnull

  • items[].type_IAstring | nullobrigatório

    Nível do modelo (define o custo em créditos).

    litestandardexpertadvancedultranull

  • items[].modelstring | nullobrigatório

    Modelo de IA.

  • items[].statusstring | nullobrigatório

    Status (ex.: active, inactive).

  • items[].personstring | nullobrigatório

    Persona.

  • items[].aboutstring | nullobrigatório

    Sobre a empresa.

  • items[].communication_rulesstring | nullobrigatório

    Regras de comunicação.

  • items[].instructionsstringobrigatório

    Instruções (prompt).

  • items[].temperaturenumber | nullobrigatório

    Temperatura.

  • items[].max_tokensinteger | nullobrigatório

    Limite de tokens por resposta.

  • items[].top_pnumber | nullobrigatório

    top_p.

  • items[].thresholdinteger | nullobrigatório

    Similaridade mínima (0–100) para usar a base de conhecimento.

  • items[].low_similarity_actionstringobrigatório

    O que fazer abaixo do threshold: respond_with_history, escalate_to_human ou ignore.

  • items[].search_knowledge_baseboolean | nullobrigatório

    Consulta a base de conhecimento.

  • items[].stop_on_user_replyboolean | nullobrigatório

    Para de responder quando um atendente responde.

  • items[].requires_human_approvalboolean | nullobrigatório

    Respostas exigem aprovação humana.

  • items[].is_templatebooleanobrigatório

    Sempre false nesta API (modelos de assistente ficam de fora da listagem).

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

    Criação.

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

    Última atualização.

  • items[].channelobject | nullobrigatório

    Canal principal (vínculo legado assistants.channel_id).

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

    ID do canal.

  • items[].channel.namestringobrigatório

    Nome do canal.

  • items[].channel.typestringobrigatório

    Tipo do canal.

    whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs

  • items[].pipelineobject | nullobrigatório

    Pipeline ligada (assistentes de pipeline).

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

    ID.

  • items[].pipeline.namestring | nullobrigatório

    Nome.

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

    Canais em que o assistente atende (vínculos ativos).

  • 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[].toolsarray<AssistantTool>obrigatório

    Ferramentas ligadas.

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

    ID da ferramenta.

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

    Nome técnico.

  • items[].tools[].name_publicstring | nullobrigatório

    Nome exibido.

  • items[].tools[].descriptionstring | nullobrigatório

    Descrição usada pela IA.

  • items[].tools[].http_methodstringobrigatório

    Método HTTP.

    POSTGETPUTDELETE

  • items[].tools[].urlstringobrigatório

    URL chamada.

  • items[].tools[].is_internalbooleanobrigatório

    Ferramenta interna da plataforma.

  • items[].knowledge_items_countintegerobrigatório

    Itens de conhecimento ligados diretamente ao assistente.

  • 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.