Trasforma una foto sorgente in un paralume stampabile in 3D in due fasi:
prototype genera un'immagine di concept stilizzata bianco opaco e la trasforma
in un modello 3D cavo (GLB), quindi build esegue il processore della lampada su
quel modello per produrre le parti stampabili in STL — un paralume aperto sul fondo
con una piastra di base per il fissaggio della sorgente luminosa, oltre al supporto
di fissaggio stesso. Le due fasi sono collegate tramite input_task_id.
Genera una singola immagine concettuale bianco opaco a partire da una foto di riferimento e la
converte in un modello 3D di paralume cavo. La risposta include sia l'immagine
concettuale (image_urls) sia il modello 3D (model_urls.glb con una
thumbnail_url). L'ID dell'attività restituito è quello che passi come input_task_id
all'endpoint di build. Fai riferimento a
L'oggetto Lamp Prototype Task
per la forma della risposta.
Parametri
Name
image_url
Type
string
Obbligatorio
Description
Foto sorgente che Meshy usa come riferimento visivo per il paralume. Attualmente supportiamo i formati .jpg, .jpeg, .png e .webp.
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,<i tuoi dati immagine codificati in base64>.
Name
image_subject
Type
string
predefinito character
Description
Suggerimento della categoria del soggetto che seleziona il prompt di stylization. Valori disponibili:
character (predefinito) — soggetto singolo personaggio/oggetto (personaggio, animale, mascotte, ecc.).
Nome opzionale dell'attività per scopi di visualizzazione. Massimo 100 caratteri.
Name
remove_background
Type
boolean
predefinito false
Description
Quando impostato su true, l'immagine del prototipo viene restituita come PNG RGBA trasparente con lo sfondo rimosso, così puoi comporre il soggetto su qualsiasi sfondo.
Ritorna
La proprietà result della risposta contiene l'id dell'attività dell'attività di prototipo lampada appena creata. Interroga l'endpoint Ottieni un'attività oppure iscriviti allo stream finché l'attività non raggiunge SUCCEEDED, poi passa quell'ID all'endpoint di build come input_task_id.
Modalità di fallimento
Name
400 - Bad Request
Description
La richiesta non era accettabile. Cause comuni:
Parametro mancante: image_url è obbligatorio.
Formato immagine non valido: l'image_url fornito non è un formato supportato (.jpg, .jpeg, .png, .webp).
Dimensioni dell'immagine fuori intervallo: l'immagine è troppo piccola, supera la dimensione massima del file o supera il conteggio massimo di pixel.
URL non raggiungibile: l'image_url non ha potuto essere scaricato (404 o timeout).
Data URI non valido: la stringa base64 è malformata.
Contenuto segnalato: l'immagine di input è stata segnalata dalla moderation per contenuti NSFW o proprietà intellettuale.
image_subject non valido: non è uno tra character / landscape.
Name
401 - Unauthorized
Description
Autenticazione fallita. 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/creative-lab/lamp/v1/prototype
# Stage 1: concept image + hollow 3D lampshade model from a source photocurlhttps://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype \-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>", "image_subject": "character" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source photo; the prototype returns the concept image and a hollow 3D model that the build stage processes.
Genera le parti finali stampabili in 3D a partire da un'attività di prototipo riuscita.
Il build esegue il lamp processor sul modello 3D del prototipo: scala
il modello a diameter_mm, appiattisce la base di cut_amount_percent,
lo svuota fino a thickness_mm, apre il fondo e — quando viene scelto un
preset di fixture — aggiunge una base con il foro per la fixture e un
supporto separato per la sorgente luminosa. Consulta
The Lamp Build Task Object per la forma
della risposta.
Parametri
Name
input_task_id
Type
string
Obbligatorio
Description
L'ID dell'attività di un'attività di prototipo creata tramite questo stesso endpoint OpenAPI. Il prototipo deve essere stato creato con la stessa chiave API, deve aver raggiunto SUCCEEDED e deve aver prodotto un modello 3D.
Le attività di prototipo create tramite la webapp non sono accettate — l'endpoint di build accetta solo attività di prototipo prodotte da POST /openapi/creative-lab/lamp/v1/prototype e rifiuta qualsiasi altra origine con 404.
Name
name
Type
string
Description
Nome facoltativo dell'attività per scopi di visualizzazione. Massimo 100 caratteri.
options
Parametri di regolazione facoltativi per la geometria del paralume. Ogni campo ha un valore predefinito sensato — invia solo quelli che vuoi sovrascrivere.
Name
diameter_mm
Type
number
predefinito 150
Description
Dimensione massima target del bounding box del paralume, in millimetri. La mesh viene scalata uniformemente per adattarsi. Intervallo: [50, 400].
Name
thickness_mm
Type
number
predefinito 1
Description
Spessore parete del paralume cavo, in millimetri. Intervallo: (0, 10].
Name
cut_amount_percent
Type
number
predefinito 1
Description
Percentuale dell'altezza del modello tagliata piatta sul fondo, in modo che il paralume poggi sul piano di stampa e abbia un'apertura per la fixture. Intervallo: [1, 100].
Name
light_source_preset
Type
string
predefinito bambu_mh001_60mm
Description
Preset della fixture per la sorgente luminosa che determina come viene costruito il fondo. Valori disponibili:
bambu_mh001_60mm (predefinito) — paralume con fondo aperto più una base che porta un foro fixture da 60 mm, entrambi in model_urls.lamp_stl, e il supporto della fixture come model_urls.base_stl.
none — un singolo paralume sigillato in model_urls.lamp_stl; model_urls.base_stl viene omesso.
Name
fixture_offset_x_mm
Type
number
predefinito 0
Description
Offset sull'asse X del foro fixture sulla base, relativo al centro del paralume, in millimetri. Ha significato solo quando light_source_preset ≠ none. Intervallo: [-80, 80].
Name
fixture_offset_z_mm
Type
number
predefinito 0
Description
Offset sull'asse Z (profondità) del foro fixture sulla base, relativo al centro del paralume, in millimetri. Ha significato solo quando light_source_preset ≠ none. Intervallo: [-80, 80].
Name
rotate_x_deg
Type
number
predefinito 0
Description
Rotazione attorno all'asse X applicata al modello prima dell'elaborazione, in gradi. Le tre rotazioni vengono applicate come angoli di Eulero XYZ attorno al centro del modello. Intervallo: [-360, 360].
Name
rotate_y_deg
Type
number
predefinito 0
Description
Rotazione attorno all'asse Y applicata alla mesh importata prima dell'elaborazione, in gradi. Intervallo: [-360, 360].
Name
rotate_z_deg
Type
number
predefinito 0
Description
Rotazione attorno all'asse Z applicata alla mesh importata prima dell'elaborazione, in gradi. Intervallo: [-360, 360].
Name
include_result_json
Type
boolean
predefinito false
Description
Quando true e output.format è zip, include il result.json del lamp processor (nome della pipeline, avvisi e percorsi degli artefatti) all'interno del pacchetto. Ignorato quando output.format è stl.
output
Selettore del formato di trasmissione facoltativo. Il valore predefinito è stl.
Name
format
Type
string
predefinito stl
Description
Pacchetto di artefatti restituito dal build. Valori disponibili:
stl (predefinito) — restituisce model_urls.lamp_stl (il paralume, insieme alla base quando è impostato un preset di fixture), più model_urls.base_stl quando light_source_preset ≠ none.
zip — impacchetta ogni artefatto emesso dal processore (lamp.stl, base.stl opzionale, result.json opzionale) in un unico zip e lo restituisce sotto model_urls.bundle_zip.
Valori restituiti
La proprietà result della risposta contiene l'id dell'attività dell'attività di build lamp appena creata. Effettua il polling dell'endpoint Get a Task oppure iscriviti allo stream finché l'attività non raggiunge SUCCEEDED, quindi scarica gli artefatti da model_urls.
Modalità di errore
Name
400 - Bad Request
Description
La richiesta non era accettabile. Cause comuni:
Parametro mancante: input_task_id è obbligatorio.
UUID non valido: input_task_id non è un UUID valido.
Genitore non riuscito: l'attività di prototipo referenziata non ha ancora raggiunto SUCCEEDED.
Nessun modello: l'attività di prototipo è riuscita ma non ha prodotto alcun modello 3D.
Opzioni fuori intervallo: uno dei campi di options è fuori dall'intervallo consentito o dal set di valori enumerati.
Name
401 - Unauthorized
Description
Autenticazione non riuscita. Verifica la tua chiave API.
Name
402 - Payment Required
Description
Crediti insufficienti per eseguire questa attività.
Name
404 - Not Found
Description
L'attività di prototipo referenziata non esiste, appartiene a un altro utente, oppure è stata creata tramite la webapp (solo le attività di prototipo in modalità API si concatenano al build).
Recupera un task di prototype o di build dato un id di task valido. Il percorso dell'URL
deve corrispondere alla fase del task — un task di build recuperato tramite
/prototype/:id restituisce 404, e viceversa.
Annulla un'attività lampada. Se l'attività è ancora PENDING, i crediti consumati
al momento della creazione vengono rimborsati. Le attività che sono già IN_PROGRESS sono
annullate senza rimborso (il lavoratore potrebbe già essere in fase di utilizzo delle risorse).
Le attività che hanno già raggiunto uno stato terminale (SUCCEEDED, FAILED,
CANCELED) non possono essere annullate.
Il percorso URL deve corrispondere alla fase dell'attività — DELETE su
/prototype/:buildId restituisce 404.
Parametri del percorso
Name
id
Type
path
Description
Identificatore univoco per l'attività lampada da annullare.
Restituisce
Restituisce 204 No Content in caso di successo con un corpo vuoto.
Modalità di fallimento
Name
400 - Bad Request
Description
L'attività è già in uno stato terminale e non può essere annullata.
Name
404 - Not Found
Description
L'attività non esiste, appartiene a un altro utente o la sua fase non corrisponde al percorso URL.
Trasmette in streaming aggiornamenti in tempo reale per un task lampada tramite Server-Sent Events (SSE).
Il percorso URL deve corrispondere alla fase del task — aprire uno stream su
/prototype/:buildId/stream emette un singolo payload event: error con
status_code: 404 e chiude lo stream.
Parametri
Name
id
Type
path
Description
Identificatore univoco del task lampada da trasmettere in streaming.
Valori restituiti
Restituisce uno stream di oggetti task Lamp Prototype
o Lamp Build come
Server-Sent Events. Per i task PENDING o IN_PROGRESS, lo stream di risposta
includerà solo i campi necessari progress e status.
// Error event example (wrong stage or task not found)event: errordata: {"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: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-lamp-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 6,"model_urls": {"lamp_stl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***","base_stl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***" }}
Recupera un elenco paginato delle tue attività lamp per un singolo stage. Il percorso
dell'URL seleziona lo stage — /prototype restituisce le attività di prototipo; /build
restituisce le attività di build. Le attività dell'altro stage non sono incluse in nessuna
delle due risposte.
Parametri del percorso
Name
stage
Type
path
Obbligatorio
Description
prototype oppure build. La raccolta restituisce solo le attività
il cui stage corrisponde all'URL — richiedere /prototype non restituisce mai
attività di build e viceversa.
Parametri della query
Name
page_num
Type
integer
predefinito 1
Description
Numero di pagina per la paginazione.
Name
page_size
Type
integer
predefinito 10
Description
Limite di dimensione della pagina. Il massimo consentito è 50 elementi.
Name
sort_by
Type
string
predefinito -created_at
Description
Campo in base al quale ordinare. Valori disponibili:
+created_at: Ordina per data di creazione in ordine crescente.
-created_at: Ordina per data di creazione in ordine decrescente.
L'oggetto Task del Prototipo Lampada è un'unità di lavoro che Meshy tiene traccia per
generare un'immagine concettuale stilizzata bianco opaco a partire da una foto sorgente e
convertirla in un modello 3D cavo. L'output di questa fase viene concatenato a
la fase di build tramite input_task_id.
Proprietà
Name
id
Type
string
Description
Identificatore univoco del task. Sebbene utilizziamo un UUID k-sortable per gli id dei task come dettaglio implementativo, non dovresti fare alcuna assunzione sul formato dell'id.
Name
type
Type
string
Description
Tipo del task. Il valore è creative-lab-lamp-prototype.
Name
name
Type
string
Description
Il nome del task fornito al momento della creazione. Stringa vuota se non è stato fornito alcun nome.
Name
status
Type
string
Description
Stato del task. I valori possibili sono uno tra PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progresso del task. Se il task non è ancora iniziato, questa proprietà sarà 0. Una volta che il task ha avuto successo, diventerà 100.
Name
created_at
Type
timestamp
Description
Timestamp di quando il task è stato creato, 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 nell'Meshy API.
Name
started_at
Type
timestamp
Description
Timestamp di quando il task è stato avviato, in millisecondi. Se il task non è ancora stato avviato, questa proprietà sarà 0.
Name
finished_at
Type
timestamp
Description
Timestamp di quando il task è stato terminato, in millisecondi. Se il task non è ancora terminato, questa proprietà sarà 0.
Name
expires_at
Type
timestamp
Description
Timestamp di quando il risultato del task scade, in millisecondi.
Name
preceding_tasks
Type
integer
Description
Il conteggio dei task precedenti.
Il valore di questo campo è significativo solo se lo stato del task è PENDING.
Name
task_error
Type
object
Description
Dettagli dell'errore per i task falliti. Consulta Errori per il riferimento completo all'oggetto task_error.
Name
consumed_credits
Type
integer
Description
Il numero di crediti consumati da questo task. Presente quando lo stato del task è PENDING, IN_PROGRESS, o SUCCEEDED. Restituisce 0 per i task FAILED (i crediti vengono rimborsati in caso di fallimento).
Name
model_urls
Type
object
Description
URL scaricabili per il modello 3D generato dall'immagine concettuale. Presente una volta che il task ha avuto successo; {} prima di ciò.
Name
glb
Type
string
Description
URL scaricabile per il modello cavo del paralume bianco opaco in formato GLB. Questo è il modello che la fase di build elabora.
Name
thumbnail_url
Type
string
Description
URL scaricabile per un'anteprima renderizzata del modello 3D. Stringa vuota finché il task non ha avuto successo.
Name
image_urls
Type
array of strings
Description
URL scaricabili per i candidati dell'immagine concettuale generati da questo task di prototipo. Attualmente l'API restituisce sempre esattamente un candidato; il campo è un array in modo che revisioni future possano mostrare più candidati senza una modifica incompatibile.
L'oggetto Lamp Build Task è un'unità di lavoro che Meshy tiene traccia per
generare il paralume 3D-printable finale a partire da un task di prototipo riuscito.
Il build esegue il processore per lampade sul modello 3D del prototipo per svuotarlo,
appiattire e aprire il fondo e (con un preset di fissaggio) aggiungere la piastra di base
e l'attacco per il fissaggio.
Proprietà
Name
id
Type
string
Description
Identificatore univoco del task.
Name
type
Type
string
Description
Tipo del task. Il valore è creative-lab-lamp-build.
Name
name
Type
string
Description
Il nome del task fornito al momento della creazione del task. Stringa vuota se non è stato fornito alcun nome.
Name
status
Type
string
Description
Stato del task. I valori possibili sono uno tra PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progresso del task. Se il task non è ancora iniziato, questa proprietà sarà 0. Una volta che il task è riuscito, diventerà 100.
Name
created_at
Type
timestamp
Description
Timestamp di quando il task è stato creato, in millisecondi.
Name
started_at
Type
timestamp
Description
Timestamp di quando il task è stato avviato, in millisecondi.
Name
finished_at
Type
timestamp
Description
Timestamp di quando il task è stato completato, in millisecondi.
Name
expires_at
Type
timestamp
Description
Timestamp di quando il risultato del task scade, in millisecondi.
Name
preceding_tasks
Type
integer
Description
Il numero di task precedenti. Significativo solo quando lo status è PENDING.
Name
task_error
Type
object
Description
Dettagli dell'errore per i task falliti. Vedi Errori per il riferimento completo all'oggetto task_error.
Name
consumed_credits
Type
integer
Description
Il numero di crediti consumati da questo task. Restituisce 0 per i task FAILED (i crediti vengono rimborsati in caso di fallimento).
Name
model_urls
Type
object
Description
URL scaricabili per gli artefatti generati, indicizzati per nome dell'artefatto. L'insieme di chiavi dipende da output.format e options.light_source_preset:
Name
lamp_stl
Type
string
Description
URL scaricabile per lamp.stl: il paralume a fondo aperto insieme alla piastra di base che porta il foro per il fissaggio, oppure un singolo paralume sigillato quando options.light_source_preset era none. Presente quando output.format era stl (il valore predefinito).
Name
base_stl
Type
string
Description
URL scaricabile per base.stl, l'attacco di fissaggio per la sorgente luminosa. Presente quando output.format era stleoptions.light_source_preset non era none. Omesso quando il preset di fissaggio era none.
Name
bundle_zip
Type
string
Description
URL scaricabile per un pacchetto zip contenente ogni artefatto emesso dal processore (lamp.stl, base.stl opzionale e — quando options.include_result_json è true — result.json). Presente quando output.format era zip. Quando bundle_zip è presente, lamp_stl / base_stl sono omessi.