Saltar al contenido principal

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:

  1. Yendo directamente a #Tess AI → Tokens de Usuario
  2. 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​

EndpointMétodoDescripciónDocumentación
/agentsGETListar todos los agentesListar Agentes
/agents/{id}GETObtener un agente específicoObtener Agente
/agents/{id}/executePOSTEjecutar un agenteEjecutar Agente
/agent-responses/{id}GETObtener respuesta de ejecución del agenteObtener Respuesta del Agente

Archivos del Agente​

EndpointMétodoDescripciónDocumentación
/agents/{agentId}/filesGETListar archivos del agenteListar Archivos del Agente
/agents/{agentId}/filesPOSTVincular archivos al agenteVincular Archivos al Agente
/agents/{agentId}/files/{fileId}DELETEEliminar archivo del agenteEliminar Archivo del Agente

Webhooks del Agente​

EndpointMétodoDescripciónDocumentación
/agents/{id}/webhooksGETListar webhooks del agenteListar Webhooks del Agente
/agents/{id}/webhooksPOSTCrear webhook del agenteCrear Webhook del Agente

Memorias​

EndpointMétodoDescripciónDocumentación
/memoriesGETListar todas las memoriasListar Memorias
/memoriesPOSTCrear una memoriaCrear Memoria
/memories/{memoryId}PATCHActualizar una memoriaActualizar Memoria
/memories/{memoryId}DELETEEliminar una memoriaEliminar Memoria

Colecciones de Memoria​

EndpointMétodoDescripciónDocumentación
/memory-collectionsGETListar todas las coleccionesListar Colecciones
/memory-collectionsPOSTCrear una colecciónCrear Colección
/memory-collections/{collection_id}PUTActualizar una colecciónActualizar Colección
/memory-collections/{collection_id}DELETEEliminar una colecciónEliminar Colección

Archivos​

EndpointMétodoDescripciónDocumentación
/filesGETListar todos los archivosListar Archivos
/filesPOSTSubir un archivoSubir Archivo
/files/{fileId}GETObtener detalles del archivoObtener Archivo
/files/{fileId}DELETEEliminar un archivoEliminar Archivo
/files/{fileId}/processPOSTProcesar un archivoProcesar Archivo

Webhooks​

EndpointMétodoDescripciónDocumentación
/webhooksGETListar todos los webhooksListar Webhooks
/webhooks/{id}DELETEEliminar un webhookEliminar 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
precaución

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.

nota

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ámetroTipoPredeterminadoDescripciónRestricciones
pageinteger1Número de página actualMínimo: 1
per_pageinteger15Elementos por páginaMínimo: 1, Máximo: 100

Ejemplo de respuesta de paginación:

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