Assistentes de IA

Consultar assistente de IA

GEThttps://api.picchat.com.br/v1/assistants/{id}

Devolve um assistente de IA pelo ID com a configuração completa, sem dados sensíveis. Assistente excluído responde 404.

Autenticação: Bearer tokenPermissão: Assistentes › ver

Parâmetros de caminho

idstring (uuid)obrigatório
UUID do assistente.

Respostas

200OK

idstring (uuid)obrigatório
ID do assistente.
namestringobrigatório
Nome.
descriptionstring | nullobrigatório
Descrição.
typestring | nullobrigatório
Função do assistente.
chatbotsuggestionsummarynpstranscriptiontaggingtext_improvementpipelineresearchnull
type_IAstring | nullobrigatório
Nível do modelo (define o custo em créditos).
litestandardexpertadvancedultranull
modelstring | nullobrigatório
Modelo de IA.
statusstring | nullobrigatório
Status (ex.: active, inactive).
personstring | nullobrigatório
Persona.
aboutstring | nullobrigatório
Sobre a empresa.
communication_rulesstring | nullobrigatório
Regras de comunicação.
instructionsstringobrigatório
Instruções (prompt).
temperaturenumber | nullobrigatório
Temperatura.
max_tokensinteger | nullobrigatório
Limite de tokens por resposta.
top_pnumber | nullobrigatório
top_p.
thresholdinteger | nullobrigatório
Similaridade mínima (0–100) para usar a base de conhecimento.
low_similarity_actionstringobrigatório
O que fazer abaixo do threshold: respond_with_history, escalate_to_human ou ignore.
search_knowledge_baseboolean | nullobrigatório
Consulta a base de conhecimento.
stop_on_user_replyboolean | nullobrigatório
Para de responder quando um atendente responde.
requires_human_approvalboolean | nullobrigatório
Respostas exigem aprovação humana.
is_templatebooleanobrigatório
Sempre false nesta API (modelos de assistente ficam de fora da listagem).
created_atstring (date-time)obrigatório
Criação.
updated_atstring (date-time)obrigatório
Última atualização.
channelobject | nullobrigatório
Canal principal (vínculo legado assistants.channel_id).
channel.idstring (uuid)obrigatório
ID do canal.
channel.namestringobrigatório
Nome do canal.
channel.typestringobrigatório
Tipo do canal.
whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs
pipelineobject | nullobrigatório
Pipeline ligada (assistentes de pipeline).
pipeline.idstring (uuid)obrigatório
ID.
pipeline.namestring | nullobrigatório
Nome.
channelsarray<ChannelRef>obrigatório
Canais em que o assistente atende (vínculos ativos).
channels[].idstring (uuid)obrigatório
ID do canal.
channels[].namestringobrigatório
Nome do canal.
channels[].typestringobrigatório
Tipo do canal.
whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs
toolsarray<AssistantTool>obrigatório
Ferramentas ligadas.
tools[].idstring (uuid)obrigatório
ID da ferramenta.
tools[].namestringobrigatório
Nome técnico.
tools[].name_publicstring | nullobrigatório
Nome exibido.
tools[].descriptionstring | nullobrigatório
Descrição usada pela IA.
tools[].http_methodstringobrigatório
Método HTTP.
POSTGETPUTDELETE
tools[].urlstringobrigatório
URL chamada.
tools[].is_internalbooleanobrigatório
Ferramenta interna da plataforma.
knowledge_items_countintegerobrigatório
Itens de conhecimento ligados diretamente ao assistente.

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.

404Registro não existe, é de outra conta, foi excluído ou está fora do escopo de canais do usuário.

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