Text to Image API

Text to Image API — це функція, яка дозволяє інтегрувати можливості генерації зображень на основі ШІ від Meshy у вашу власну програму. Створюйте високоякісні зображення з текстових підказок за допомогою наших потужних моделей ШІ.

Ця кінцева точка створює зображення. Якщо мета — отримати об'єкт, який можна тримати в руках або надрукувати — брелок, магніт на холодильник, фігурку, лампу чи ковпачок для клавіш за фотографією — використовуйте Creative Lab APIs (зображення прототипу → побудова 3D-моделі). Якщо мета — отримати 3D-модель того, що зображено на картинці, використовуйте Image to 3D.

POST/openapi/v1/text-to-image

Створити завдання Текст у зображення

Ця кінцева точка дозволяє створити нове завдання Текст у зображення. Див. Об'єкт завдання Текст у зображення, щоб дізнатися, які властивості включені в об'єкт завдання Текст у зображення.

Завдання виконується у фоновому режимі. Про типову тривалість виконання див. Час обробки.

Параметри

Name
ai_model
Type
string
Обов'язковий
Description
ID моделі, яка використовується для генерації зображення.
Доступні значення:
- nano-banana: Стандартна модель (3 кредити за зображення)
- nano-banana-2: Збалансована модель з потужнішими можливостями, ніж стандартна (6 кредитів за зображення)
- nano-banana-2-lite: Полегшена версія nano-banana-2 (3 кредити за зображення)
- nano-banana-pro: Pro-модель з покращеною якістю (9 кредитів за зображення)
- gpt-image-2: OpenAI GPT Image 2, модель зображень з високою точністю (9 кредитів за зображення)
- gpt-image-2-5-flare: OpenAI GPT Image 2.5 (Flare), модель зображень з високою точністю (9 кредитів за зображення)
- gpt-image-2-5-sunburst: OpenAI GPT Image 2.5 (Sunburst), модель зображень з високою точністю (9 кредитів за зображення)
Name
prompt
Type
string
Обов'язковий
Description
Текстовий опис зображення, яке ви хочете згенерувати. Для найкращих результатів робіть опис детальним.
Name
generate_multi_view
Type
boolean
за замовчуванням false
Description
Якщо встановлено значення true, генерується зображення Мультивид, що показує об'єкт з кількох ракурсів.
Якщо generate_multi_view має значення true, параметр aspect_ratio не можна встановити.
Name
pose_mode
Type
string
Description
Вкажіть pose_mode для генерації персонажа. Якщо параметр не вказано, зображення генерується без будь-яких готових поз.
Доступні значення: a-pose, t-pose
З nano-banana, nano-banana-2, nano-banana-2-lite та nano-banana-pro встановлення pose_mode фіксує співвідношення сторін результату на 3:4, і будь-яке значення aspect_ratio, яке ви надішлете, ігнорується. nano-banana-2 та nano-banana-2-lite зберігають запитану модель. З nano-banana або nano-banana-pro зображення з позою генерується моделлю nano-banana-pro (поле ai_model завдання повертається як nano-banana-pro), що вимагає тарифного плану Pro або вищого. Моделі GPT Image (gpt-image-2, gpt-image-2-5-flare, gpt-image-2-5-sunburst) зберігають запитану модель та aspect_ratio.
Name
aspect_ratio
Type
string
за замовчуванням 1:1
Description
Вкажіть співвідношення сторін згенерованого зображення. Дозволені значення залежать від обраної ai_model:
- nano-banana, nano-banana-2, nano-banana-2-lite, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
- gpt-image-2, gpt-image-2-5-flare, gpt-image-2-5-sunburst: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
Доступні значення:
- 1:1: Квадратний формат
- 16:9: Широкоформатний альбомний
- 9:16: Широкоформатний портретний
- 4:3: Стандартний альбомний
- 3:4: Стандартний портретний
- 3:2: Альбомний (підтримується лише моделями GPT Image)
- 2:3: Портретний (підтримується лише моделями GPT Image)
Name
remove_background
Type
boolean
за замовчуванням false
Description
Якщо встановлено значення true, згенероване зображення повертається у вигляді прозорого PNG у форматі RGBA з видаленим фоном, щоб ви могли розмістити об'єкт на будь-якому тлі.

