Top.Mail.Ru

MagmaAI API: Общаемся с агентом без посредников

В этой статье речь пойдет про MagmaAI API: удобный инструмент для связи с Вашим нейронным ассистентом.

API (Application Programming Interface) — это интерфейс взаимодействия между различными программами или сервисами. Проще говоря, API позволяет одному приложению «общаться» с другим, запрашивать данные, отправлять команды или получать ответы, как если бы вы общались с человеком по телефону.

API широко используется в современных веб-приложениях и мобильных сервисах. Например, когда вы пользуетесь погодным приложением, оно, скорее всего, использует API стороннего сервиса для получения данных о погоде. Или когда вы делаете покупку в интернет-магазине, приложение может использовать API платёжной системы для обработки оплаты.

Зачем нужно API?

API позволяет:

  • Интегрировать сторонние сервисы в ваше приложение без необходимости разбираться в их внутреннем устройстве.
  • Автоматизировать процессы , например, обработку текста, распознавание изображений или ведение диалогов с помощью нейросетей.
  • Расширять функционал приложений, добавляя возможности, разработанные другими разработчиками.
  • Ускорить разработку , используя готовые решения вместо написания кода с нуля.

В случае с MagmaAI, наше API предоставляет возможность взаимодействовать с нейросетью, отправлять запросы, вести диалоги и отслеживать использование ресурсов, таких как токены.

Базовый адрес MagmaAI API

MagmaAI API доступен по адресу:

https://agent.magmaai.ru/ 

Авторизация

Для авторизации в API используется Bearer-токен. Токен необходимо передавать в заголовке Authorization следующим образом:

Authorization: Bearer <ваш_токен>

Endpoint: /message

Метод: POST

Отправляет текстовый запрос нейросети и возвращает ответ.

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

ПараметрТипОписание
dialogbooleanИспользовать ли формат диалога.
agentIdstringИдентификатор агента.
querystringТекст запроса.
dialogIdstring(Опционально) ID диалога, если вы продолжаете существующую беседу.

💡 Важно: в режиме диалога после первого запроса сервер возвращает dialogId. Это уникальный идентификатор диалога, в котором сохраняется вся история сообщений. При последующих запросах вы обязательно должны передавать этот dialogId, чтобы нейросеть могла учитывать контекст беседы.

Пример ответа с dialogId:

{
  "ok": true,
  "payload": {
    "data": {
      "isDialog": true,
      "dialogId": "5ontCtGDrmyr8atSid8mXF8i1vWCAgrk",
      "response": "Привет! Чем могу помочь?"
    }
  }
}

Пример запроса к MagmaAI API

curl -X POST https://agent.magmaai.ru/message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dialog": true,
    "agentId": "5ontCtGDkmyr8atSib7mXF7i7VwCWgrk",
    "query": "Привет!"
  }'
import requests

url = "https://agent.magmaai.ru/message"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "dialog": True,
    "agentId": "5ontCtGDkmyr8atSib7mXF7i7VwCWgrk",
    "query": "Привет!"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const url = 'https://agent.magmaai.ru/message';
const headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
};
const data = {
    dialog: true,
    agentId: '5ontCtGDkmyr8atSib7mXF7i7VwCWgrk',
    query: 'Привет!'
};

fetch(url, {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(json => console.log(json));

Заключение

Наш API предоставляет мощный инструмент для интеграции нейросетевых технологий в ваши проекты. С его помощью вы можете создавать умные чат-боты, автоматизировать обработку текста, вести диалоги и многое другое.

Если у вас есть вопросы по использованию API или вы хотите получить дополнительные интеграционные примеры — свяжитесь с нашей технической поддержкой или посетите наш сайт.