API de Texto para imagem

A API de Texto para imagem é uma funcionalidade que permite integrar as capacidades de geração de imagens por IA da Meshy na sua própria aplicação. Gere imagens de alta qualidade a partir de prompts de texto utilizando os nossos modelos de IA poderosos.

POST/openapi/v1/text-to-image

Criar uma tarefa de Texto para imagem

Este endpoint permite-lhe criar uma nova tarefa de Texto para imagem. Consulte O objeto de tarefa de Texto para imagem para ver que propriedades estão incluídas no objeto de tarefa de Texto 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 capacidade superior à do 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 imagem de alta fidelidade com suporte restrito para proporções (9 créditos por imagem)
Name
prompt
Type
string
Obrigatório
Description
Uma descrição textual da imagem que pretende gerar. Seja descritivo para obter os melhores resultados.
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.
Quando generate_multi_view é true, o parâmetro aspect_ratio não pode ser definido.
Name
pose_mode
Type
string
Description
Especifique o pose mode para a geração de personagens. Quando omitido, a imagem é gerada sem quaisquer predefinições de pose.
Valores disponíveis: a-pose, t-pose
Name
aspect_ratio
Type
string
predefinição 1:1
Description
Especifique a proporção da imagem gerada. 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: apenas 1:1, 3:2, 2:3
Valores disponíveis:
- 1:1: Formato quadrado
- 16:9: Paisagem panorâmica (não suportado por gpt-image-2)
- 9:16: Retrato panorâmico (não suportado por gpt-image-2)
- 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 (suportado apenas por gpt-image-2)
- 2:3: Retrato (suportado apenas por gpt-image-2)

Retorna

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

Modos de falha

Name
400 - Bad Request
Description
O pedido não era aceitável. Causas comuns:
- Parâmetro em falta: Está em falta um parâmetro obrigatório (por exemplo, ai_model, prompt).
- Parâmetro inválido: ai_model ou aspect_ratio não é um dos valores permitidos.
- Conflito: generate_multi_view e aspect_ratio não podem ser utilizados em simultâneo.
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/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

Obter uma tarefa de Texto para imagem

Este endpoint permite-lhe obter uma tarefa de Texto para imagem dado um id de tarefa válido. Consulte O objeto da tarefa de Texto para imagem para ver que propriedades estão incluídas no objeto de tarefa de Texto para imagem.

Parâmetros

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

Devolve

A resposta contém o objeto de tarefa de Texto para imagem. Consulte a secção O objeto da tarefa de Texto para imagem para obter detalhes.

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

Eliminar uma tarefa de Texto para imagem

Este endpoint elimina permanentemente uma tarefa de Texto 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 Texto para imagem a eliminar.

Devolve

Devolve 200 OK em caso de sucesso.

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

// Returns 200 Ok on success.

GET/openapi/v1/text-to-image

Listar tarefas de Texto para imagem

Este endpoint permite-lhe obter uma lista de tarefas de Texto para imagem.

Parâmetros

Name
page_num
Type
integer
Description
Número da página para paginação. Começa em 1 e assume esse valor por predefinição.
Name
page_size
Type
integer
Description
Limite do tamanho da página. Por predefinição, é de 10 itens. O máximo permitido é de 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 ascendente.
- -created_at: Ordenar por hora de criação por ordem descendente.

Devolve

Devolve uma lista paginada de Os objetos de tarefa de Texto para imagem.

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

Transmitir em stream uma tarefa de Texto para imagem

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

Parâmetros

Name
id
Type
path
Description
Identificador único da tarefa de Texto para imagem a transmitir em stream.

Devolve

Devolve um stream de Objetos de tarefa de Texto para imagem como Server-Sent Events.

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

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=***"
  ]
}

O objeto Tarefa de Texto para imagem

O objeto Tarefa de Texto para imagem é uma unidade de trabalho que a Meshy acompanha para gerar uma imagem a partir de uma entrada de prompt de texto. O objeto tem as seguintes propriedades:

Properties

Name
id
Type
string
Description
Identificador único da tarefa. Embora usemos um UUID ordenável por k para os ids das tarefas como detalhe de implementação, não deve fazer quaisquer pressupostos sobre o formato do id.
Name
type
Type
string
Description
O tipo de tarefa de geração de imagem. Para tarefas de Texto para imagem, este será sempre text-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 gerar a 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 sucesso, 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 GMT é representada 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 terminada, em milissegundos. Se a tarefa ainda não tiver terminado, 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
O número 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 transferíveis para as imagens geradas. Quando generate_multi_view está ativado, este array contém três URLs de imagens que representam diferentes ângulos de visualização. Caso contrário, contém uma única URL de imagem.
Name
task_error
Type
object
Description
Detalhes de erro para tarefas falhadas. 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 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
}