L'API Immagine in 3D è una funzionalità che ti permette di integrare le capacità Immagine in 3D di Meshy nella tua applicazione. In questa sezione troverai tutte le informazioni
necessarie per iniziare a usare questa API.
Questo endpoint consente di creare una nuova attività Immagine in 3D. Consulta
L'oggetto attività Immagine in 3D per vedere quali
proprietà sono incluse nell'oggetto attività Immagine in 3D.
Parametri
È richiesto solo uno tra input_task_id o image_url. Se vengono forniti entrambi, input_task_id ha la priorità.
Name
input_task_id
Type
string
Obbligatorio
Description
L'ID di un'attività di generazione immagini completata il cui output deve essere usato come immagine di input. Questa attività deve essere una delle seguenti attività: Testo in immagine o Immagine in immagine. Inoltre, deve essere stata eseguita tramite l'API, avere uno stato SUCCEEDED e produrre esattamente un'immagine.
Name
image_url
Type
string
Obbligatorio
Description
Fornisci un'immagine che Meshy possa usare nella creazione del modello. Attualmente supportiamo i formati .jpg, .jpeg e .png.
Ci sono due modi per fornire l'immagine:
URL accessibile pubblicamente: un URL accessibile da Internet pubblico.
Data URI: un Data URI dell'immagine codificato in base64. Esempio di Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
model_type
Type
string
predefinito standard
Description
Specifica il tipo di Generazione mesh 3D.
Valori disponibili:
standard: Generazione mesh 3D regolare ad alto dettaglio.
lowpoly: genera mesh low-poly ottimizzata per poligoni più puliti.
Quando è selezionato lowpoly, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model vengono ignorati.
Name
ai_model
Type
string
predefinito latest
Description
ID del modello da usare. Valori disponibili: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
predefinito true
Description
Determina se vengono generate texture. Impostarlo su false salta la fase di texture, fornendo una mesh senza texture.
Si applica solo quando should_texture = true
Name
enable_pbr
Type
boolean
predefinito false
Description
Genera mappe PBR (metallica, rugosità, normale) oltre al colore di base. È inclusa anche una mappa di emissione quando ai_model è meshy-6 o latest.
Name
hd_texture
Type
boolean
predefinito false
Description
Genera la texture del colore di base a risoluzione 4K (4096×4096) per un dettaglio maggiore.
Supportato solo quando ai_model è meshy-6 o latest. Le mappe PBR sono sempre generate a 2K.
Name
texture_prompt
Type
string
Description
Fornisci un prompt testuale per guidare il processo di applicazione delle texture. Massimo 600 caratteri.
Name
texture_image_url
Type
string
Description
Fornisci un'immagine 2D per guidare il processo di applicazione delle texture. Attualmente supportiamo i formati .jpg, .jpeg e .png.
Ci sono due modi per fornire l'immagine:
URL accessibile pubblicamente: un URL accessibile da Internet pubblico
Data URI: un Data URI dell'immagine codificato in base64. Esempio di Data URI: data:image/jpeg;base64,<your base64-encoded image data>
L'applicazione di texture da immagine potrebbe non funzionare in modo ottimale se ci sono differenze sostanziali di geometria tra l'asset originale e l'immagine caricata. Solo uno tra texture_image_url o texture_prompt può essere usato per guidare il processo di applicazione delle texture. Se vengono forniti entrambi i parametri, allora texture_prompt verrà usato per applicare texture al modello per impostazione predefinita. L'applicazione di texture tramite testo o immagine costerà 10 crediti per attività.
Name
should_remesh
Type
boolean
predefinito false (meshy-6), true (others)
Description
Controlla se abilitare la fase di Remesh. Quando impostato su false, l'API restituisce la mesh triangolare con la massima precisione.
Si applica solo quando should_remesh = true
Name
topology
Type
string
predefinito triangle
Description
Specifica la topology del modello generato.
Valori disponibili:
quad: genera una mesh a predominanza quad.
triangle: genera una mesh triangolare decimata.
Name
target_polycount
Type
integer
predefinito 30,000
Description
Specifica il numero target di poligoni nel modello generato. Il numero effettivo di poligoni può discostarsi dal target in base alla complessità della geometria.
L'intervallo di valori valido varia in base al livello utente:
Da 100 a 300.000 (inclusi)
Name
decimation_mode
Type
integer
Description
Abilita la decimazione adattiva impostando un livello di conteggio poligoni. Quando impostato, target_polycount viene ignorato.
Valori disponibili:
1: Adattivo — conteggio poligoni ultra.
2: Adattivo — conteggio poligoni alto.
3: Adattivo — conteggio poligoni medio.
4: Adattivo — conteggio poligoni basso.
Name
save_pre_remeshed_model
Type
boolean
predefinito false
Description
Quando impostato su true, Meshy memorizza anche un file GLB aggiuntivo prima che la fase di Remesh sia completata.
Name
symmetry_mode
Type
string
⚠ deprecato
predefinito auto
Description
Deprecato. Questo parametro non influisce più sull'output.
Il campo symmetry_mode controlla il comportamento della simmetria durante il processo di generazione del modello.
I valori validi sono:
off: disabilita la simmetria.
auto: determina e applica automaticamente la simmetria in base alla geometria di input.
Usa pose_mode invece. Indica se generare il modello in una posa A/T.
Name
image_enhancement
Type
boolean
predefinito true
Description
Ottimizza l'immagine di input per risultati migliori. Imposta su false per preservare l'aspetto esatto dell'immagine di input senza alcuna elaborazione dello stile.
Supportato solo quando ai_model è meshy-6 o latest.
Name
remove_lighting
Type
boolean
predefinito true
Description
Rimuove luci e ombre dalla texture del colore di base, producendo un risultato più pulito che funziona meglio con configurazioni di illuminazione personalizzate.
Supportato solo quando ai_model è meshy-6 o latest.
Name
moderation
Type
boolean
predefinito false
Description
Quando impostato su true, il contenuto di input verrà automaticamente controllato per rilevare contenuti potenzialmente dannosi. Se viene rilevato contenuto dannoso, l'attività non procederà alla generazione.
Il contenuto dagli input image_url, texture_image_url e texture_prompt verrà controllato.
Name
target_formats
Type
string[]
Description
Specifica quali formati di file 3D includere nell'output. Verranno generati e restituiti solo i formati richiesti, il che può ridurre il tempo di completamento dell'attività. Quando omesso, vengono inclusi tutti i formati supportati.
Valori disponibili: glb, obj, fbx, stl, usdz, 3mf
Quando omesso, vengono generati tutti i formati tranne 3mf. 3mf viene incluso solo quando specificato esplicitamente.
Name
auto_size
Type
boolean
predefinito false
Description
Quando impostato su true, il servizio usa la visione AI per stimare automaticamente l'altezza reale dell'oggetto e ridimensionare il modello di conseguenza. L'origine verrà impostata per impostazione predefinita su bottom a meno che origin_at non sia impostato esplicitamente.
Name
alpha_thumbnail
Type
boolean
predefinito false
Description
Quando impostato su true, l'attività esegue inoltre il rendering di una versione con sfondo trasparente (RGBA) dell'anteprima e la restituisce come alpha_thumbnail_url nella risposta GET. Il campo esistente thumbnail_url rimane invariato.
Name
multi_view_thumbnails
Type
boolean
predefinito false
Description
Quando impostato su true, l'attività esegue inoltre il rendering di quattro miniature con viste cardinali (frontale, destra, posteriore, sinistra) e le restituisce sotto thumbnail_urls nella risposta GET. Il campo esistente thumbnail_url rimane invariato e continua a puntare alla vista frontale, quindi i client esistenti non sono interessati.
Aggiunge circa 3 secondi alla latenza dell'attività.
Si applica solo quando auto_size = true
Name
origin_at
Type
string
predefinito bottom
Description
Posizione dell'origine quando auto_size è abilitato.
Valori disponibili: bottom, center.
Restituisce
La proprietà result della risposta contiene l'id dell'attività Immagine in 3D appena creata.
Modalità di errore
Name
400 - Bad Request
Description
La richiesta non era accettabile. Cause comuni:
Parametro mancante: deve essere fornito image_url o input_task_id.
Attività di input non valida: input_task_id deve fare riferimento a un'attività Testo in immagine o Immagine in immagine con stato SUCCEEDED che produce esattamente un'immagine.
Formato immagine non valido: l'image_url fornito non è in un formato supportato (.jpg, .jpeg, .png).
URL non raggiungibile: non è stato possibile scaricare l'image_url (404 o timeout).
Data URI non valido: la stringa base64 è malformata.
Combinazione di parametri non valida: enable_pbr è supportato solo quando should_texture è true.
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/image-to-3d
# Simple request with required paramscurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'# With remesh, PBR, and A-posecurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Questo endpoint consente di recuperare un'attività Immagine in 3D dato un id attività valido.
Consulta L'oggetto attività Immagine in 3D per vedere quali
proprietà sono incluse nell'oggetto attività Immagine in 3D.
Parametri
Name
id
Type
path
Description
Identificatore univoco dell'attività Immagine in 3D da recuperare.
L'oggetto Task Immagine in 3D è un'unità di lavoro di cui Meshy tiene traccia per generare un modello 3D da un input immagine.
L'oggetto ha le seguenti proprietà:
Proprietà
Name
id
Type
string
Description
Identificatore univoco per l'attività. Sebbene utilizziamo un UUID ordinabile secondo k per gli id delle attività come
dettaglio di implementazione, non dovresti fare alcuna supposizione sul formato dell'id.
Name
type
Type
string
Description
Tipo dell'attività Immagine in 3D. Il valore è image-to-3d.
Name
model_urls
Type
object
Description
URL scaricabile del file del modello 3D con texture generato da Meshy. La proprietà per un formato verrà omessa se il formato non viene generato, invece di restituire una stringa vuota.
Name
glb
Type
string
Description
URL scaricabile del file GLB.
Name
fbx
Type
string
Description
URL scaricabile del file FBX.
Name
obj
Type
string
Description
URL scaricabile del file OBJ.
Name
usdz
Type
string
Description
URL scaricabile del file USDZ.
Name
mtl
Type
string
Description
URL scaricabile del file MTL, restituito insieme alle esportazioni OBJ quando sono presenti texture.
Name
stl
Type
string
Description
URL scaricabile del file STL.
Name
3mf
Type
string
Description
URL scaricabile del file 3MF. Presente solo quando 3mf è stato richiesto tramite target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL scaricabile dell'output GLB originale prima del remeshing.
Disponibile solo quando l'attività è stata creata con sia should_remesh: true sia save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL scaricabile dell'immagine miniatura del file del modello. Equivalente a thumbnail_urls.front quando presente, mantenuto per compatibilità con le versioni precedenti.
Name
alpha_thumbnail_url
Type
string
Description
URL scaricabile di una versione con sfondo trasparente (RGBA) di thumbnail_url. Presente solo quando l'attività è stata creata con alpha_thumbnail: true e l'anteprima trasparente è stata renderizzata correttamente; in caso contrario, questo campo viene omesso.
Name
thumbnail_urls
Type
object
Description
URL scaricabili per miniature da quattro viste cardinali del modello 3D generato. Ogni valore è un URL firmato verso un PNG 512×512 renderizzato con gli stessi materiali e la stessa illuminazione di thumbnail_url. Utile per visualizzare in anteprima il modello da più angolazioni nelle pipeline batch senza scaricare il GLB.
Presente solo quando l'attività è stata creata con multi_view_thumbnails: true e ha raggiunto SUCCEEDED. Le attività meno recenti e le attività create senza opt-in non includeranno questo campo.
Name
front
Type
string
Description
Vista frontale, rotazione di 0° attorno all'asse verticale (corrisponde a thumbnail_url).
Name
right
Type
string
Description
Vista destra, rotazione di 90°.
Name
back
Type
string
Description
Vista posteriore, rotazione di 180°.
Name
left
Type
string
Description
Vista sinistra, rotazione di 270°.
Name
texture_prompt
Type
string
Description
Il prompt di testo che è stato utilizzato per guidare il processo di texturing.
Name
texture_image_url
Type
string
Description
URL scaricabile dell'immagine texture che è stata utilizzata per guidare il processo di texturing.
Name
progress
Type
integer
Description
Progress dell'attività. Se l'attività non è ancora avviata, questa proprietà sarà 0. Una volta che l'attività è riuscita, diventerà 100.
Name
started_at
Type
timestamp
Description
Timestamp di quando l'attività è stata avviata, in millisecondi. Se l'attività non è ancora avviata, questa proprietà sarà 0.
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
created_at
Type
timestamp
Description
Timestamp di quando l'attività è stata creata, in millisecondi.
Name
expires_at
Type
timestamp
Description
Timestamp di quando il risultato dell'attività scade, in millisecondi.
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
status
Type
string
Description
Stato dell'attività. I valori possibili sono uno tra PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Un array di oggetti URL texture generati dall'attività. Normalmente contiene solo un oggetto URL texture. Ogni URL texture ha le seguenti proprietà:
Name
base_color
Type
string
Description
URL scaricabile dell'immagine della mappa del colore base.
Name
metallic
Type
string
Description
URL scaricabile dell'immagine della mappa metallica.
Se l'attività è creata con enable_pbr: false, questa proprietà verrà omessa.
Name
normal
Type
string
Description
URL scaricabile dell'immagine normal map.
Se l'attività è creata con enable_pbr: false, questa proprietà verrà omessa.
Name
roughness
Type
string
Description
URL scaricabile dell'immagine della mappa di roughness.
Se l'attività è creata con enable_pbr: false, questa proprietà verrà omessa.
Name
emission
Type
string
Description
URL scaricabile dell'immagine della mappa di emissione.
Se l'attività è creata con enable_pbr: false, oppure ai_model è meshy-5, questa proprietà verrà omessa.
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
task_error
Type
object
Description
Dettagli dell'errore per le attività non riuscite. Consulta 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 errore).