Trasforma una foto sorgente in una statuina 3D collezionabile in stile mattoncino in due fasi:
prototype genera un'immagine concettuale stilizzata a partire dalla tua foto di input, poi
build trasforma tale immagine concettuale in un modello 3D texturizzato. Le due fasi
sono collegate tramite input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Genera una singola immagine concettuale in stile mattoncino a partire dalla foto sorgente. L'ID del task
restituito è ciò che passerai come input_task_id all'endpoint
di build. Fai riferimento a
The Brick Figure Prototype Task Object
per la forma della risposta.
Parametri
Name
image_url
Type
string
Obbligatorio
Description
Foto sorgente che Meshy stilizzerà come minifigure in mattoncini. 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 pubblicamente.
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
name
Type
string
Description
Nome opzionale del task 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.
Restituisce
La proprietà result della risposta contiene l'id del task del nuovo task di prototipo brick figure appena creato. Effettua il polling dell'endpoint Get a Task oppure sottoscrivi lo stream finché il task non raggiunge lo stato SUCCEEDED, quindi passa quell'ID all'endpoint di build come input_task_id.
Modalità di errore
Name
400 - Bad Request
Description
La richiesta non è stata accettata. Cause comuni:
Parametro mancante: image_url è obbligatorio.
Formato immagine non valido: l'image_url fornito non è in un formato supportato (.jpg, .jpeg, .png, .webp).
Dimensioni immagine fuori intervallo: l'immagine è troppo piccola, supera la dimensione massima del file o supera il numero massimo di pixel.
URL non raggiungibile: non è stato possibile scaricare image_url (404 o timeout).
Data URI non valido: la stringa base64 è malformata.
Contenuto segnalato: l'immagine di input è stata segnalata dalla moderation NSFW.
Name
401 - Unauthorized
Description
Autenticazione fallita. Verifica la tua chiave API.
Name
402 - Payment Required
Description
Crediti insufficienti per eseguire questo task.
Name
403 - Forbidden
Description
L'immagine di input è stata segnalata per violazione della proprietà intellettuale.
Name
429 - Too Many Requests
Description
Hai superato il limite di frequenza.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/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>" }'
Genera la statuina 3D di mattoncini finale e texturizzata a partire da un task di prototipo riuscito. Il build esegue la stessa pipeline immagine-in-3D di
Immagine in 3D, quindi il formato dell'oggetto di risposta e l'elenco degli URL di output corrispondono esattamente. Fai riferimento a
The Brick Figure Build Task Object per la forma della risposta.
Parametri
Name
input_task_id
Type
string
Obbligatorio
Description
L'ID del task di un task di prototipo creato tramite questo stesso endpoint OpenAPI. Il prototipo deve essere stato creato con la stessa chiave API, deve aver raggiunto lo stato SUCCEEDED e deve aver prodotto esattamente un'immagine candidata.
I task di prototipo creati tramite la webapp non sono accettati: l'endpoint di build accetta solo i task di prototipo prodotti da POST /openapi/creative-lab/brick-figure/v1/prototype e rifiuta qualsiasi altra origine con 404.
Name
name
Type
string
Description
Nome del task opzionale a scopo di visualizzazione. Massimo 100 caratteri.
Restituisce
La proprietà result della risposta contiene l'id del task del nuovo build della statuina di mattoncini appena creato. Effettua il polling dell'endpoint Get a Task o iscriviti allo stream finché il task non raggiunge SUCCEEDED, quindi scarica il GLB texturizzato da model_urls.glb (oppure la coppia OBJ + MTL da model_urls.obj e model_urls.mtl se la tua pipeline a valle preferisce OBJ).
Modalità di errore
Name
400 - Bad Request
Description
La richiesta non è stata accettata. Cause comuni:
Parametro mancante: input_task_id è obbligatorio.
UUID non valido: input_task_id non è un UUID valido.
Il parent non è riuscito: il task di prototipo referenziato non ha ancora raggiunto lo stato SUCCEEDED.
Nessun candidato: il task di prototipo è riuscito ma non ha prodotto alcuna immagine candidata.
Name
401 - Unauthorized
Description
Autenticazione non riuscita. Controlla la tua chiave API.
Name
402 - Payment Required
Description
Crediti insufficienti per eseguire questo task.
Name
404 - Not Found
Description
Il task di prototipo referenziato non esiste, appartiene a un altro utente o è stato creato tramite la webapp (solo i task di prototipo in modalità API possono essere concatenati al build).
Name
429 - Too Many Requests
Description
Hai superato il tuo limite di frequenza.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Recupera un'attività di prototipo o build dato un id di attività valido. Il percorso URL
deve corrispondere alla fase dell'attività — un'attività di build recuperata tramite
/prototype/:id restituisce 404, e viceversa.
Annulla un task di brick figure. Se il task è ancora PENDING, i crediti
consumati al momento della creazione vengono rimborsati. I task già
IN_PROGRESS vengono annullati senza rimborso (il worker potrebbe già
essere impegnato a consumare risorse). I task che hanno già raggiunto uno
stato terminale (SUCCEEDED, FAILED, CANCELED) non possono essere annullati.
Il percorso URL deve corrispondere allo stage del task — DELETE su
/prototype/:buildId restituisce 404.
Parametri del percorso
Name
id
Type
path
Description
Identificatore univoco del task di brick figure da annullare.
Restituisce
Restituisce 204 No Content in caso di successo con un corpo vuoto.
Modalità di errore
Name
400 - Bad Request
Description
Il task si trova già in uno stato terminale e non può essere annullato.
Name
404 - Not Found
Description
Il task non esiste, appartiene a un altro utente, oppure il suo stage non corrisponde al percorso URL.
Effettua lo streaming degli aggiornamenti in tempo reale per un'attività brick figure tramite Server-Sent Events (SSE).
Il percorso dell'URL deve corrispondere alla fase dell'attività — 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 dell'attività brick figure di cui effettuare lo streaming.
Restituisce
Restituisce uno stream di oggetti attività Brick Figure Prototype
o Brick Figure Build come
Server-Sent Events. Ogni frame trasporta l'intero oggetto attività per la fase — la stessa struttura
restituita dall'endpoint Get — quindi mentre l'attività è PENDING o IN_PROGRESS i
campi di output semplicemente non sono ancora popolati (null, [] o {}) e
finished_at è null.
Recupera un elenco paginato dei tuoi task di statuina in mattoncini per una singola fase. Il percorso
URL seleziona la fase — /prototype restituisce i task di prototipo; /build
restituisce i task di build. I task dell'altra fase non sono inclusi in nessuna delle
due risposte.
Parametri del percorso
Name
stage
Type
path
Obbligatorio
Description
Può essere prototype o build. La raccolta restituisce solo i task
la cui fase corrisponde all'URL — richiedere /prototype non restituisce mai
task 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 elementi per pagina. Il massimo consentito è 100 elementi.
Name
sort_by
Type
string
predefinito -created_at
Description
Campo su cui 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 Brick Figure Prototype Task è un'unità di lavoro che Meshy tiene traccia per
generare un'immagine concettuale in stile mattoncino a partire da una foto sorgente. L'output di
questa fase viene collegato a la fase di build
tramite input_task_id.
Proprietà
Name
id
Type
string
Description
Identificatore univoco del task. Sebbene per gli id dei task venga utilizzato, come dettaglio implementativo, un UUID k-sortable, non si dovrebbero fare assunzioni sul formato dell'id.
Name
type
Type
string
Description
Tipo del task. Il valore è creative-lab-brick-figure-prototype.
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 possibili valori 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 è andato a buon fine, 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 alle 12:00:00 GMT è rappresentato come 1693569600000. Questo si applica
a tutti i timestamp nella 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à null.
Name
finished_at
Type
timestamp
Description
Timestamp di quando il task è stato completato, in millisecondi. Se il task non è ancora stato completato, questa proprietà sarà null.
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.
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. Vedere 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
image_urls
Type
array of strings
Description
URL scaricabili per i candidati dell'immagine concettuale generati da questo task di prototipazione. Attualmente l'API restituisce sempre esattamente un candidato; il campo è un array in modo che revisioni future possano esporre più candidati senza introdurre modifiche non retrocompatibili.
L'oggetto Brick Figure Build Task è un'unità di lavoro che Meshy tiene traccia per
generare una statuina di mattoncini 3D con texture a partire da un task di prototipo riuscito. Esegue
la stessa pipeline immagine-in-3D utilizzata da Immagine in 3D,
quindi i campi di output rispecchiano l'oggetto task di quell'endpoint.
Proprietà
Name
id
Type
string
Description
Identificatore univoco per il task.
Name
type
Type
string
Description
Tipo del task. Il valore è creative-lab-brick-figure-build.
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
Progress 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. Consulta Errori per il riferimento completo dell'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
prompt
Type
string
Description
Sempre vuoto per il brick figure build. Presente per compatibilità cross-endpoint con la struttura condivisa V2ImageTo3DTaskResponse utilizzata da Immagine in 3D.
Name
negative_prompt
Type
string
Description
Sempre vuoto per il brick figure build. Presente per compatibilità cross-endpoint.
Name
texture_prompt
Type
string
Description
Sempre vuoto per il brick figure build. Presente per compatibilità cross-endpoint.
Name
texture_image_url
Type
string
Description
Sempre vuoto per il brick figure build. Presente per compatibilità cross-endpoint.
Name
model_urls
Type
object
Description
URL scaricabili per il modello 3D generato. Il brick figure build produce un GLB con texture più la coppia OBJ + MTL per le pipeline che preferiscono il formato Wavefront OBJ. La struttura del campo corrisponde all'oggetto model_urls di Immagine in 3D, in modo che future aggiunte di formati si integrino senza modifiche incompatibili.
Name
glb
Type
string
Description
URL scaricabile del file GLB con texture.
Name
obj
Type
string
Description
URL scaricabile del file Wavefront OBJ (geometria + UV).
Name
mtl
Type
string
Description
URL scaricabile del file materiale MTL associato all'OBJ. Da abbinare a obj e alla voce di texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL scaricabile per l'immagine miniatura del file del modello.
Name
texture_urls
Type
array
Description
Un array di oggetti URL delle texture generati da questo task. Attualmente contiene un singolo oggetto con la mappa del colore base.
Name
base_color
Type
string
Description
URL scaricabile per l'immagine della mappa del colore base.