Документация Ai-Систа API

Аутентификация

Все запросы к API требуют API-ключ для аутентификации. Вы можете сгенерировать и управлять своим API-ключом на странице 'Подключение' в панели управления вашего бизнеса.

API-ключ должен быть включён в заголовок каждого запроса следующим образом:

api-key: YOUR_API_KEY

Базовый URL: https://Aisista.com/api/

GET История чата

Этот эндпоинт получает историю переписки для конкретного пользователя, определяемого уникальным `chat_id`.

Параметры

Параметр	Тип	Описание
method	String	Обязательно. Должно быть 'gethistory'.
chat_id	String | Integer	Обязательно. Уникальный идентификатор для вашего конечного пользователя (например, ID пользователя из вашей системы, ID сессии).

Пример запроса (кёрл)

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

Пример ответа

[
    {
        "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 Отправить новое сообщение

Этот эндпоинт отправляет новое сообщение от пользователя чатботу и возвращает ответ, сгенерированный ИИ.

Параметры

Параметр	Тип	Описание
method	String	Обязательно. Должно быть 'newmessage'.
chat_id	String | Integer	Обязательно. Уникальный идентификатор для вашего конечного пользователя. Это обеспечивает непрерывность диалога.
message	String	Обязательно. Текст сообщения пользователя.
system_prompt	String	Необязательно. Дополнительные временные инструкции для ИИ для этого конкретного сообщения. Например, вы можете передать пользовательские данные, такие как 'Имя пользователя — Джон Доу.'

Пример запроса (кёрл)

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."

Пример ответа

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

Обработка ошибок

Если запрос не удался, API вернёт объект JSON с ключом `error`, содержащим описание ошибки.

Пример ответа с ошибкой

{
    "error": "Invalid API key"
}