API Testo in immagine

L'API Testo in immagine è una funzionalità che ti consente di integrare le capacità di generazione di immagini AI di Meshy nella tua applicazione. Genera immagini di alta qualità da prompt testuali utilizzando i nostri potenti modelli AI.

POST/openapi/v1/text-to-image

Crea un'attività Testo in immagine

Questo endpoint consente di creare una nuova attività Testo in immagine. Consulta L'oggetto dell'attività Testo in immagine per vedere quali proprietà sono incluse nell'oggetto attività Testo in immagine.

Parametri

Name
ai_model
Type
string
Obbligatorio
Description
ID del modello da utilizzare per la generazione dell'immagine.
Valori disponibili:
- nano-banana: Modello standard (3 crediti per immagine)
- nano-banana-2: Modello bilanciato con capacità superiori rispetto allo standard (6 crediti per immagine)
- nano-banana-pro: Modello Pro con qualità migliorata (9 crediti per immagine)
- gpt-image-2: OpenAI GPT Image 2, un modello di immagini ad alta fedeltà con supporto limitato per il rapporto d'aspetto (9 crediti per immagine)
Name
prompt
Type
string
Obbligatorio
Description
Una descrizione testuale dell'immagine che desideri generare. Sii descrittivo per ottenere i migliori risultati.
Name
generate_multi_view
Type
boolean
predefinito false
Description
Quando impostato su true, genera un'immagine multi-vista che mostra il soggetto da più angolazioni.
Quando generate_multi_view è true, il parametro aspect_ratio non può essere impostato.
Name
pose_mode
Type
string
Description
Specifica il pose mode per la generazione di personaggi. Se omesso, l'immagine viene generata senza alcun preset di posa.
Valori disponibili: a-pose, t-pose
Name
aspect_ratio
Type
string
predefinito 1:1
Description
Specifica il rapporto d'aspetto dell'immagine generata. I valori consentiti dipendono dal ai_model selezionato:
- nano-banana, nano-banana-2, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
- gpt-image-2: solo 1:1, 3:2, 2:3
Valori disponibili:
- 1:1: Formato quadrato
- 16:9: Orizzontale widescreen (non supportato da gpt-image-2)
- 9:16: Verticale widescreen (non supportato da gpt-image-2)
- 4:3: Orizzontale standard (non supportato da gpt-image-2)
- 3:4: Verticale standard (non supportato da gpt-image-2)
- 3:2: Orizzontale (supportato solo da gpt-image-2)
- 2:3: Verticale (supportato solo da gpt-image-2)

Restituisce

La proprietà result della risposta contiene il id dell'attività Testo in immagine appena creata.

Modalità di errore

Name
400 - Bad Request
Description
La richiesta non era accettabile. Cause comuni:
- Parametro mancante: manca un parametro obbligatorio (ad es., ai_model, prompt).
- Parametro non valido: ai_model o aspect_ratio non è uno dei valori consentiti.
- Conflitto: generate_multi_view e aspect_ratio non possono essere utilizzati contemporaneamente.
Name
401 - Unauthorized
Description
Autenticazione non riuscita. Controlla la tua chiave API.
Name
402 - Payment Required
Description
Crediti insufficienti per eseguire questa attività.
Name
429 - Too Many Requests
Description
Hai superato il tuo limite di frequenza.

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

Recupera un'attività Testo in immagine

Questo endpoint consente di recuperare un'attività Testo in immagine dato un id di attività valido. Consulta L'oggetto attività Testo in immagine per vedere quali proprietà sono incluse nell'oggetto attività Testo in immagine.

Parametri

Name
id
Type
path
Description
Identificatore univoco dell'attività Testo in immagine da recuperare.

Restituisce

La risposta contiene l'oggetto attività Testo in immagine. Consulta la sezione L'oggetto attività Testo in immagine per i dettagli.

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

Elimina un'attività Testo in immagine

Questo endpoint elimina definitivamente un'attività Testo in immagine, incluse tutte le immagini e i dati associati. Questa azione è irreversibile.

Parametri del percorso

Name
id
Type
path
Description
L'ID dell'attività Testo in immagine da eliminare.

Restituisce

Restituisce 200 OK in caso di successo.

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

