> For the complete documentation index, see [llms.txt](https://docs.mashagpt.ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mashagpt.ru/api/images.md).

# Картинки

Генерация изображений по тексту и/или другому изображению

## Объект изображения

Представляет URL-адрес или содержимое изображения, созданного API MashaGPT.

***

**b64\_json**  string\
Изображение в кодировке Base64, если `response_format` — `b64_json`.

***

**url**  string\
URL сгенерированного изображения, если `response_format` — `url` (по-умолчанию).\
Ссылка доступна 1 час с момента генерации.

***

{% code title="Изображение" lineNumbers="true" %}

```json
{
  "url": "..."
}
```

{% endcode %}

***

## Генерация изображения

<mark style="color:green;">`POST`</mark> `https://api.mashagpt.ru/v1/images/generations`

Генерирует указанное количество изображений на основе предоставленного описания

#### Request Body

| Name                                     | Type            | Description                                                                                                   |
| ---------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------- |
| prompt<mark style="color:red;">\*</mark> | String          | Текстовое описание желаемого изображения(ий). Максимальная длина — 1000 символов.                             |
| n                                        | Integer \| null | Количество изображений, которые нужно сгенерировать. Должно быть от 1 до 10.                                  |
| response\_format                         | String \| null  | Формат, в котором возвращаются сгенерированные изображения. Должен быть `url` или `b64_json`.                 |
| size                                     | String \| null  | Размер создаваемых изображений. Должно быть одно из следующих значений: `256x256`, `512x512` или `1024x1024`. |
| user                                     | String          | Уникальный идентификатор, представляющий вашего конечного пользователя.                                       |

{% tabs %}
{% tab title="200: OK Список изображение" %}
Возвращает массив `data` со списком [изображений](#obekt-izobrazheniya).
{% endtab %}
{% endtabs %}

{% code title="Пример запроса" lineNumbers="true" %}

```bash
curl https://api.mashagpt.ru/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $MASHAGPT_API_KEY" \
  -d '{
    "prompt": "A cute baby sea otter",
    "n": 2,
    "size": "1024x1024"
  }'
```

{% endcode %}

{% code title="Пример ответа" lineNumbers="true" %}

```json
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}
```

{% endcode %}

***

## Редактирование изображения

<mark style="color:green;">`POST`</mark> `https://api.mashagpt.ru/v1/images/edits`

Создает отредактированное или расширенное изображение с учетом исходного изображения и описания.

:exclamation:Принимает тело запроса в формате `multipart/form-data`

#### Request Body

| Name                                     | Type            | Description                                                                                                                                                                                                                                           |
| ---------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| image<mark style="color:red;">\*</mark>  | File            | Изображение для редактирования. Должен быть файл PNG размером менее 4 МБ и квадратной формы. Если маска не указана, изображение должно иметь прозрачность, которая будет использоваться в качестве маски.                                             |
| prompt<mark style="color:red;">\*</mark> | String          | Текстовое описание желаемого изображения(ий). Максимальная длина — 1000 символов.                                                                                                                                                                     |
| mask                                     | File            | Дополнительное изображение, полностью прозрачные области которого (например, там, где alpha равна нулю) указывают, где `image` следует редактировать. Должен быть действительным файлом PNG размером менее 4 МБ и иметь те же размеры, что и `image`. |
| n                                        | Integer \| null | Количество изображений, которые нужно сгенерировать. Должно быть от 1 до 10.                                                                                                                                                                          |
| size                                     | String \| null  | Размер создаваемых изображений. Должно быть одно из следующих значений: `256x256`, `512x512` или `1024x1024`.                                                                                                                                         |
| response\_format                         | String \| null  | Формат, в котором возвращаются сгенерированные изображения. Должен быть `url` или `b64_json`.                                                                                                                                                         |
| user                                     | String          | Уникальный идентификатор, представляющий вашего конечного пользователя.                                                                                                                                                                               |

{% tabs %}
{% tab title="200: OK Список изображений" %}
Возвращает массив `data` со списком [изображений](#obekt-izobrazheniya).
{% endtab %}
{% endtabs %}

{% code title="Пример запроса" lineNumbers="true" %}

```bash
curl https://api.mashagpt.ru/v1/images/edits \
  -H "Authorization: Bearer $MASHAGPT_API_KEY" \
  -F image="@otter.png" \
  -F mask="@mask.png" \
  -F prompt="A cute baby sea otter wearing a beret" \
  -F n=2 \
  -F size="1024x1024"
```

{% endcode %}

{% code title="Пример ответа" lineNumbers="true" %}

```json
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}
```

{% endcode %}

***

## Генерация вариантов изображения

<mark style="color:green;">`POST`</mark> `https://api.mashagpt.ru/v1/images/variations`

Создает указанное количество вариантов предоставленного изображения

:exclamation:Принимает тело запроса в формате `multipart/form-data`

#### Request Body

| Name                                    | Type            | Description                                                                                                   |
| --------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------- |
| image<mark style="color:red;">\*</mark> | File            | Изображение варианты которого нужно сгенерировать                                                             |
| n                                       | Integer \| null | Количество изображений, которые нужно сгенерировать. Должно быть от 1 до 10.                                  |
| response\_format                        | String \| null  | Формат, в котором возвращаются сгенерированные изображения. Должен быть `url` или `b64_json`.                 |
| size                                    | String \| null  | Размер создаваемых изображений. Должно быть одно из следующих значений: `256x256`, `512x512` или `1024x1024`. |
| user                                    | String          | Уникальный идентификатор, представляющий вашего конечного пользователя.                                       |

{% tabs %}
{% tab title="200: OK Список изображений" %}
Возвращает массив `data` со списком [изображений](#obekt-izobrazheniya).
{% endtab %}
{% endtabs %}

{% code title="Пример запроса" lineNumbers="true" %}

```bash
curl https://api.mashagpt.ru/v1/images/variations \
  -H "Authorization: Bearer $MASHAGPT_API_KEY" \
  -F image="@otter.png" \
  -F n=2 \
  -F size="1024x1024"
```

{% endcode %}

{% code title="Пример ответа" lineNumbers="true" %}

```json
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}
```

{% endcode %}

{% hint style="warning" %}
Изображения по ссылке для скачивания доступны **1** час
{% endhint %}
