Документация API V2

В этом руководстве вы найдете основные команды для взаимодействия с Mitup AI API V2.

Следующие нейросети в настоящее время доступны через API. Вы можете использовать их имена при создании запроса.

Gemini

Другие нейросети на данный момент пока что недоступны.

Принцип работы

добавление в очередь → генерация → проверка уникальности → завершение.

При отправке запроса ваша задача будет поставлена в очередь на генерацию. Генерация выполняется в фоновом режиме после добавления в очередь. При запросе на добавление генерации в ответном сообщении вы получите task_id задачи, который должен будет использоваться для проверки статуса генерации.

Таким образом, пока ваша генерация будет обрабатываться в фоне, вам не нужно ожидать результат генерации, вы можете отправлять другие запросы на генерацию текста, а потом останется только проверить статус задачи и получить результат по нужному вам task_id.

Для получения результата генерации необходимо отправить второй запрос на /api/v2/status/YOUR_TASK_ID.

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

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

Параметр	Тип	Обязательный	Описание
ai	object	Да	Информация о AI
content	object	Да	Данные о продукте
name (внутри content)	object	Да	Название продукта
brand (внутри content)	object	Нет	Информация о бренде
category (внутри content)	object	Нет	Категория товара
specs (внутри content)	object	Нет	Характеристики товара (до 20 шт)

Примеры запросов

1. Генерация описаний для товаров

Генерация описания для товаров на основании переданных параметров. Для генерации описания могут быть выбраны любые сущности, которые вы передаете. Чем больше параметров вы передаете, тем качественней результат вы получите.

1.1 Пример запроса для генерации

POST /api/v2/products/text

curl -X POST "https://ai.mitup.ru/api/v2/products/text" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
    "ai": {
         "name": "gemini"
    },
    "content": {
        "name": "Мини диктофон Ambertek VR125",
        "brand": "Apelline",
        "specs": {
            "city": "Москва",
            "USB": "USB 2.0 тип A",
            "USB-кабель": "Есть"
        },
        "category": "Диктофоны"
    }
}'

import requests
url = "https://ai.mitup.ru/api/v2/products/text"
api_key = "YOUR_ACCESS_TOKEN"
params = {
    "ai": {
        "name": "gemini"
    },
    "content": {
        "name": "Мини диктофон Ambertek VR125",
        "brand": "Apelline",
        "specs": {
            "city": "Москва",
            "USB": "USB 2.0 тип A",
            "USB-кабель": "Есть"
        },
        "category": "Диктофоны"
    }
}

headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {api_key}"
}

response = requests.post(url, json=params, headers=headers)
print(response.json())

<?php
$url = "https://ai.mitup.ru/api/v2/products/text";
$api_key = "YOUR_ACCESS_TOKEN";

$params = array(
    "ai" => array(
        "name" => "gemini"
    ),
    "content" => array(
            "name" => "Мини диктофон Ambertek VR125",
            "brand" => "Apelline",
            "specs" => array(
            "city" => "Москва",
            "USB" => "USB 2.0 тип A",
            "USB-кабель" => "Есть"
        ),
        "category" => "Диктофоны"
    )
);

$headers = array(
    "Content-Type: application/json",
    "Authorization: Bearer " . $api_key
);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_USERAGENT, "Opera/10.00 (Windows NT 5.1; U; ru) Presto/2.2.0");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($params));

$response = curl_exec($curl);
curl_close($curl);
$response = json_decode($response, true);
print_r($response);
?>

1.2 Пример ответа API при добавлении в очередь

{'message': 'Ваш запрос отправлен', 'task_id': 'YOUR_TASK_ID'}

1.3 Проверка статуса генерации

import requests
api_key = "YOUR_ACCESS_KEY"

headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {api_key}"
}

base_url = 'https://ai.mitup.ru/api/v2/status/'
task_id = 'YOUR_TASK_ID'
url = f"{base_url}{task_id}"

response = requests.get(url, headers=headers)

if response.status_code == 200:
    response_data = response.json()
    print(response_data)
else:
    print(response.json())

1.4 Ответ API по статусу генерации

В случае успеха генерации и проверки уникальности текста вернётся JSON ответ со всеми данными о проведенной генерации.

Если же генерация текста прошла успешно, но при этом уникальность не было проверена, то ключ error будет заполнен информацией о возникшей ошибке, а значение text_uniq будет пустое.

