Consulta dos agentes do ambiente e da configuração de cada um.
Listar agentes
Lista os agentes do ambiente. Para paginar, informe limit e, nas páginas seguintes, reenvie cursor, currentPage, total e totalPages recebidos na resposta anterior. A última página é a que tem currentPage igual a totalPages.
query Parameters
namestringFiltra pelo nome do agente (trecho, sem diferenciar maiúsculas) ou pelo ID exato.
limitinteger · min: 1 · max: 200Itens por página, de 1 a 200. Sem
limit, a lista vem inteira em uma única resposta — informe sempre que a base puder ser grande. Valor inválido vira 50.cursorstringValor de
cursorrecebido na página anterior. Omita na primeira requisição.currentPageinteger · min: 1Valor de
currentPagerecebido na página anterior. Envie junto comcursor; a resposta devolve o número seguinte.totalinteger · min: 0Valor de
totalrecebido na primeira página. Reenvie junto comcursorpara a resposta continuar informando o total.totalPagesinteger · min: 0Valor de
totalPagesrecebido na primeira página. Reenvie junto comcursor.dateInitstring · dateData inicial do período (
YYYY-MM-DD, horário de Brasília), pela data de criação.dateEndstring · dateData final do período (
YYYY-MM-DD, horário de Brasília). O dia informado entra inteiro.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Lista de agentes.
totalinteger | string · requiredTotal de agentes que atendem aos filtros. A partir da segunda página, ecoa o valor reenviado na query (como texto).
currentPageinteger · requiredNúmero da página devolvida. A primeira é
1.totalPagesinteger | string · requiredTotal de páginas para o
limitinformado. A partir da segunda página, ecoa o valor reenviado na query (como texto).cursorstring | null · requiredCursor da próxima página (ID do último item desta).
nullquando a lista vem vazia.botsobject[] · required
Obter prompt do agente
Retorna o prompt (instruções de comportamento) do agente, exatamente como foi cadastrado.
path Parameters
botIdstring · requiredID do agente.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Prompt do agente.
behaviorstring
Obter apresentação do agente
Retorna a mensagem de apresentação do agente — a primeira fala exibida ao abrir uma conversa. Sem apresentação configurada, o corpo vem vazio ({}).
path Parameters
botIdstring · requiredID do agente.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Mensagem de apresentação.
messagestring