Introducción
Bienvenido a la documentación de la API de Tess AI. Esta guía te ayudará a integrar las potentes capacidades de gestión de agentes y archivos de Tess AI en tus aplicaciones.
Comenzando
Para usar la API de Tess AI, necesitarás una clave de API. Puedes crear una:
- Yendo directamente a #Tess AI → Tokens de Usuario
- O navegando por la interfaz:
- Visita #Tess AI
- Haz clic en el Menú de Usuario
- Selecciona "Tokens de API"
- Haz clic en "Agregar Nuevo Token"
Una vez que tengas tu clave de API, puedes usarla para autenticar tus solicitudes de API como se muestra en la sección Autenticación a continuación.
Endpoints Disponibles
Agentes
| Endpoint | Método | Descripción | Documentación |
|---|---|---|---|
/agents | GET | Listar todos los agentes | Listar Agentes |
/agents/{id} | GET | Obtener un agente específico | Obtener Agente |
/agents/{id}/execute | POST | Ejecutar un agente | Ejecutar Agente |
/agent-responses/{id} | GET | Obtener respuesta de ejecución del agente | Obtener Respuesta del Agente |
Archivos del Agente
| Endpoint | Método | Descripción | Documentación |
|---|---|---|---|
/agents/{agentId}/files | GET | Listar archivos del agente | Listar Archivos del Agente |
/agents/{agentId}/files | POST | Vincular archivos al agente | Vincular Archivos al Agente |
/agents/{agentId}/files/{fileId} | DELETE | Eliminar archivo del agente | Eliminar Archivo del Agente |
Webhooks del Agente
| Endpoint | Método | Descripción | Documentación |
|---|---|---|---|
/agents/{id}/webhooks | GET | Listar webhooks del agente | Listar Webhooks del Agente |
/agents/{id}/webhooks | POST | Crear webhook del agente | Crear Webhook del Agente |
Memorias
| Endpoint | Método | Descripción | Documentación |
|---|---|---|---|
/memories | GET | Listar todas las memorias | Listar Memorias |
/memories | POST | Crear una memoria | Crear Memoria |
/memories/{memoryId} | PATCH | Actualizar una memoria | Actualizar Memoria |
/memories/{memoryId} | DELETE | Eliminar una memoria | Eliminar Memoria |
Colecciones de Memoria
| Endpoint | Método | Descripción | Documentación |
|---|---|---|---|
/memory-collections | GET | Listar todas las colecciones | Listar Colecciones |
/memory-collections | POST | Crear una colección | Crear Colección |
/memory-collections/{collection_id} | PUT | Actualizar una colección | Actualizar Colección |
/memory-collections/{collection_id} | DELETE | Eliminar una colección | Eliminar Colección |
Archivos
| Endpoint | Método | Descripción | Documentación |
|---|---|---|---|
/files | GET | Listar todos los archivos | Listar Archivos |
/files | POST | Subir un archivo | Subir Archivo |
/files/{fileId} | GET | Obtener detalles del archivo | Obtener Archivo |
/files/{fileId} | DELETE | Eliminar un archivo | Eliminar Archivo |
/files/{fileId}/process | POST | Procesar un archivo | Procesar Archivo |
Webhooks
| Endpoint | Método | Descripción | Documentación |
|---|---|---|---|
/webhooks | GET | Listar todos los webhooks | Listar Webhooks |
/webhooks/{id} | DELETE | Eliminar un webhook | Eliminar Webhook |
Autenticación
La API de Tess AI utiliza autenticación de token Bearer. Todas las solicitudes de API deben incluir un encabezado Authorization con una clave de API válida.
Authorization: Bearer YOUR_API_KEY
Mantén tu clave de API segura y nunca la compartas en áreas públicamente accesibles como GitHub, código del lado del cliente o foros públicos.
URL Base
Todas las solicitudes de API deben hacerse a:
https://api.tess.im
Limitación de Tasa
El límite de tasa predeterminado aplicado a todos los endpoints es de 1 solicitud por segundo.
Contacta con soporte si necesitas límites de tasa aumentados para tu aplicación.
Formato de Solicitud/Respuesta
A menos que se especifique lo contrario, todas las solicitudes y respuestas están en formato JSON. Incluye el siguiente encabezado en tus solicitudes:
Content-Type: application/json
Paginación
Muchos endpoints devuelven resultados paginados. Puedes controlar la paginación usando estos parámetros de consulta:
| Parámetro | Tipo | Predeterminado | Descripción | Restricciones |
|---|---|---|---|---|
| page | integer | 1 | Número de página actual | Mínimo: 1 |
| per_page | integer | 15 | Elementos por página | Mínimo: 1, Máximo: 100 |
Ejemplo de respuesta de paginación:
{
"data": [...],
"meta": {
"current_page": 1,
"per_page": 15
}
}