Visão Geral
Bem-vindo à documentação da API Tess AI! Este guia ajudará você a começar com nossa API e entender como integrar as poderosas capacidades da Tess AI em suas aplicações.
URL Base
Todas as requisições de API devem ser feitas para a seguinte URL base:
https://api.tess.im
Autenticação
Todas as requisições de API requerem autenticação usando uma chave de API. Você pode obter sua chave de API no Painel Tess AI.
Para autenticar suas requisições, inclua sua chave de API no cabeçalho Authorization:
Authorization: Bearer YOUR_API_KEY
Endpoints da API
A API Tess AI fornece as seguintes categorias principais de endpoints:
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 | Fazer 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 |
Formato de Requisição
A maioria dos endpoints da API aceita corpos de requisição codificados em JSON. Certifique-se de incluir o seguinte cabeçalho em suas requisições:
Content-Type: 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.