API de Imagem para Imagem

A API de Imagem para Imagem é um recurso que permite integrar as capacidades de edição de imagens com IA da Meshy em seu próprio aplicativo. Transforme e edite imagens existentes usando imagens de referência e prompts de texto com nossos poderosos modelos de IA.

POST/openapi/v1/image-to-image

Criar uma Tarefa de Imagem para Imagem

Este endpoint permite que você crie uma nova tarefa de Imagem para Imagem. Consulte O Objeto de Tarefa de Imagem para Imagem para ver quais propriedades estão incluídas no objeto de tarefa de Imagem para Imagem.

Parâmetros

  • Name
    ai_model
    Type
    string
    Obrigatório
    Description

    ID do modelo a ser usado para geração de imagem.

    Valores disponíveis:

    • nano-banana: Modelo padrão (3 créditos por imagem)
    • nano-banana-2: Modelo balanceado com capacidade superior ao padrão (6 créditos por imagem)
    • nano-banana-pro: Modelo Pro com qualidade aprimorada (9 créditos por imagem)
    • gpt-image-2: OpenAI GPT Image 2, um modelo de edição de imagem de alta fidelidade (12 créditos por imagem)
  • Name
    prompt
    Type
    string
    Obrigatório
    Description

    Uma descrição em texto da transformação ou edição que você deseja aplicar às imagens de referência.

  • Name
    reference_image_urls
    Type
    array
    Obrigatório
    Description

    Um array de 1 a 5 imagens de referência a serem usadas para a tarefa de edição de imagem. Atualmente, suportamos os formatos .jpg, .jpeg e .png.

    Existem duas maneiras de fornecer cada imagem:

    • URL acessível publicamente: Um URL que é acessível a partir da internet pública.
    • Data URI: Um Data URI codificado em base64 da imagem. Exemplo de um Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    generate_multi_view
    Type
    boolean
    padrão false
    Description

    Quando definido como true, gera uma imagem multivista mostrando o sujeito de múltiplos ângulos.

    Quando generate_multi_view é true, o parâmetro aspect_ratio não pode ser definido.

  • Name
    aspect_ratio
    Type
    string
    padrão 1:1
    Description

    Especifica a proporção da imagem de saída. Os valores permitidos dependem do ai_model selecionado:

    • 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

    Valores disponíveis:

    • 1:1: Formato quadrado
    • 16:9: Paisagem widescreen
    • 9:16: Retrato widescreen
    • 4:3: Paisagem padrão (não suportado por gpt-image-2)
    • 3:4: Retrato padrão (não suportado por gpt-image-2)
    • 3:2: Paisagem (apenas suportado por gpt-image-2)
    • 2:3: Retrato (apenas suportado por gpt-image-2)
  • Name
    remove_background
    Type
    boolean
    padrão false
    Description

    Quando definido como true, a imagem de saída é retornada como um PNG RGBA transparente com o fundo removido, para que você possa compor o sujeito em qualquer fundo.

Retornos

A propriedade result da resposta contém o id da tarefa recém-criada de Imagem para Imagem.

Modos de Falha

  • Name
    400 - Bad Request
    Description

    A solicitação foi inaceitável. Causas comuns:

    • Parâmetro ausente: Um parâmetro obrigatório (por exemplo, ai_model, prompt, reference_image_urls) está ausente.
    • Formato de imagem inválido: Uma ou mais imagens de referência não são formatos suportados.
    • URL inacessível: Um ou mais reference_image_urls não puderam ser baixados.
    • Parâmetro inválido: aspect_ratio não é um dos valores permitidos para o ai_model selecionado.
    • Conflito: generate_multi_view e aspect_ratio não podem ser usados simultaneamente.
  • Name
    401 - Unauthorized
    Description

    A autenticação falhou. Por favor, verifique sua chave de API.

  • Name
    402 - Payment Required
    Description

    Créditos insuficientes para realizar esta tarefa.

  • Name
    429 - Too Many Requests
    Description

    Você excedeu seu limite de taxa.

Request

POST
/openapi/v1/image-to-image
# Transform a reference image with a text prompt
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>"
    ]
  }'


 ## Using Data URI example
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "data:image/png;base64,${YOUR_BASE64_ENCODED_IMAGE_DATA}"
    ]
  }'

Response

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

Recuperar uma Tarefa de Imagem para Imagem

Este endpoint permite que você recupere uma tarefa de Imagem para Imagem dado um id de tarefa válido. Consulte O Objeto de Tarefa de Imagem para Imagem para ver quais propriedades estão incluídas no objeto de tarefa de Imagem para Imagem.

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único para a tarefa de Imagem para Imagem a ser recuperada.

Retornos

