Introdução

Bem-vindo à documentação da API Tess AI. Este guia ajudará você a integrar os poderosos recursos de gerenciamento de agentes e arquivos da Tess AI em suas aplicações.

Começando

Para usar a API Tess AI, você precisará de uma chave de API. Você pode criar uma:

1. Indo diretamente para #Tess AI → Tokens de Usuário
2. Ou navegando pela interface:
   • Visite #Tess AI
   • Clique no Menu do Usuário
   • Selecione "Tokens de API"
   • Clique em "Adicionar Novo Token"

Uma vez que você tenha sua chave de API, você pode usá-la para autenticar suas solicitações de API conforme mostrado na seção Autenticação abaixo.

Endpoints Disponíveis

Agentes

Endpoint	Método	Descrição	Documentação
/agents	GET	Listar todos os agentes	Listar Agentes
/agents/{id}	GET	Obter um agente específico	Obter Agente
/agents/{id}/execute	POST	Executar um agente	Executar Agente
/agent-responses/{id}	GET	Obter resposta de execução do agente	Obter Resposta do Agente

Arquivos do Agente

Endpoint	Método	Descrição	Documentação
/agents/{agentId}/files	GET	Listar arquivos do agente	Listar Arquivos do Agente
/agents/{agentId}/files	POST	Vincular arquivos ao agente	Vincular Arquivos ao Agente
/agents/{agentId}/files/{fileId}	DELETE	Excluir arquivo do agente	Excluir Arquivo do Agente

Webhooks do Agente

Endpoint	Método	Descrição	Documentação
/agents/{id}/webhooks	GET	Listar webhooks do agente	Listar Webhooks do Agente
/agents/{id}/webhooks	POST	Criar webhook do agente	Criar Webhook do Agente

Memórias

Endpoint	Método	Descrição	Documentação
/memories	GET	Listar todas as memórias	Listar Memórias
/memories	POST	Criar uma memória	Criar Memória
/memories/{memoryId}	PATCH	Atualizar uma memória	Atualizar Memória
/memories/{memoryId}	DELETE	Excluir uma memória	Excluir Memória

Coleções de Memória

Endpoint	Método	Descrição	Documentação
/memory-collections	GET	Listar todas as coleções	Listar Coleções
/memory-collections	POST	Criar uma coleção	Criar Coleção
/memory-collections/{collection_id}	PUT	Atualizar uma coleção	Atualizar Coleção
/memory-collections/{collection_id}	DELETE	Excluir uma coleção	Excluir Coleção

Arquivos

Endpoint	Método	Descrição	Documentação
/files	GET	Listar todos os arquivos	Listar Arquivos
/files	POST	Fazer upload de um arquivo	Upload de Arquivo
/files/{fileId}	GET	Obter detalhes do arquivo	Obter Arquivo
/files/{fileId}	DELETE	Excluir um arquivo	Excluir Arquivo
/files/{fileId}/process	POST	Processar um arquivo	Processar Arquivo

Webhooks

Endpoint	Método	Descrição	Documentação
/webhooks	GET	Listar todos os webhooks	Listar Webhooks
/webhooks/{id}	DELETE	Excluir um webhook	Excluir Webhook

Autenticação

A API Tess AI usa autenticação de token Bearer. Todas as solicitações de API devem incluir um cabeçalho Authorization com uma chave de API válida.

Authorization: Bearer YOUR_API_KEY

cuidado

Mantenha sua chave de API segura e nunca a compartilhe em áreas publicamente acessíveis, como GitHub, código do lado do cliente ou fóruns públicos.

URL Base

Todas as solicitações de API devem ser feitas para:

https://api.tess.im

Limitação de Taxa

O limite de taxa padrão aplicado a todos os endpoints é de 1 solicitação por segundo.

nota

Entre em contato com o suporte se você precisar de limites de taxa aumentados para sua aplicação.

Formato de Solicitação/Resposta

A menos que especificado de outra forma, todas as solicitações e respostas estão em formato JSON. Inclua o seguinte cabeçalho em suas solicitações:

Content-Type: application/json

Paginação

Muitos endpoints retornam resultados paginados. Você pode controlar a paginação usando estes parâmetros de consulta:

Parâmetro	Tipo	Padrão	Descrição	Restrições
page	integer	1	Número da página atual	Mínimo: 1
per_page	integer	15	Itens por página	Mínimo: 1, Máximo: 100

Exemplo de resposta de paginação:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15
  }
}