Обзор

Chat API облегчает поиск чат-ботов и позволяет пользователям взаимодействовать с ними, публикуя сообщения.

Базовый URL

https://app.openspokenai.com/api

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

Клиенты должны аутентифицироваться с помощью заголовка Basic Authorization для каждого запроса:

Авторизация: Basic {authString}

Где {authString} - это закодированная в base64 строка формата имя пользователя:пароль.

Пример использования: 

curl -X GET "https://app.openspokenai.com/api/chat" -H "Авторизация: Basic {authString}"

Конечные точки

GET /chat

Получение списка активных чатов, доступных для взаимодействия.

Параметры запроса:

группа (необязательно): Фильтр чатов по указанной группе.

Успешный ответ:

{

    "message": "success",

    "data": [

        {

            "name": "string",

            "chat_code": "string",

            "description": "string",

            "group": "string"

        }

    ]

}

Содержание не найдено:

{

    "message": "error",

    "data": {

        "message": "Для указанной группы чатбот не найден".

    }

}

POST /chat

Отправьте сообщение в определенный чат и получите ответ.

Заголовки:

Content-Type: application/json

Авторизация: Basic {authString}

Требуемая полезная нагрузка:

prompt: (строка) Ввод текста для ответа чата.

request_id: (string) Уникальный идентификатор для отслеживания запроса.

webhook_url (необязательно): (URL) Конечная точка, на которую должен быть отправлен ответ через webhook.

Успешный ответ:

{

    "message": "success",

    "data": {

        "request_id": "string",

        "message": "string"

    }

}

Ответы на ошибки:

Недостаточно кредитов:

{

    "message": "error",

    "data": {

        "message": "У вас закончились кредиты для генерации слов. Пожалуйста, пополните счет и попробуйте снова."

    }

}

Чатбот не найден:

{

    "message": "error",

    "data": {

        "message": "Чатбот не найден".

    }

}

Сбой веб-крючка:

{

    "message": "error",

    "data": {

        "message": "Не удалось отправить ответ на веб-крючок".

    }

}