Introducción
@inceptiva/sdk es el cliente TypeScript oficial para conectar un backend con un agente publicado en Inceptiva. El SDK prepara la petición HTTP, autentica la integración y transforma la respuesta de la API a tipos propios de JavaScript.
Cómo funciona
Cada integración utiliza dos credenciales generadas al publicar el canal API de un agente:
AGENT_ID: identificador público del canal API. No es el identificador numérico interno del agente.INCEPTIVA_API_KEY: clave privada con prefijoinc_live_.
El cliente envía el mensaje al endpoint público del agente y devuelve su respuesta junto con un conversationId. Si reutilizas ese identificador en la siguiente llamada, el agente conserva el contexto de la conversación.
Capacidades disponibles
- Invocar agentes publicados desde Node.js o cualquier backend compatible con
fetch. - Iniciar y continuar conversaciones.
- Adjuntar metadata técnica a una llamada.
- Cancelar peticiones mediante
AbortSignal. - Capturar errores HTTP mediante
InceptivaApiError. - Integrarse directamente por HTTP cuando no quieras utilizar el paquete.
- Generar respuestas progresivas mediante streaming SSE.
- Correlacionar usuarios o tickets mediante referencias externas.
- Evitar duplicados mediante claves idempotentes.
- Consultar historial paginado y límites de uso.
Alcance público
El endpoint público permite consultar la información del agente, crear respuestas normales o progresivas mediante streaming SSE y consultar o eliminar conversaciones. No ofrece métodos para administrar agentes, Knowledge o Tools.
Continúa con Instalación para preparar el proyecto.
· SDKv0.4.0