L'API Immagine in 3D è una funzionalità che ti consente di integrare le capacità di Immagine in 3D di Meshy nella tua applicazione. In questa sezione, troverai tutte le informazioni necessarie per iniziare a utilizzare questa API.
Questo endpoint consente di creare una nuova attività Immagine in 3D. Fai riferimento a
The Image to 3D Task Object 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 immagine completata il cui output deve essere usato come immagine di input. Questa attività deve essere una delle seguenti: 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 utilizzerà per la creazione del modello. Attualmente supportiamo i formati .jpg, .jpeg e .png.
Ci sono due modi per fornire l'immagine:
URL pubblicamente accessibile: un URL accessibile dalla rete internet pubblica.
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 della mesh 3D.
Valori disponibili:
standard: generazione di mesh 3D standard ad alto dettaglio.
smart-topology: scegli un modello Smart Topology con ai_model (meshy-t2).
lowpoly (deprecato): genera una mesh low-poly ottimizzata per poligoni più puliti. Consigliamo di usare smart-topology al suo posto.
Quando è selezionato smart-topology, topology, should_remesh e save_pre_remeshed_model vengono ignorati.
Quando è selezionato lowpoly, ai_model, topology, target_polycount, should_remesh e save_pre_remeshed_model vengono ignorati.
Name
ai_model
Type
string
predefinito latest
Description
ID del modello da utilizzare. I valori disponibili dipendono da model_type.
meshy-t2 (predefinito): il modello Smart Topology — topology più pulita, parti nativamente separate, output in triangoli e un numero di facce configurabile con target_polycount.
Name
ultra_mode
Type
boolean
predefinito false
Description
Abilita la generazione Ultra per una geometria di qualità superiore con dettagli di superficie più fini.
Supportato solo quando ai_model è meshy-7 (o latest).
Name
should_texture
Type
boolean
predefinito true
Description
Determina se le texture vengono generate. Impostandolo su false la fase di texturing viene saltata, fornendo una mesh senza texture.
Si applica solo quando should_texture = true
Name
enable_pbr
Type
boolean
predefinito false
Description
Genera mappe PBR (metallic, roughness, normal) oltre al colore di base. È inclusa anche una emission map quando ai_model è meshy-6, tranne che con texture_resolution: 8k. meshy-7 e latest non producono una emission map.
Name
texture_resolution
Type
string
predefinito 2k
Description
Risoluzione della texture del colore di base. Uno tra 2k (2048×2048), 4k (4096×4096) o 8k (8192×8192). Risoluzioni più elevate catturano più dettagli di superficie.
4k e 8k non sono disponibili con ai_model: meshy-5. Con 8k non viene prodotta alcuna emission map.
Name
hd_texture
Type
boolean
⚠ deprecato
predefinito false
Description
Usa texture_resolution al suo posto — equivalente a texture_resolution: "4k". Quando entrambi sono impostati, texture_resolution ha la precedenza.
Name
texture_prompt
Type
string
Description
Fornisci un prompt testuale per guidare il processo di texturing. Massimo 800 caratteri.
Name
texture_image_url
Type
string
Description
Fornisci un'immagine 2d per guidare il processo di texturing. Attualmente supportiamo i formati .jpg, .jpeg e .png.
Ci sono due modi per fornire l'immagine:
URL pubblicamente accessibile: un URL accessibile dalla rete internet pubblica
Data URI: un data URI dell'immagine codificato in base64. Esempio di data URI: data:image/jpeg;base64,<your base64-encoded image data>
Il texturing tramite immagine potrebbe non funzionare in modo ottimale se ci sono differenze geometriche sostanziali tra l'asset originale e l'immagine caricata. Per guidare il processo di texturing può essere usato solo uno tra texture_image_url o texture_prompt. Se vengono forniti entrambi i parametri, per impostazione predefinita verrà usato texture_prompt per applicare la texture al modello. Il texturing tramite testo o immagine costerà 10 crediti per attività.
Controlla se abilitare la fase di remesh. Per ottenere il modello di qualità più elevata, consigliamo di impostare should_remesh su false.
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 dominanza di quadrilateri.
triangle: genera una mesh triangolare decimata.
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 salva anche un file GLB aggiuntivo prima del completamento della fase di remesh.
Name
target_polycount
Type
integer
Description
Numero target di poligoni (facce) nell'output. Il conteggio effettivo può discostarsi dal target a seconda della geometria.
target_polycount ha effetto in due casi indipendenti:
Remesh — con should_remesh: true su un modello standard. La mesh viene sottoposta a remesh (decimata) fino a raggiungere approssimativamente questo conteggio. Intervallo da 100 a 300.000, predefinito 30.000. Se decimation_mode è impostato, ha la priorità e target_polycount viene ignorato.
Smart Topology — con model_type: smart-topology e ai_model: meshy-t2. Il modello viene generato direttamente con questo numero di facce; non viene eseguito alcun remesh e should_remesh non è richiesto. Intervallo da 100 a 15.000, predefinito 4.000.
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 al suo posto. Indica se generare il modello in posa A/T.
Name
image_enhancement
Type
boolean
predefinito true
Description
Ottimizza l'immagine di input per ottenere 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, meshy-7 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.
Name
moderation
Type
boolean
predefinito false
Description
Quando impostato su true, il contenuto di input verrà automaticamente sottoposto a controllo per individuare contenuti potenzialmente dannosi. Se viene rilevato contenuto dannoso, l'attività non procederà con la generazione.
Il contenuto proveniente dagli input image_url, texture_image_url e texture_prompt verrà sottoposto a controllo.
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à. Se omesso, vengono inclusi tutti i formati supportati.
Valori disponibili: glb, obj, fbx, stl, usdz, 3mf
Se 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 utilizza la visione artificiale per stimare automaticamente l'altezza reale dell'oggetto e ridimensionare il modello di conseguenza. L'origine sarà impostata per default su bottom a meno che origin_at non venga impostato esplicitamente.
Name
alpha_thumbnail
Type
boolean
predefinito false
Description
Quando impostato su true, l'attività genera inoltre 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à genera inoltre quattro miniature con viste cardinali (fronte, destra, retro, 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 ne risentono.
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.
Valori restituiti
La proprietà result della risposta contiene l'id dell'attività dell'attività Immagine in 3D appena creata.
Modalità di errore
Name
400 - Bad Request
Description
La richiesta non è accettabile. Cause comuni:
Parametro mancante: deve essere fornito image_url oppure 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 produca 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 image_url (404 o timeout).
Data URI non valido: la stringa base64 non è formattata correttamente.
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 limite di frequenza.
Request
POST
/openapi/v1/image-to-3d
# Simple request with required paramscurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-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-posecurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-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 ti permette di recuperare un'attività Immagine in 3D dato un valido id dell'attività.
Consulta L'oggetto Attività Immagine in 3D per vedere quali
proprietà sono incluse con l'oggetto attività Immagine in 3D.
Parametri
Name
id
Type
path
Description
Identificatore univoco per l'attività Immagine in 3D da recuperare.
L'oggetto Attività Immagine in 3D è un'unità di lavoro che 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à. Anche se utilizziamo un UUID ordinabile per id delle attività come dettaglio di implementazione, non dovresti fare alcuna supposizione sul formato dell'id.
Name
type
Type
string
Description
Tipo di attività Immagine in 3D. Il valore è image-to-3d.
Name
model_urls
Type
object
Description
URL scaricabile per il file del modello 3D texturizzato generato da Meshy. La proprietà per un formato sarà omessa se il formato non è generato invece di restituire una stringa vuota.
Name
glb
Type
string
Description
URL scaricabile per il file GLB.
Name
fbx
Type
string
Description
URL scaricabile per il file FBX.
Name
obj
Type
string
Description
URL scaricabile per il file OBJ.
Name
usdz
Type
string
Description
URL scaricabile per il file USDZ.
Name
mtl
Type
string
Description
URL scaricabile per il file MTL, restituito insieme alle esportazioni OBJ quando le texture sono presenti.
Name
stl
Type
string
Description
URL scaricabile per il file STL.
Name
3mf
Type
string
Description
URL scaricabile per il file 3MF. Presente solo quando 3mf è stato richiesto tramite target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL scaricabile per l'output GLB originale prima del remeshing.
Disponibile solo quando l'attività è stata creata con entrambi should_remesh: true e save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL scaricabile per l'immagine miniatura del file del modello. Equivalente a thumbnail_urls.front quando presente, mantenuto per compatibilità retroattiva.
Name
alpha_thumbnail_url
Type
string
Description
URL scaricabile per una versione a sfondo trasparente (RGBA) di thumbnail_url. Presente solo quando l'attività è stata creata con alpha_thumbnail: true e l'anteprima trasparente è stata renderizzata con successo; altrimenti questo campo è omesso.
Name
thumbnail_urls
Type
object
Description
URL scaricabili per quattro miniature di visualizzazione cardinali del modello 3D generato. Ogni valore è un URL firmato per un PNG 512×512 renderizzato con gli stessi materiali e illuminazione di thumbnail_url. Utile per visualizzare in anteprima il modello da più angolazioni in pipeline batch senza scaricare il GLB.
Presente solo quando l'attività è stata creata con multi_view_thumbnails: true e ha raggiunto SUCCEEDED. Le attività più vecchie e quelle create senza l'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 texturizzazione.
Name
texture_image_url
Type
string
Description
URL scaricabile per l'immagine della texture che è stata utilizzata per guidare il processo di texturizzazione.
Name
ultra_mode
Type
boolean
Description
Echi il valore ultra_mode con cui l'attività è stata creata. Presente solo per attività meshy-7 (o latest) che hanno esplicitamente impostato ultra_mode; omesso altrimenti.
Name
progress
Type
integer
Description
Progresso dell'attività. Se l'attività non è ancora iniziata, 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 iniziata, 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 nell'API Meshy.
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 di PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Un array di oggetti URL di texture che sono generati dall'attività. Normalmente questo contiene solo un oggetto URL di texture. Ogni URL di texture ha le seguenti proprietà:
Name
base_color
Type
string
Description
URL scaricabile per l'immagine della mappa del colore di base.
Name
metallic
Type
string
Description
URL scaricabile per l'immagine della mappa metallica.
Se l'attività è creata con enable_pbr: false, questa proprietà sarà omessa.
Name
normal
Type
string
Description
URL scaricabile per l'immagine della normal map.
Se l'attività è creata con enable_pbr: false, questa proprietà sarà omessa.
Name
roughness
Type
string
Description
URL scaricabile per l'immagine della mappa di rugosità.
Se l'attività è creata con enable_pbr: false, questa proprietà sarà omessa.
Name
emission
Type
string
Description
URL scaricabile per l'immagine della mappa di emissione.
Se l'attività è creata con enable_pbr: false, o ai_model è meshy-5, meshy-7, o latest, questa proprietà sarà 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à fallite. Vedi Errori per il riferimento completo all'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 sono rimborsati in caso di fallimento).