Повертає

Властивість result відповіді містить id завдання новоствореного завдання Текст у зображення.

Режими збою

Name
400 - Bad Request
Description
Запит був неприйнятним. Поширені причини:
- Відсутній параметр: Відсутній обов'язковий параметр (наприклад, ai_model, prompt).
- Недійсний параметр: ai_model або aspect_ratio не є одним із дозволених значень.
- Конфлікт: generate_multi_view та aspect_ratio не можна використовувати одночасно.
Name
401 - Unauthorized
Description
Помилка автентифікації. Будь ласка, перевірте свій API-ключ.
Name
402 - Payment Required
Description
Поширені причини:
- Недостатньо кредитів: На вашому рахунку недостатньо кредитів для виконання цього завдання (Insufficient funds).
- Потрібен тарифний план: nano-banana-pro, або pose_mode з nano-banana, вимагає тарифного плану Pro або вищого (Only Pro and above users can use nano-banana-pro, або Only Pro and above users can use A/T pose feature (requires nano-banana-pro)).
Name
429 - Too Many Requests
Description
Ви перевищили своє обмеження частоти.

Request

POST

/openapi/v1/text-to-image

# Generate an image from a text prompt
curl https://api.meshy.ai/openapi/v1/text-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "aspect_ratio": "16:9"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/text-to-image/:id

Retrieve a Text to Image Task

Ця кінцева точка дозволяє отримати завдання Текст у зображення за дійсним id завдання. Зверніться до розділу Об'єкт завдання Текст у зображення, щоб дізнатися, які властивості включено до об'єкта завдання Текст у зображення.

Параметри

Name
id
Type
path
Description
Унікальний ідентифікатор завдання Текст у зображення, яке потрібно отримати.

Результат

Відповідь містить об'єкт завдання Текст у зображення. Перегляньте розділ Об'єкт завдання Текст у зображення для отримання додаткової інформації.

Request

GET

/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

DELETE/openapi/v1/text-to-image/:id

Видалити завдання Текст у зображення

Ця кінцева точка остаточно видаляє завдання Текст у зображення, включно з усіма пов'язаними зображеннями та даними. Ця дія незворотна.

Параметри шляху

Name
id
Type
path
Description
ID завдання Текст у зображення, яке потрібно видалити.

Статус завдання

Завдання, яке все ще має статус PENDING, видаляється, а кредити, витрачені під час створення, повертаються.

Завдання, яке вже має статус IN_PROGRESS, не може бути видалене: запит відхиляється з кодом 409 Conflict, і завдання продовжує виконуватися. Кредити за завдання, виконання якого вже розпочав воркер, не підлягають поверненню, тому видалення його під час виконання коштувало б вам і кредитів, і результату. Зачекайте, поки воно не досягне статусу SUCCEEDED, FAILED або CANCELED, а потім видаліть його.

Завдання у фінальному стані (SUCCEEDED, FAILED або CANCELED) видаляється без повернення кредитів.

Повертає

Повертає 200 OK у разі успіху, або 409 Conflict, коли завдання має статус IN_PROGRESS.

Request

DELETE

/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/text-to-image

Список завдань Текст у зображення

Ця кінцева точка дозволяє отримати список завдань Текст у зображення.

Параметри

Name
page_num
Type
integer
Description
Номер сторінки для пагінації. Починається та за замовчуванням дорівнює 1.
Name
page_size
Type
integer
Description
Обмеження розміру сторінки. За замовчуванням 10 елементів. Максимально допустиме значення — 100 елементів.
Name
sort_by
Type
string
Description
Поле для сортування. Доступні значення:
- +created_at: Сортування за часом створення в порядку зростання.
- -created_at: Сортування за часом створення в порядку спадання.

Повертає

