API Текст у зображення

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

POST/openapi/v1/text-to-image

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

Ця кінцева точка дає змогу створити нове завдання Текст у зображення. Зверніться до Об’єкта завдання Текст у зображення, щоб побачити, які властивості входять до об’єкта завдання Текст у зображення.

Параметри

Name
ai_model
Type
string
Обов'язковий
Description
ID моделі, яку потрібно використовувати для генерації зображення.
Доступні значення:
- nano-banana: Стандартна модель (3 кредити за зображення)
- nano-banana-2: Збалансована модель із сильнішими можливостями, ніж стандартна (6 кредитів за зображення)
- nano-banana-pro: Pro-модель із покращеною якістю (9 кредитів за зображення)
- gpt-image-2: OpenAI GPT Image 2, високоточна модель зображень з обмеженою підтримкою співвідношення сторін (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
Укажіть режим пози для генерації персонажа. Якщо не вказано, зображення генерується без будь-яких пресетів пози.
Доступні значення: a-pose, t-pose
Name
aspect_ratio
Type
string
за замовчуванням 1:1
Description
Укажіть співвідношення сторін згенерованого зображення. Дозволені значення залежать від вибраного ai_model:
- nano-banana, nano-banana-2, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
- gpt-image-2: лише 1:1, 3:2, 2:3
Доступні значення:
- 1:1: Квадратний формат
- 16:9: Широкоекранний альбомний формат (не підтримується gpt-image-2)
- 9:16: Широкоекранний портретний формат (не підтримується gpt-image-2)
- 4:3: Стандартний альбомний формат (не підтримується gpt-image-2)
- 3:4: Стандартний портретний формат (не підтримується gpt-image-2)
- 3:2: Альбомний формат (підтримується лише gpt-image-2)
- 2:3: Портретний формат (підтримується лише gpt-image-2)

Повертає

Властивість 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
Недостатньо кредитів для виконання цього завдання.
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 завдання Текст у зображення, яке потрібно видалити.

Повертає

Повертає 200 OK у разі успіху.

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

// Returns 200 Ok on success.

GET/openapi/v1/text-to-image

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

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

Параметри

Name
page_num
Type
integer
Description
Номер сторінки для пагінації. Починається з 1 і за замовчуванням дорівнює 1.
Name
page_size
Type
integer
Description
Обмеження розміру сторінки. За замовчуванням — 10 елементів. Максимально дозволено 50 елементів.
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

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

Ця кінцева точка транслює оновлення в реальному часі для завдання Текст у зображення за допомогою 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=***"
  ]
}

Об’єкт завдання Текст у зображення

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

Властивості

Name
id
Type
string
Description
Унікальний ідентифікатор завдання. Хоча ми використовуємо k-сортований UUID для id завдань як деталь реалізації, вам не слід робити жодних припущень щодо формату id.
Name
type
Type
string
Description
Тип завдання генерації зображення. Для завдань Текст у зображення це завжди буде text-to-image.
Name
ai_model
Type
string
Description
Модель ШІ, використана для цього завдання. Можливі значення: nano-banana, nano-banana-2, nano-banana-pro або gpt-image-2.
Name
prompt
Type
string
Description
Текстовий prompt, який було використано для генерації зображення.
Name
status
Type
string
Description
Статус завдання. Можливі значення: одне з PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress завдання. Якщо завдання ще не запущено, ця властивість буде 0. Щойно завдання успішно завершиться, вона стане 100.
Name
created_at
Type
timestamp
Description
Мітка часу створення завдання, у мілісекундах.
Мітка часу представляє кількість мілісекунд, що минули з 1 січня 1970 року UTC, відповідно до стандарту RFC 3339. Наприклад, п’ятниця, 1 вересня 2023 року, 12:00:00 GMT представлена як 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
}