API de Texto para imagem

A API de Texto para imagem é um recurso que permite integrar os recursos de geração de imagens por IA da Meshy ao seu próprio aplicativo. Gere imagens de alta qualidade a partir de prompts de texto usando nossos poderosos modelos de IA.

POST/openapi/v1/text-to-image

Criar uma tarefa de Texto para imagem

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

Parâmetros

Name
ai_model
Type
string
Obrigatório
Description
ID do modelo a ser usado para geração de imagens.
Valores disponíveis:
- nano-banana: Modelo padrão (3 créditos por imagem)
- nano-banana-2: Modelo equilibrado com capacidade mais forte que o 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 imagem de alta fidelidade com suporte restrito a proporção de aspecto (9 créditos por imagem)
Name
prompt
Type
string
Obrigatório
Description
Uma descrição em texto da imagem que você deseja gerar. Seja descritivo para obter os melhores resultados.
Name
generate_multi_view
Type
boolean
padrão false
Description
Quando definido como true, gera uma imagem multivista mostrando o assunto 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 mode de pose para geração de personagem. Quando omitido, a imagem é gerada sem nenhuma predefinição de pose.
Valores disponíveis: a-pose, t-pose
Name
aspect_ratio
Type
string
padrão 1:1
Description
Especifique a proporção de aspecto 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: somente 1:1, 3:2, 2:3
Valores disponíveis:
- 1:1: Formato quadrado
- 16:9: Paisagem widescreen (não suportado por gpt-image-2)
- 9:16: Retrato widescreen (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)

Retornos

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
A solicitação não foi aceitável. Causas comuns:
- Parâmetro ausente: Um parâmetro obrigatório (por exemplo, ai_model, prompt) está ausente.
- 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 usados simultaneamente.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para executar esta tarefa.
Name
429 - Too Many Requests
Description
Você excedeu 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

Recuperar uma tarefa de Texto para imagem

Este endpoint permite recuperar uma tarefa de Texto para imagem fornecendo um id de tarefa válido. Consulte O objeto de tarefa de Texto para imagem para ver quais propriedades estão incluídas no objeto de tarefa de Texto para imagem.

Parâmetros

Name
id
Type
path
Description
Identificador exclusivo da tarefa de Texto para imagem a ser recuperada.

Retorna

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

Excluir uma tarefa de Texto para imagem

Este endpoint exclui 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 ser excluída.

Retorna

Retorna 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 recuperar 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 e usa 1 como padrão.
Name
page_size
Type
integer
Description
Limite de tamanho da página. O padrão é 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 em ordem crescente.
- -created_at: Ordenar por hora de criação em ordem decrescente.

Retornos

Retorna 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 uma tarefa de Texto para imagem

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

Parâmetros

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

Retornos

Retorna 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 necessários progress e 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=***"
  ]
}

O objeto de tarefa de Texto para imagem

O objeto de 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 k-sortable para ids de tarefa como detalhe de implementação, você não deve fazer nenhuma suposição 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, isso 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
Status 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 foi iniciada, esta propriedade será 0. Assim que a tarefa for 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 só é significativo se o status da tarefa for PENDING.
Name
image_urls
Type
array
Description
Um array de URLs baixáveis para as imagens geradas. Quando generate_multi_view está habilitado, este array contém três URLs de imagem representando diferentes ângulos de visualização. Caso contrário, ele contém uma única 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 status da tarefa é PENDING, IN_PROGRESS ou SUCCEEDED. Retorna 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
}