Documentation Index
Fetch the complete documentation index at: https://docs.tess.im/llms.txt
Use this file to discover all available pages before exploring further.
Bem-vindo à documentação da API da Tess AI! Este guia ajudará você a começar a usar nossa API e a entender como integrar os poderosos recursos da Tess AI em seus aplicativos.
URL base
Todas as solicitações à API devem ser feitas para a seguinte URL base:
Autenticação
Todas as solicitações de API exigem autenticação usando uma chave de API. Você pode obter sua chave de API no Painel de Controle do Tess AI.
Para autenticar suas solicitações, inclua sua chave de API no cabeçalho Authorization:
Autorização: Portador SUA_CHAVE_DE_API
Pontos de extremidade da API
A API Tess AI fornece as seguintes categorias principais de endpoints:
Agentes
| Ponto final | 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 da execução do agente | Obter resposta do agente |
Arquivos do Agente
| Ponto final | 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} | EXCLUIR | Excluir arquivo do agente | Excluir Arquivo do Agente |
Webhooks de Agentes
| Ponto final | Método | Descrição | Documentação |
|---|
/agents/{id}/webhooks | GET | Listar webhooks de agentes | Listar Webhooks de Agentes |
/agents/{id}/webhooks | POST | Criar webhook de agente | Criar Webhook de Agente |
Workspaces
| Ponto final | Método | Descrição | Documentação |
|---|
/workspaces/usage | GET | Histórico de execuções de agentes (uso do workspace) | Uso do workspace |
Memórias
| Ponto final | 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} | EXCLUIR | Excluir uma memória | Excluir memória |
Coleções de Memórias
| Ponto final | 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} | EXCLUIR | Excluir uma coleção | Excluir Coleção |
Arquivos
| Ponto final | Método | Descrição | Documentação |
|---|
/files | GET | Listar todos os arquivos | Listar Arquivos |
/files | POST | Enviar um arquivo | Enviar Arquivo |
/files/{fileId} | GET | Obter detalhes do arquivo | Obter Arquivo |
/files/{fileId} | EXCLUIR | Excluir um arquivo | Excluir Arquivo |
/files/{fileId}/process | POST | Processar um arquivo | Processar Arquivo |
Webhooks
| Ponto final | Método | Descrição | Documentação |
|---|
/webhooks | GET | Listar todos os webhooks | Listar Webhooks |
/webhooks/{id} | EXCLUIR | Excluir um webhook | Excluir Webhook |
Tipo de conteúdo: application/json
Formato de Resposta
Todas as respostas da API são retornadas em formato JSON. Uma resposta bem-sucedida normalmente terá um código de status HTTP 2xx e conterá os dados solicitados. Respostas de erro terão um código de status 4xx ou 5xx e incluirão uma mensagem de erro.