Повертає пагінований список Об'єктів завдання Текст у зображення.

Request

GET

/openapi/v1/text-to-image

curl https://api.meshy.ai/openapi/v1/text-to-image?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-image",
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1692771650657,
    "started_at": 1692771667037,
    "finished_at": 1692771669037,
    "expires_at": 1692771679037,
    "image_urls": [
      "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
    ]
  }
]

GET/openapi/v1/text-to-image/:id/stream

Потокова передача завдання Text to Image

Ця кінцева точка передає оновлення в реальному часі для завдання Текст у зображення за допомогою Server-Sent Events (SSE).

Параметри

Name
id
Type
path
Description
Унікальний ідентифікатор завдання Текст у зображення для потокової передачі.

Повертає

Повертає потік об'єктів завдання Текст у зображення у форматі Server-Sent Events.

Для завдань зі статусом PENDING або IN_PROGRESS потік відповіді включатиме лише необхідні поля progress та status.

Request

GET

/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

Об'єкт Task для Текст у зображення

Об'єкт Task для Текст у зображення — це одиниця роботи, яку Meshy відстежує для генерації зображення з вхідного текстового prompt. Об'єкт має такі властивості:

Властивості

Name
id
Type
string
Description
Унікальний ідентифікатор завдання. Хоча для ідентифікаторів завдань ми використовуємо k-сортований UUID як деталь реалізації, вам не слід робити жодних припущень щодо формату id.
Name
type
Type
string
Description
Тип завдання генерації зображення. Для завдань Текст у зображення це завжди буде text-to-image.
Name
ai_model
Type
string
Description
AI-модель, що використовується для цього завдання. Можливі значення: nano-banana, nano-banana-2, nano-banana-2-lite, nano-banana-pro, gpt-image-2, gpt-image-2-5-flare або gpt-image-2-5-sunburst.
Name
prompt
Type
string
Description
Текстовий prompt, який було використано для генерації зображення.
Name
status
Type
string
Description
Статус завдання. Можливі значення: одне з PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Прогрес виконання завдання. Якщо завдання ще не розпочато, ця властивість дорівнюватиме 0. Щойно завдання завершиться успішно, вона стане 100.
Name
created_at
Type
timestamp
Description
Мітка часу створення завдання, у мілісекундах.
Мітка часу представляє кількість мілісекунд, що минули з 1 січня 1970 року UTC, відповідно до стандарту RFC 3339. Наприклад, п'ятниця, 1 вересня 2023 року, 12:00:00 за Гринвічем представлена як 1693569600000. Це стосується усіх міток часу в Meshy API.
Name
started_at
Type
timestamp
Description
Мітка часу початку виконання завдання, у мілісекундах. Якщо завдання ще не розпочато, ця властивість дорівнюватиме 0.
Name
finished_at
Type
timestamp
Description
Мітка часу завершення завдання, у мілісекундах. Якщо завдання ще не завершено, ця властивість дорівнюватиме 0.
Name
expires_at
Type
timestamp
Description
Мітка часу завершення терміну дії результату завдання, у мілісекундах.
Name
preceding_tasks
Type
integer
Description
Кількість попередніх завдань у черзі.
Значення цього поля має сенс лише тоді, коли статус завдання — PENDING.
Name
image_urls
Type
array
Description
Масив URL-адрес для завантаження згенерованих зображень. Коли увімкнено generate_multi_view, цей масив містить три URL-адреси зображень, що відображають різні ракурси перегляду. В іншому випадку він містить одну URL-адресу зображення.
Name
task_error
Type
object
Description
Деталі помилки для завдань, що завершилися невдало. Дивіться Помилки для повного опису об'єкта task_error.
Name
consumed_credits
Type
integer
Description
Кількість кредитів, витрачених на це завдання. Присутнє, коли статус завдання — PENDING, IN_PROGRESS або SUCCEEDED. Повертає 0 для завдань зі статусом FAILED (кредити повертаються у разі невдачі).

Example Text to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "preceding_tasks": 0,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ],
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3
}