Documentación de la API de Ai-Sista

Integra tu chatbot empresarial con cualquier aplicación.

Autenticación

Todas las solicitudes a la API requieren una clave API para autenticación. Puedes generar y gestionar tu clave API desde la página 'Conectar' de tu empresa en el panel de control.

La clave API debe incluirse en el encabezado de cada solicitud de la siguiente manera:

api-key: YOUR_API_KEY

URL base: https://Aisista.com/api/

GET Obtener historial de chat

/api/?method=gethistory

Este endpoint recupera el historial de conversación de un usuario específico, identificado por un `chat_id` único.

Parámetros

Parámetro Tipo Descripción
method String Obligatorio. Debe ser 'gethistory'.
chat_id String | Integer Obligatorio. Un identificador único para tu usuario final (por ejemplo, ID de usuario de tu sistema, ID de sesión).

Ejemplo de solicitud (cURL)

curl -X GET "https://Aisista.com/api/?method=gethistory&chat_id=USER12345" \
-H "api-key: YOUR_API_KEY"

Ejemplo de respuesta

[
    {
        "user": "Hello, what are your opening hours?",
        "chatbot": "We are open from 9 AM to 5 PM on weekdays.",
        "to_follow": null,
        "time": "2024-08-15 10:30:00"
    },
    {
        "user": "Thanks!",
        "chatbot": "You're welcome! Is there anything else I can help with?",
        "to_follow": null,
        "time": "2024-08-15 10:30:15"
    }
]

POST Enviar nuevo mensaje

/api/?method=newmessage

Este endpoint envía un nuevo mensaje de un usuario al chatbot y devuelve la respuesta generada por la IA.

Parámetros

Parámetro Tipo Descripción
method String Obligatorio. Debe ser 'newmessage'.
chat_id String | Integer Obligatorio. Un identificador único para tu usuario final. Esto asegura la continuidad de la conversación.
message String Obligatorio. El texto del mensaje del usuario.
system_prompt String Opcional. Instrucciones adicionales y temporales para la IA para este mensaje específico. Por ejemplo, puedes enviar datos específicos del usuario como 'El nombre del usuario es John Doe.'

Ejemplo de solicitud (cURL)

curl -X POST "https://Aisista.com/api/" \
-H "api-key: YOUR_API_KEY" \
-d "method=newmessage" \
-d "chat_id=USER12345" \
-d "message=Do you ship to Canada?" \
-d "system_prompt=The user is currently viewing the 'Leather Watch' product page."

Ejemplo de respuesta

{
    "ok": true,
    "response": "Yes, we ship to Canada! Shipping for the Leather Watch takes about 5-7 business days."
}

Manejo de errores

Si una solicitud falla, la API devolverá un objeto JSON con una clave `error` que contiene un mensaje descriptivo.

Ejemplo de respuesta de error

{
    "error": "Invalid API key"
}