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: профессиональная модель с улучшенным качеством (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

    Укажите режим позы для генерации персонажа. Если не указано, изображение генерируется без каких-либо предустановленных поз.

    Доступные значения: 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, сгенерированное изображение возвращается в виде прозрачного 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

    Недостаточно кредитов для выполнения этой задачи.

  • 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

Stream a Text to Image Task

Этот эндпоинт передаёт обновления в реальном времени для задачи Текст в изображение с использованием 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=***"
  ]
}

Объект задачи Text to Image

Объект задачи Text to Image — это единица работы, которую Meshy отслеживает для генерации изображения на основе входных данных в виде текстового prompt. Объект имеет следующие свойства:

Свойства

  • Name
    id
    Type
    string
    Description

    Уникальный идентификатор задачи. Хотя в качестве деталей реализации мы используем k-sortable 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 PM 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
}