A resposta contém o objeto de tarefa de Imagem para Imagem. Verifique a seção O Objeto de Tarefa de Imagem para Imagem para detalhes.

Request

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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/image-to-image/:id

Excluir uma Tarefa de Imagem para Imagem

Este endpoint exclui permanentemente uma tarefa de Imagem para Imagem, incluindo todas as imagens e dados associados. Esta ação é irreversível.

Parâmetros de Caminho

  • Name
    id
    Type
    path
    Description

    O ID da tarefa de Imagem para Imagem a ser excluída.

Retornos

Retorna 200 OK em caso de sucesso.

Request

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

Response

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

Listar Tarefas de Imagem para Imagem

Este endpoint permite que você recupere uma lista de tarefas de Imagem para imagem.

Parâmetros

  • Name
    page_num
    Type
    integer
    Description

    Número da página para paginação. Começa e tem como padrão 1.

  • Name
    page_size
    Type
    integer
    Description

    Limite do tamanho da página. O padrão é 10 itens. O máximo permitido é 50 itens.

  • Name
    sort_by
    Type
    string
    Description

    Campo para ordenar. Valores disponíveis:

    • +created_at: Ordenar por tempo de criação em ordem crescente.
    • -created_at: Ordenar por tempo de criação em ordem decrescente.

Retornos

Retorna uma lista paginada de Os Objetos de Tarefa de Imagem para Imagem.

Request

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-image",
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "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/image-to-image/:id/stream

Transmitir uma Tarefa de Imagem para Imagem

Este endpoint transmite atualizações em tempo real para uma tarefa de Imagem para Imagem usando Server-Sent Events (SSE).

Parâmetros

  • Name
    id
    Type
    path
    Description

    Identificador único para a tarefa de Imagem para Imagem a ser transmitida.

Retornos

Retorna uma transmissão de Os Objetos de Tarefa de Imagem para Imagem como Server-Sent Events.

Para tarefas PENDING ou IN_PROGRESS, a transmissão de resposta incluirá apenas os campos necessários progress e status.

Request

GET
/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/image-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": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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=***"
  ]
}

O Objeto de Tarefa de Imagem para Imagem

O objeto de Tarefa de Imagem para Imagem é uma unidade de trabalho que a Meshy acompanha para gerar uma imagem a partir de imagens de referência e uma entrada de prompt de texto. O objeto possui as seguintes propriedades:

Propriedades

  • Name
    id
    Type
    string
    Description

    Identificador único para a tarefa. Embora usemos um UUID k-sortable para ids de tarefa como detalhe de implementação, você não deve fazer suposições sobre o formato do id.

  • Name
    type
    Type
    string
    Description

    O tipo de tarefa de geração de imagem. Para tarefas de Imagem para Imagem, isso será sempre image-to-image.

  • Name
    ai_model
    Type
    string
    Description

    O modelo de IA usado para esta tarefa. Os valores possíveis são nano-banana, nano-banana-2, nano-banana-pro ou gpt-image-2.

  • Name
    prompt
    Type
    string
    Description

    O prompt de texto que foi usado para guiar a transformação da imagem.

  • Name
    status
    Type
    string
    Description

    Status da tarefa. Os valores possíveis são um dos PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Progresso da tarefa. Se a tarefa ainda não foi iniciada, esta propriedade será 0. Uma vez que a tarefa tenha sido concluída com sucesso, isso se tornará 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.

    Um carimbo de data/hora representa o número de milissegundos decorridos desde 1º de janeiro de 1970 UTC, seguindo o padrão RFC 3339. Por exemplo, sexta-feira, 1º de setembro de 2023, 12:00:00 PM GMT é representado como 1693569600000. Isso se aplica a todos os carimbos de data/hora na Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. Se a tarefa ainda não foi iniciada, esta propriedade será 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos. Se a tarefa ainda não foi concluída, esta propriedade será 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Carimbo de data/hora de quando o resultado da tarefa expira, em milissegundos.

  • Name
    preceding_tasks
    Type
    integer
    Description

    A contagem de tarefas precedentes.

    O valor deste campo é significativo apenas se o status da tarefa for PENDING.

  • Name
    image_urls
    Type
    array
    Description

    Um array de URLs para download das imagens geradas. Quando generate_multi_view está habilitado, este array contém três URLs de imagens representando diferentes ângulos de visualização. Caso contrário, contém uma única URL de imagem.

  • Name
    task_error
    Type
    object
    Description

    Detalhes do erro para tarefas falhadas. Veja Erros para a referência completa do objeto task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    O número de créditos consumidos por esta tarefa. Presente quando o status da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

Exemplo de Objeto de Tarefa de Imagem para Imagem

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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
}