Elenca attività Testo in immagine

Questo endpoint consente di recuperare un elenco di attività Testo in immagine.

Parametri

Name
page_num
Type
integer
Description
Numero di pagina per la paginazione. Inizia da 1 e il valore predefinito è 1.
Name
page_size
Type
integer
Description
Limite della dimensione della pagina. Il valore predefinito è 10 elementi. Il massimo consentito è 50 elementi.
Name
sort_by
Type
string
Description
Campo in base al quale ordinare. Valori disponibili:
- +created_at: Ordina per ora di creazione in ordine crescente.
- -created_at: Ordina per ora di creazione in ordine decrescente.

Restituisce

Restituisce un elenco paginato di Oggetti attività Testo in immagine.

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

Esegui lo streaming di un'attività Testo in immagine

Questo endpoint trasmette aggiornamenti in tempo reale per un'attività Testo in immagine usando Server-Sent Events (SSE).

Parametri

Name
id
Type
path
Description
Identificatore univoco dell'attività Testo in immagine di cui eseguire lo streaming.

Restituisce

Restituisce uno stream di Oggetti dell'attività Testo in immagine come Server-Sent Events.

Per le attività PENDING o IN_PROGRESS, lo stream di risposta includerà solo i campi necessari 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=***"
  ]
}

L'oggetto attività Testo in immagine

L'oggetto attività Testo in immagine è un'unità di lavoro di cui Meshy tiene traccia per generare un'immagine da un input di prompt di testo. L'oggetto ha le seguenti proprietà:

Proprietà

Name
id
Type
string
Description
Identificatore univoco per l'attività. Sebbene utilizziamo un UUID k-sortable per gli id delle attività come dettaglio di implementazione, non dovresti fare alcuna supposizione sul formato dell'id.
Name
type
Type
string
Description
Il tipo di attività di generazione immagini. Per le attività Testo in immagine, questo sarà sempre text-to-image.
Name
ai_model
Type
string
Description
Il modello AI utilizzato per questa attività. I valori possibili sono nano-banana, nano-banana-2, nano-banana-pro o gpt-image-2.
Name
prompt
Type
string
Description
Il prompt testuale che è stato utilizzato per generare l'immagine.
Name
status
Type
string
Description
Stato dell'attività. I valori possibili sono uno tra PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress dell'attività. Se l'attività non è ancora iniziata, questa proprietà sarà 0. Una volta che l'attività è riuscita, diventerà 100.
Name
created_at
Type
timestamp
Description
timestamp di quando l'attività è stata creata, in millisecondi.
Un timestamp rappresenta il numero di millisecondi trascorsi dal 1° gennaio 1970 UTC, seguendo lo standard RFC 3339. Ad esempio, venerdì 1 settembre 2023 12:00:00 PM GMT è rappresentato come 1693569600000. Questo si applica a tutti i timestamp in Meshy API.
Name
started_at
Type
timestamp
Description
timestamp di quando l'attività è stata avviata, in millisecondi. Se l'attività non è ancora iniziata, questa proprietà sarà 0.
Name
finished_at
Type
timestamp
Description
timestamp di quando l'attività è stata completata, in millisecondi. Se l'attività non è ancora completata, questa proprietà sarà 0.
Name
expires_at
Type
timestamp
Description
timestamp di quando il risultato dell'attività scade, in millisecondi.
Name
preceding_tasks
Type
integer
Description
Il conteggio delle attività precedenti.
Il valore di questo campo è significativo solo se lo stato dell'attività è PENDING.
Name
image_urls
Type
array
Description
Un array di URL scaricabili per le immagini generate. Quando generate_multi_view è abilitato, questo array contiene tre URL di immagini che rappresentano diversi angoli di visualizzazione. Altrimenti, contiene un singolo URL di immagine.
Name
task_error
Type
object
Description
Dettagli dell'errore per le attività non riuscite. Vedi Errori per il riferimento completo dell'oggetto task_error.
Name
consumed_credits
Type
integer
Description
Il numero di crediti consumati da questa attività. Presente quando lo stato dell'attività è PENDING, IN_PROGRESS o SUCCEEDED. Restituisce 0 per le attività FAILED (i crediti vengono rimborsati in caso di fallimento).

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
}