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 кредитов за изображение)
  • 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, 16:9, 9:16, 3:2, 2:3

    Доступные значения:

    • 1:1: Квадратный формат
    • 16:9: Широкоформатный пейзаж
    • 9:16: Широкоформатный портрет
    • 4:3: Стандартный пейзаж (не поддерживается gpt-image-2)
    • 3:4: Стандартный портрет (не поддерживается gpt-image-2)
    • 3:2: Пейзаж (поддерживается только gpt-image-2)
    • 2:3: Портрет (поддерживается только gpt-image-2)
  • 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-ключ.

  • Name
    402 - Payment Required
    Description

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

  • Name
    429 - Too Many Requests
    Description

    Вы превысили ваше ограничение частоты.

Запрос

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"
  }'

Ответ

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
GET/openapi/v1/text-to-image/:id

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

Этот эндпоинт позволяет получить задачу Текст в изображение, используя действительный id задачи. Обратитесь к Объект задачи Текст в изображение, чтобы увидеть, какие свойства включены в объект задачи Текст в изображение.

Параметры

  • Name
    id
    Type
    path
    Description

    Уникальный идентификатор задачи Текст в изображение для получения.

Возвращает

Ответ содержит объект задачи Текст в изображение. Проверьте раздел Объект задачи Текст в изображение для подробностей.

Запрос

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}"

Ответ

{
  "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 в случае успеха.

Запрос

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}"

Ответ

// Returns 200 Ok on success.
GET/openapi/v1/text-to-image

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

Этот эндпоинт позволяет получить список задач Текст в изображение.

Параметры

  • Name
    page_num
    Type
    integer
    Description

    Номер страницы для пагинации. Начинается и по умолчанию равен 1.

  • Name
    page_size
    Type
    integer
    Description

    Лимит размера страницы. По умолчанию 10 элементов. Максимально допустимо 50 элементов.

  • Name
    sort_by
    Type
    string
    Description

    Поле для сортировки. Доступные значения:

    • +created_at: Сортировать по времени создания в порядке возрастания.
    • -created_at: Сортировать по времени создания в порядке убывания.

Возвращает

Возвращает список с пагинацией Объектов задачи Текст в изображение.

Запрос

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}"

Ответ

[
  {
    "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.

Запрос

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}"

Поток ответа

// 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.

  • Name
    type
    Type
    string
    Description

    Тип задачи генерации изображения. Для задач "Текст в изображение" это всегда будет text-to-image.

  • Name
    ai_model
    Type
    string
    Description

    AI-модель, используемая для этой задачи. Возможные значения: 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

    Прогресс задачи. Если задача еще не начата, это свойство будет 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 (кредиты возвращаются при неудаче).

Пример объекта задачи "Текст в изображение"

{
  "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
}