API de Imagem para imagem

A API de Imagem para imagem é uma funcionalidade que lhe permite integrar as capacidades de edição de imagens por IA da Meshy na sua própria aplicação. Transforme e edite imagens existentes utilizando imagens de referência e instruções de texto com os nossos poderosos modelos de IA.

POST/openapi/v1/image-to-image

Criar uma tarefa de Imagem para imagem

Este endpoint permite-lhe criar uma nova tarefa de Imagem para imagem. Consulte O objeto da tarefa de Imagem para imagem para ver que propriedades estão incluídas no objeto da tarefa de Imagem para imagem.

Parâmetros

Name
ai_model
Type
string
Obrigatório
Description
ID do modelo a utilizar para a geração de imagens.
Valores disponíveis:
- nano-banana: Modelo padrão (3 créditos por imagem)
- nano-banana-2: Modelo equilibrado com maior capacidade do que o padrão (6 créditos por imagem)
- nano-banana-pro: Modelo Pro com qualidade melhorada (9 créditos por imagem)
- gpt-image-2: OpenAI GPT Image 2, um modelo de edição de imagens 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 pretende aplicar às imagens de referência.
Name
reference_image_urls
Type
array
Obrigatório
Description
Uma matriz de 1 a 5 imagens de referência a utilizar para a tarefa de edição de imagem. Atualmente, suportamos os formatos .jpg, .jpeg e .png.
Existem duas formas de fornecer cada imagem:
- URL acessível publicamente: Um URL acessível a partir da Internet pública.
- Data URI: Um Data URI da imagem codificado em base64. Exemplo de um Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
generate_multi_view
Type
boolean
predefinição false
Description
Quando definido como true, gera uma imagem multivista que mostra o objeto a partir de vários ângulos.

Devoluções

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

Modos de falha

Name
400 - Bad Request
Description
O pedido não foi aceitável. Causas comuns:
- Parâmetro em falta: Falta um parâmetro obrigatório (por exemplo, ai_model, prompt, reference_image_urls).
- Formato de imagem inválido: Uma ou mais imagens de referência não estão em formatos suportados.
- URL inacessível: Não foi possível descarregar um ou mais reference_image_urls.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique a sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para executar esta tarefa.
Name
429 - Too Many Requests
Description
Excedeu o 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

Obter uma tarefa de Imagem para imagem

Este endpoint permite-lhe obter 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 as propriedades incluídas no objeto de tarefa de Imagem para imagem.

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de Imagem para imagem a obter.

Devolve

A resposta contém o objeto de tarefa de Imagem para imagem. Consulte a secção O objeto de tarefa de Imagem para imagem para obter 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

Eliminar uma tarefa de Imagem para imagem

Este endpoint elimina 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 eliminar.

Devolve

Devolve 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-lhe obter 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 valor predefinido 1.
Name
page_size
Type
integer
Description
Limite do tamanho da página. O valor predefinido é 10 itens. O máximo permitido é 50 itens.
Name
sort_by
Type
string
Description
Campo pelo qual ordenar. Valores disponíveis:
- +created_at: Ordenar por hora de criação por ordem crescente.
- -created_at: Ordenar por hora de criação por ordem decrescente.

Devoluções

Devolve uma lista paginada de 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 em stream 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 da tarefa de Imagem para imagem a transmitir em stream.

Retorna

Retorna um stream de Objetos da tarefa de Imagem para imagem como Server-Sent Events.

Para tarefas PENDING ou IN_PROGRESS, o stream 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 de uma entrada de prompt de texto. O objeto tem as seguintes propriedades:

Propriedades

Name
id
Type
string
Description
Identificador único da tarefa. Embora utilizemos um UUID ordenável por k para os ids das tarefas como detalhe de implementação, não deve fazer quaisquer 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, será sempre image-to-image.
Name
ai_model
Type
string
Description
O modelo de IA utilizado 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 utilizado para orientar a transformação da imagem.
Name
status
Type
string
Description
Estado da tarefa. Os valores possíveis são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress da tarefa. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0. Assim que a tarefa tiver sido concluída com êxito, isto passará a 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 a norma RFC 3339. Por exemplo, sexta-feira, 1 de setembro de 2023, 12:00:00 PM GMT é representado como 1693569600000. Isto aplica-se 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 tiver sido 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 tiver sido 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 só é significativo se o estado da tarefa for PENDING.
Name
image_urls
Type
array
Description
Um array de URLs descarregáveis para as imagens geradas. Quando generate_multi_view está ativado, este array contém três URLs de imagem que representam diferentes ângulos de visualização. Caso contrário, contém um único URL de imagem.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas com falha. Consulte 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 estado da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Devolve 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).

Example Image to Image Task Object

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