Text to Image API

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

POST/openapi/v1/text-to-image

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

Ця кінцева точка дозволяє створити нове завдання Текст у зображення. Зверніться до The Text to Image Task Object, щоб побачити, які властивості включені в об'єкт завдання Текст у зображення.

Параметри

  • 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 кредитів за зображення)
    • 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

  • 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, 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, згенероване зображення повертається у вигляді прозорого RGBA PNG з видаленим фоном, що дозволяє скомпонувати об'єкт з будь-яким фоном.

Результати

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

Режими збою

  • Name
    400 - Bad Request
    Description

    Запит було відхилено. Поширені причини:

    • Відсутній параметр: Обов'язковий параметр (наприклад, ai_model, prompt) відсутній.
    • Недійсний параметр: ai_model або aspect_ratio не є одним з дозволених значень.
    • Конфлікт: generate_multi_view та aspect_ratio не можна використовувати одночасно.
  • Name
    401 - Unauthorized
    Description

    Автентифікація не вдалася. Будь ласка, перевірте свій API key.

  • 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

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

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

The Text to Image Task Object

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

Властивості

  • Name
    id
    Type
    string
    Description

    Унікальний ідентифікатор завдання. Хоча як деталь реалізації ми використовуємо k-сортований UUID для ідентифікаторів завдань, вам не слід робити жодних припущень щодо формату id.

  • Name
    type
    Type
    string
    Description

    Тип завдання генерації зображення. Для завдань Text to Image це завжди буде text-to-image.

  • Name
    ai_model
    Type
    string
    Description

    Модель ШІ, яка використовується для цього завдання. Можливі значення: nano-banana, nano-banana-2, 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 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. Для завдань зі статусом FAILED повертає 0 (кредити повертаються у разі невдачі).

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
}