{
  'balance': {
    'balance': '200',
    'balance_bonus': '0',
    'balance_referral': '0'
  },
  'contents': {
    'text': '## Sonyplastation: Играй с комфортом!\n\n**Sonyplastation** – это не просто футболка, это стиль жизни! Стильный дизайн, яркий красный цвет и комфортный размер M – все, что нужно для настоящего геймера.\n\n**Преимущества:**\n\n* **Стильный дизайн:** Sonyplastation – это не просто футболка, это statement! \n* **Яркий цвет:** Красный цвет – символ энергии и страсти, подчеркнет ваш индивидуальный стиль.\n* **Комфортный размер:** Размер M идеально подойдет для комфортной игры.\n* **Высокое качество:**  Изготовлена из высококачественных материалов, которые приятны на ощупь и прослужат вам долго.\n\n**Sonyplastation** – это не просто одежда, это часть вашего игрового мира!\n\n**Бренд:** Sony\n**Категория:** Game\n**Характеристики:**\n* Цвет: красный\n* Размер: M \n'
  },
  'cost': {
    'amount': 1.8,
    'input': 152,
    'output': 750
  },
  'error': None,
  'text_uniq': '100.00'
}

{
  'balance': {
    'balance': '200',
    'balance_bonus': '0',
    'balance_referral': '0'
  },
  'contents': {
    'text': '## Sonyplastation: Играй с комфортом!\n\n**Sonyplastation** – это не просто футболка, это стиль жизни! Стильный дизайн, яркий красный цвет и комфортный размер M – все, что нужно для настоящего геймера.\n\n**Преимущества:**\n\n* **Стильный дизайн:** Sonyplastation – это не просто футболка, это statement! \n* **Яркий цвет:** Красный цвет – символ энергии и страсти, подчеркнет ваш индивидуальный стиль.\n* **Комфортный размер:** Размер M идеально подойдет для комфортной игры.\n* **Высокое качество:**  Изготовлена из высококачественных материалов, которые приятны на ощупь и прослужат вам долго.\n\n**Sonyplastation** – это не просто одежда, это часть вашего игрового мира!\n\n**Бренд:** Sony\n**Категория:** Game\n**Характеристики:**\n* Цвет: красный\n* Размер: M \n'
  },
  'cost': {
    'amount': 1.8,
    'input': 152,
    'output': 750
  },
  'error': {"code": 400, "message": "Баланса для проверки уникальности недостаточно"},
  'text_uniq': None
}

2. Генерация отзывов для товаров

Генерация отзывов для товаров на основании переданных параметров. Для генерации отзывов могут использоваться прошлые оставленные отзывы.

POST /api/v2/products/review

curl -X POST "https://ai.mitup.ru/api/v2/products/review" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
    "ai": {
         "name": "gemini"
    },
    "content": {
        "name": "Мини диктофон Ambertek VR125",
        "brand": "Apelline",
        "specs": {
            "city": "Москва",
            "USB": "USB 2.0 тип A",
            "USB-кабель": "Есть"
        },
        "category": "Диктофоны",
        "reviews": [
            "1 отзыв",
            "2 отзыв",
            …
        ]
    }
}'

import requests
url = "https://ai.mitup.ru/api/v2/products/review"
api_key = "YOUR_ACCESS_TOKEN"
params = {
    "ai": {
        "name": "gemini"
    },
    "content": {
        "name": "Мини диктофон Ambertek VR125",
        "brand": "Apelline",
        "specs": {
            "city": "Москва",
            "USB": "USB 2.0 тип A",
            "USB-кабель": "Есть"
        },
        "category": "Диктофоны",
        "reviews": [
            "1 отзыв",
            "2 отзыв",
            …
        ]
    }
}

headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {api_key}"
}

response = requests.post(url, json=params, headers=headers)
print(response.json())

<?php
$url = "https://ai.mitup.ru/api/v2/products/review";
$api_key = "YOUR_ACCESS_TOKEN";

$params = array(
    "ai" => array(
        "name" => "gemini"
    ),
    "content" => array(
            "name" => "Мини диктофон Ambertek VR125",
            "brand" => "Apelline",
            "specs" => array(
            "city" => "Москва",
            "USB" => "USB 2.0 тип A",
            "USB-кабель" => "Есть"
        ),
        "category" => "Диктофоны"
        "reviews": [
            "1 отзыв",
            "2 отзыв",
            …
        ]
    )
);

$headers = array(
    "Content-Type: application/json",
    "Authorization: Bearer " . $api_key
);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_USERAGENT, "Opera/10.00 (Windows NT 5.1; U; ru) Presto/2.2.0");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($params));

$response = curl_exec($curl);
curl_close($curl);
$response = json_decode($response, true);
print_r($response);
?>

3. Проверка статуса генерации

POST /api/v2/status/YOUR_TASK_ID

import requests
api_key = "YOUR_ACCESS_KEY"

headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {api_key}"
}

base_url = 'https://ai.mitup.ru/api/v2/status/'
task_id = 'YOUR_TASK_ID'

url = f"{base_url}{task_id}"

response = requests.get(url, headers=headers)

if response.status_code == 200:
response_data = response.json()
print(response_data)
else:
print(response.json())

Коды ответов

Код	Описание
200	Успешный запрос
400	Неверный запрос. Ошибка в параметрах запроса
401	Не авторизован. Неверный или отсутствующий токен
500	Внутренняя ошибка сервера

REST API

Генерация описания товара