Pular para o conteúdo principal
POST
/
agents
/
{id}
/
execute
curl --request POST \
  --url https://api.tess.im/agents/{id}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "temperature": "1",
  "model": "tess-6",
  "messages": [
    {
      "role": "user",
      "content": "Summarize the latest ticket updates."
    }
  ],
  "tools": "no-tools",
  "waitExecution": false,
  "file_ids": [
    123,
    321
  ]
}
'

​
Exemplos de Código

curl --request POST \
  --url 'https://api.tess.im/agents/{id}/execute' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "temperature": "1",
    "model": "tess-5",
    "messages": [
        { "role": "user", "content": "Hello, how can you help me today?" }
    ],
    "tools": "no-tools",
    "waitExecution": false,
    "file_ids": [123, 321]
  }'

​
Cabeçalhos

ParâmetroTipoObrigatórioDescrição
x-workspace-idintegerNãoID do workspace. Se não fornecido, o workspace selecionado pelo usuário será usado. Será obrigatório em uma versão futura.

​
Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idintegerSimO ID do agente.

​
Corpo da Requisição

ParâmetroTipoObrigatórioDescrição
temperaturestringNãoCampo de Chat Agent. Temperatura de amostragem entre 0 e 2. Valores maiores geram resultados mais criativos (padrão: "1").
modelstringNãoCampo de Chat Agent. Identificador do modelo a ser utilizado (ex.: "tess-6").
toolsstringNãoCampo de Chat Agent. Configuração de ferramentas do agente (ex.: "agent", "no-tools").
root_idintegerNãoCampo de Chat Agent. ID de uma execução existente para continuar um thread de conversa.
messagesarrayNãoCampo de Chat Agent. As mensagens do agente. Suporta os papéis user, assistant e developer.
waitExecutionbooleanNãoSe true, aguarda a execução terminar antes de retornar (timeout: 100 s). Padrão: false.
file_idsarrayNãoArray de IDs de arquivo para anexar à execução.
Outros campos na raizanyDepende do agenteIsto não é um nome de campo fixo. Você pode enviar outros campos exigidos pelo seu agente diretamente na raiz da requisição. Consulte quais campos são obrigatórios em Obter Agente por ID.

​
Funções das Mensagens (Modelos do Tipo Chat)

Para modelos do tipo chat, o array messages suporta as seguintes funções:
FunçãoObrigatórioDescrição
userSimMensagens do usuário. Devem ser emparelhadas com mensagens assistant.
assistantSimMensagens do assistente. Devem ser emparelhadas com mensagens user.
developerNãoMensagem opcional do desenvolvedor. Permitida apenas como a primeira mensagem no array.
systemNãoNão suportado. Usar esta função causará um erro.
Regras importantes:
  • As mensagens devem alternar entre as funções user e assistant (após a mensagem opcional developer).
  • A função developer só pode aparecer como a primeira mensagem no array e será extraída antes do processamento do restante.
  • Se duas mensagens consecutivas tiverem a mesma função (por exemplo, duas mensagens user), a API retornará um erro de validação: “Chat messages must be a pair of user/assistant”.
  • A função system não é suportada e causará um erro.
Exemplo com mensagem developer: 
{
  "messages": [
    { "role": "developer", "content": "Você é um assistente prestativo." },
    { "role": "user", "content": "Olá!" },
    { "role": "assistant", "content": "Oi! Como posso ajudá-lo?" },
    { "role": "user", "content": "Como está o tempo?" }
  ]
}
Exemplo sem mensagem developer: 
{
  "messages": [
    { "role": "user", "content": "Olá!" },
    { "role": "assistant", "content": "Oi! Como posso ajudá-lo?" },
    { "role": "user", "content": "Como está o tempo?" }
  ]
}
Obter mais detalhes sobre quais opções são aceitas por este Agente solicitando este endpoint: Obter Agente

​
Resposta

{
"template_id": "8794",
"responses": [
  {
    "id": 4773337,
    "status": "starting",
    "input": "hello",
    "output": "",
    "credits": 0.000337,
    "root_id": 4773337,
    "created_at": "2025-01-05T19:35:21.000000Z",
    "updated_at": "2025-01-05T19:35:21.000000Z",
    "template_id": 8794
  }
]
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

​
x-workspace-id
integer

ID of the workspace. If not provided, the user's selected workspace will be used. This field will be required in a future release.

Parâmetros de caminho

​
id
integer
obrigatório

The agent ID.

Corpo

application/json

Send a JSON object. Known fields are supported, and you can add custom fields directly at the root (for example: department, reporting_period, include_risks).

Free-form JSON object. Send known fields and any custom agent fields directly at the root level.

Resposta

200

Execution started (or completed if waitExecution: true).