Skip to main content
GET
/
agent
/
list
All agents
curl --request GET \
  --url https://api.wppfy.com/agent/list \
  --header 'token: <api-key>'
[
  {
    "name": "<string>",
    "provider": "openai",
    "model": "<string>",
    "apikey": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "basePrompt": "<string>",
    "maxTokens": 123,
    "temperature": 50,
    "diversityLevel": 50,
    "frequencyPenalty": 50,
    "presencePenalty": 50,
    "signMessages": true,
    "readMessages": true,
    "maxMessageLength": 123,
    "typingDelay_seconds": 123,
    "contextTimeWindow_hours": 123,
    "contextMaxMessages": 123,
    "contextMinMessages": 123,
    "owner": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
token
string
header
required

Response

List of all AI agents

​
name
string
required

Nome de exibição do agente

​
provider
enum<string>
required

Provedor do serviço de IA

Available options:
openai,
anthropic,
gemini,
custom
​
model
string
required

Nome do modelo LLM a ser utilizado

​
apikey
string
required

Chave de API para autenticação no provedor

​
id
string<uuid>

ID único gerado pelo sistema

​
basePrompt
string

Prompt base para orientar o comportamento do agente

​
maxTokens
integer

Número máximo de tokens por resposta

​
temperature
integer

Controle de criatividade (0-100)

Required range: 0 <= x <= 100
​
diversityLevel
integer

Nível de diversificação das respostas

Required range: 0 <= x <= 100
​
frequencyPenalty
integer

Penalidade para repetição de frases

Required range: 0 <= x <= 100
​
presencePenalty
integer

Penalidade para manter foco no tópico

Required range: 0 <= x <= 100
​
signMessages
boolean

Adiciona identificação do agente nas mensagens

​
readMessages
boolean

Marca mensagens como lidas automaticamente

​
maxMessageLength
integer

Tamanho máximo permitido para mensagens (caracteres)

​
typingDelay_seconds
integer

Atraso simulado de digitação em segundos

​
contextTimeWindow_hours
integer

Janela temporal para contexto da conversa

​
contextMaxMessages
integer

Número máximo de mensagens no contexto

​
contextMinMessages
integer

Número mínimo de mensagens para iniciar contexto

​
owner
string

Responsável/Proprietário do agente

​
created
string<date-time>

Data de criação do registro

​
updated
string<date-time>

Data da última atualização