Creative Lab Fridge Magnet API

Trasforma una foto in un magnete da frigo stampabile in 3D con un rilievo colorato e un retro piatto, in due fasi. Un task di prototipo genera un'immagine concettuale colorata a partire dalla foto. Un task di build trasforma quell'immagine in un modello 3D in rilievo, e prende l'ID del task di prototipo come input_task_id.

POST /openapi/creative-lab/fridge-magnet/v1/prototype
POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

Crea un'attività di prototipo Fridge Magnet

Genera un'immagine concettuale colorata a partire da una foto. Per costruire il modello 3D, passa l'ID di questa attività all'endpoint di build come input_task_id. Per i campi dell'attività, vedi L'oggetto attività di prototipo Fridge Magnet.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/prototype

# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype \
  -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>"
  }'

Response

{
  "result": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}

Esempio di prototipo

Parti da una foto sorgente, poi genera l'immagine di prototipo usata dalla fase di build del fridge magnet.

Foto di paesaggio sorgente usata come input per il Creative Lab Fridge Magnet — Input del prototipo

Output del prototipo Creative Lab Fridge Magnet generato dalla foto sorgente — Output del prototipo

Parametri

Name
image_url
Type
string
Obbligatorio
Description
La foto da trasformare in un'immagine concettuale per magnete da frigo, come URL pubblico o data URI (data:image/jpeg;base64,<i tuoi dati immagine codificati in base64>).
L'immagine deve essere un file JPG, JPEG, PNG o WebP di al massimo 20 MB.
Name
name
Type
string
Description
Un nome per l'attività, fino a 100 caratteri. Viene restituito nel campo name dell'attività. Un nome più lungo restituisce 400.
Name
remove_background
Type
boolean
predefinito false
Description
Se rimuovere lo sfondo dall'immagine di prototipo. true restituisce un PNG RGBA trasparente che mantiene l'intero magnete, così puoi posizionarlo su qualsiasi sfondo. Anche la build parte dall'immagine priva di sfondo. Se Meshy non riesce a rimuovere lo sfondo, restituisce l'immagine con il suo sfondo, e l'attività comunque va a buon fine.
L'opzione remove_background della build è separata.

Valori restituiti

Il campo result contiene l'ID della nuova attività di prototipo. Recupera l'attività o trasmettila in streaming finché status non è SUCCEEDED. Poi passa l'ID all'endpoint di build come input_task_id.

Modalità di errore

Name
400 - Bad Request
Description
La richiesta non può essere eseguita. Ad esempio:
- image_url è mancante.
- L'immagine non è un file JPG, JPEG, PNG o WebP.
- L'immagine è troppo piccola, supera i 20 MB o supera il numero massimo di pixel.
- Meshy non riesce a scaricare l'immagine, ad esempio perché l'URL restituisce 404 o va in timeout.
- Il data URI non è una base64 valida.
- L'immagine è stata segnalata come NSFW.
Il messaggio di errore indica quale problema ha trovato. Correggi la richiesta, poi inviala di nuovo.
Name
401 - Unauthorized
Description
La chiave API è mancante o non valida. Controlla l'header Authorization.
Name
402 - Payment Required
Description
Si applica uno di questi casi:
- L'account non ha crediti sufficienti.
- La chiave API, lo spazio di lavoro o il membro ha raggiunto il proprio limite di crediti.
- L'account è sul piano gratuito.
Controlla i tuoi crediti e il tuo piano, poi riprova.
Name
403 - Forbidden
Description
Il tuo team ha attivato il Filtraggio IP, e Meshy ha segnalato l'immagine per proprietà intellettuale di terzi. Invia un'immagine che hai il diritto di usare.
Name
429 - Too Many Requests
Description
È stato raggiunto uno di questi limiti:
- Hai inviato più richieste di quante ne consenta il tuo limite di frequenza. Attendi qualche secondo, poi riprova. Vedi Limiti di frequenza.
- Troppe tue attività sono in coda o in esecuzione. Attendi che alcune terminino, poi riprova.
- Su un piano illimitato senza crediti residui, hai raggiunto il numero di attività che possono essere eseguite senza crediti. Attendi che un'attività termini, oppure aggiungi crediti.
Name
500 - Internal Server Error
Description
Meshy ha riscontrato un errore del server, ad esempio perché non è riuscito a eseguire il controllo di proprietà intellettuale sull'immagine. Meshy non crea l'attività e rimborsa eventuali crediti addebitati. Riprova la richiesta.

POST/openapi/creative-lab/fridge-magnet/v1/build

Crea un task di build Fridge Magnet

Genera il magnete da frigo stampabile in 3D a partire da un task di prototipo riuscito. Meshy trasforma l'immagine concept del prototipo in un rilievo da depth-map e restituisce un file modello nel formato che scegli. Per i campi del task, vedi L'oggetto task di build Fridge Magnet.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}

Build example

The build task turns the selected prototype image into a 3D-printable fridge magnet model.

Creative Lab Fridge Magnet build model preview — Build model preview

Parametri

Name
input_task_id
Type
string
Obbligatorio
Description
L'ID del task di prototipo da costruire. Deve essere un task creato dal tuo account con POST /openapi/creative-lab/fridge-magnet/v1/prototype, con stato SUCCEEDED.
Un ID che non corrisponde a uno dei tuoi task di prototipo Fridge Magnet dall'API restituisce 404, incluso un prototipo creato nell'app web.
Name
name
Type
string
Description
Un nome per il task, fino a 100 caratteri. Viene restituito nel campo name del task. Un nome più lungo restituisce 400.

`options`

Impostazioni opzionali per la forma del rilievo. Ogni campo ha un valore predefinito, quindi invia solo quelli che vuoi modificare. Un valore fuori dall'intervallo di un campo restituisce 400.

Name
badge_shape
Type
string
predefinito rounded-rect
Description
Il contorno del magnete quando Meshy non lo traccia dal soggetto. Meshy lo usa quando remove_background è false, oppure quando non riesce a trovare il contorno del soggetto.
Valori disponibili:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
predefinito 60
Description
La lunghezza del lato del quadrato di delimitazione del magnete, in millimetri, fino a 400. 0 usa il valore predefinito.
Name
relief_height_mm
Type
number
predefinito 3.3
Description
L'altezza massima del rilievo sopra la base, in millimetri, da 0 a 20.
Name
relief_offset_mm
Type
number
predefinito 0
Description
Di quanto abbassare il rilievo, in millimetri, da 0 a 20. Meshy lo sottrae dall'altezza del rilievo ovunque, fino alla base.
Name
base_thickness_mm
Type
number
predefinito 2.0
Description
Lo spessore della base piatta dietro il rilievo, in millimetri, da 0 a 20. La base predefinita di 2 mm dà al magnete abbastanza corpo per aderire al frigo, così il rilievo non risulta fragile.
Name
has_closed_back
Type
boolean
predefinito true
Description
Se chiudere il retro del magnete, il lato su cui incolli il magnete. false lascia il retro aperto, come un guscio.
Name
relief_curve
Type
string
predefinito linear
Description
La curva che mappa i valori della depth-map sull'altezza del rilievo.
Valori disponibili:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
predefinito 1.0
Description
L'intensità della curva, fino a 10. Le curve gamma e s-curve lo usano, mentre linear lo ignora. 0 usa il valore predefinito.
Name
invert_depth
Type
boolean
predefinito false
Description
Se invertire la depth map, in modo che le aree più scure diventino rilievo più alto.
Name
smoothing
Type
number
predefinito 0.24
Description
Quanto smussare la depth map prima che Meshy costruisca il rilievo, da 0 a 10.
Name
relief_scale
Type
number
predefinito 1.0
Description
Quanto ingrandire il rilievo e la sua texture all'interno del contorno, rispetto al centro, fino a 10. Un valore superiore a 1 ingrandisce il soggetto, e un valore inferiore a 1 lo riduce. Non modifica l'altezza del rilievo. 0 usa il valore predefinito.
Name
depth_threshold
Type
number
predefinito 0.1
Description
Il valore della depth map al di sotto del quale Meshy imposta la profondità a zero, da 0 a 1.
Name
remove_background
Type
boolean
predefinito true
Description
Se tracciare il contorno del magnete dal soggetto, in modo che il magnete segua la forma del soggetto. false usa invece il contorno badge_shape. Meshy usa anche badge_shape quando non riesce a trovare il contorno del soggetto.
Questo è separato dal parametro remove_background del prototipo, che imposta se l'immagine del prototipo ha uno sfondo trasparente.
Name
export_resolution
Type
integer
predefinito 512
Description
La risoluzione della mesh del modello esportato, da 64 a 512. Meshy costruisce la geometria da una depth map di 512 pixel, quindi una mesh più fine aggiungerebbe facce senza aggiungere dettaglio. 0 usa il valore predefinito.

`output`

Opzionale. Imposta il formato file restituito dalla build.

Name
format
Type
string
predefinito glb
Description
Il formato file restituito dalla build.
Valori disponibili:
- glb: un file model.glb, in model_urls.glb
- obj: un file zip con model.obj, model.mtl e texture.png, in model_urls.obj
- zip: un file zip con tutti i file generati da Meshy, in model_urls.bundle_zip

Restituisce

Il campo result contiene l'ID del nuovo task di build. Recupera il task o seguilo in streaming finché status non è SUCCEEDED. Poi scarica il file dall'unica voce in model_urls.

Modalità di errore

Name
400 - Bad Request
Description
La richiesta non può essere eseguita. Ad esempio:
- input_task_id manca o non è un ID task valido.
- Lo stato del task di prototipo non è SUCCEEDED. Se è ancora in esecuzione, attendi e riprova. Se è fallito o è stato annullato, crea un nuovo task di prototipo.
- Il task di prototipo è riuscito ma non ha alcuna immagine. Crea un nuovo task di prototipo.
- Un campo options è fuori dall'intervallo consentito o non è un valore disponibile.
Il messaggio di errore indica quale problema ha trovato.
Name
401 - Unauthorized
Description
La chiave API manca o non è valida. Controlla l'header Authorization.
Name
402 - Payment Required
Description
Si applica uno di questi casi:
- L'account non ha crediti sufficienti.
- La chiave API, lo spazio di lavoro o il membro ha raggiunto il proprio limite di crediti.
- L'account è nel piano gratuito.
Controlla i tuoi crediti e il piano, quindi riprova.
Name
404 - Not Found
Description
input_task_id non corrisponde a nessun task di prototipo Fridge Magnet creato dal tuo account con l'API. Anche un prototipo creato nell'app web restituisce 404. Invia l'ID result dalla risposta di creazione del prototipo.
Name
429 - Too Many Requests
Description
È stato raggiunto uno di questi limiti:
- Hai inviato più richieste di quante ne consenta il tuo limite di frequenza. Attendi qualche secondo, poi riprova. Vedi Limiti di frequenza.
- Troppi tuoi task sono in coda o in esecuzione. Attendi che alcuni terminino, poi riprova.
- Su un piano illimitato senza crediti rimanenti, hai raggiunto il numero di task eseguibili senza crediti. Attendi che un task termini, oppure aggiungi crediti.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Recupera un task Fridge Magnet

Restituisce un task di prototipo o di build. Il percorso deve corrispondere alla fase del task. Un task di build richiesto tramite /prototype/:id restituisce 404, e lo stesso vale per un task di prototipo richiesto tramite /build/:id.

Per i campi, vedi L'oggetto task di prototipo Fridge Magnet e L'oggetto task di build Fridge Magnet.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametri

Name
id
Type
path
Description
L'ID del task dalla risposta di creazione.

Restituisce

L'oggetto task di prototipo o l'oggetto task di build, corrispondente alla fase indicata nel percorso.

Modalità di errore

Name
400 - Bad Request
Description
id non è un ID di task valido. Invia l'ID result dalla risposta di creazione.
Name
403 - Forbidden
Description
Il tuo team ha attivato il Filtro IP, e Meshy ha segnalato l'immagine del task di prototipo per proprietà intellettuale di terzi. I task di build e i team con il piano Enterprise non ricevono questo errore. Crea un task di prototipo da un'immagine di cui possiedi i diritti d'uso.
Name
404 - Not Found
Description
Nessun task Fridge Magnet con questo ID appartiene al tuo account, oppure la fase del task non corrisponde al percorso. Controlla l'ID e usa /prototype o /build in base al task.
Name
500 - Internal Server Error
Description
Meshy non è riuscito a eseguire il controllo sulla proprietà intellettuale. Riprova la richiesta.

DELETE/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Elimina un task di magnete da frigo

Annulla un task di magnete da frigo. Annullare un task PENDING rimborsa i relativi crediti. Un task IN_PROGRESS viene annullato senza rimborso, perché un worker lo ha già avviato. Un task con uno stato finale (SUCCEEDED, FAILED o CANCELED) non può essere annullato.

Il percorso deve corrispondere alla fase del task. Ad esempio, DELETE su /prototype/:id con l'ID di un task di build restituisce 404.

Request

DELETE

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

Parametri del percorso

Name
id
Type
path
Description
L'ID del task da annullare.

Restituisce

204 No Content con un corpo vuoto.

Modalità di errore

Name
400 - Bad Request
Description
Si applica una delle seguenti condizioni:
- id non è un ID di task valido. Invia l'ID result dalla risposta di creazione.
- Il task ha già uno stato finale (SUCCEEDED, FAILED o CANCELED), quindi non può essere annullato.
Name
404 - Not Found
Description
Nessun task di magnete da frigo con questo ID appartiene al tuo account, oppure la fase del task non corrisponde al percorso. Controlla l'ID e usa /prototype o /build per far corrispondere il task.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id/stream

Esegui lo streaming di un task Fridge Magnet

Trasmette in streaming gli aggiornamenti di un task Fridge Magnet come Server-Sent Events (SSE). Il percorso deve corrispondere alla fase del task. In caso contrario, ad esempio l'ID di un task build in /prototype/:id/stream, lo stream invia un evento error con status_code: 404 e si chiude.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametri

Name
id
Type
path
Description
L'ID del task dalla risposta di creazione.

Restituisce

Uno stream di oggetti task prototype o build. Ogni evento contiene l'oggetto task completo, così come restituito da Recupera un task Fridge Magnet. Mentre il task è PENDING o IN_PROGRESS, i suoi campi di output sono ancora vuoti (null, [] o {}), e finished_at è null.

Se il filtraggio IP blocca il risultato del task, lo stream invia al suo posto un evento error, con lo status_code che una richiesta get restituirebbe.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)

Elenco dei task Fridge Magnet

Restituisce i tuoi task magnete da frigo di una fase, una pagina alla volta. Il percorso seleziona la fase. /prototype restituisce solo i task di prototipo, mentre /build restituisce solo i task di build.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Parametri del percorso

Name
stage
Type
path
Obbligatorio
Description
La fase da elencare, prototype o build.

Parametri della query

Name
page_num
Type
integer
predefinito 1
Description
La pagina da restituire, da 1 a 255. 0 restituisce la prima pagina. Un valore fuori dall'intervallo 0-255 restituisce 400.
Name
page_size
Type
integer
predefinito 10
Description
Numero di task per pagina, fino a 100. Un valore da 101 a 255 restituisce 100 task, e 0 utilizza il valore predefinito. Un valore fuori dall'intervallo 0-255 restituisce 400.
Name
sort_by
Type
string
predefinito -created_at
Description
L'ordine di ordinamento.
Valori disponibili:
- -created_at: prima i più recenti
- +created_at: prima i più vecchi

Valori restituiti

Un array di oggetti task di prototipo o oggetti task di build, corrispondenti alla fase indicata nel percorso.

L'oggetto task prototype del magnete da frigo

Un task prototype genera un'immagine concettuale colorizzata a partire da una foto. Per trasformare l'immagine in un modello 3D, passa l'ID del task all'endpoint build come input_task_id.

Proprietà

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
L'ID del task. Non fare affidamento sul suo formato.
Name
type
Type
string
Description
Il tipo di task, sempre creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
Il name che hai inviato quando hai creato il task, oppure "" se non ne hai inviato uno.
Name
status
Type
string
Description
Lo stato del task.
Valori disponibili:
- PENDING: in attesa in coda
- IN_PROGRESS: generazione del risultato in corso
- SUCCEEDED: finale, con il risultato
- FAILED: finale, con il motivo in task_error
- CANCELED: finale, senza risultato
Name
progress
Type
integer
Description
Percentuale del lavoro completato, da 0 a 100. È 0 finché il task non inizia e 100 quando ha successo.
Name
created_at
Type
timestamp
Description
Momento in cui il task è stato creato, in millisecondi Unix.
Name
started_at
Type
timestamp
Description
Momento in cui un worker ha avviato il task, in millisecondi Unix. null fino ad allora.
Name
finished_at
Type
timestamp
Description
Momento in cui il task ha raggiunto uno stato finale, in millisecondi Unix. null fino ad allora.
Name
expires_at
Type
timestamp
Description
Momento in cui il risultato del task scade, in millisecondi Unix. È 3 giorni dopo finished_at, oppure 3 giorni dopo created_at finché il task non termina. Per gli account Enterprise, che conservano i risultati delle API a tempo indeterminato, è circa 100 anni dopo. Consulta Conservazione degli asset.
Name
preceding_tasks
Type
integer
Description
La posizione del task in coda mentre è PENDING. 1 significa che partirà come prossimo. 0 dopo che il task lascia la coda, e sempre 0 nei risultati di elenco.
Name
task_error
Type
object
Description
Il motivo per cui il task è fallito. null a meno che status non sia FAILED. Consulta Errori.
Name
consumed_credits
Type
integer
Description
Numero di crediti addebitati per il task, dopo eventuali rimborsi. Una richiesta che restituisce un errore non viene addebitata. Un task fallito è 0, perché Meshy lo rimborsa. L'annullamento rimborsa un task solo mentre è PENDING. Se Meshy non riesce a leggere l'addebito, una risposta get o stream omette il campo, e una richiesta di elenco restituisce 500. In quel caso, riprova la richiesta.
Name
image_urls
Type
array of strings
Description
URL di download per l'immagine concettuale. L'array contiene un URL dopo che il task ha successo, ed è vuoto fino ad allora.

L'oggetto build task del magnete da frigo

Un build task genera il magnete da frigo 3D a partire da un prototype task riuscito. Restituisce un file modello nel formato richiesto.

Proprietà

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
L'ID del task. Non fare affidamento sul suo formato.
Name
type
Type
string
Description
Il tipo di task, sempre creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
Il name inviato alla creazione del task, oppure "" se non ne hai inviato uno.
Name
status
Type
string
Description
Lo stato del task.
Valori disponibili:
- PENDING: in attesa in coda
- IN_PROGRESS: generazione del risultato in corso
- SUCCEEDED: finale, con il risultato
- FAILED: finale, con il motivo in task_error
- CANCELED: finale, senza risultato
Name
progress
Type
integer
Description
Percentuale di lavoro completato, da 0 a 100. È 0 finché il task non inizia ed è 100 quando ha esito positivo.
Name
created_at
Type
timestamp
Description
Momento in cui il task è stato creato, in millisecondi Unix.
Name
started_at
Type
timestamp
Description
Momento in cui un worker ha avviato il task, in millisecondi Unix. null fino a quel momento.
Name
finished_at
Type
timestamp
Description
Momento in cui il task ha raggiunto uno stato finale, in millisecondi Unix. null fino a quel momento.
Name
expires_at
Type
timestamp
Description
Momento in cui il risultato del task scade, in millisecondi Unix. È 3 giorni dopo finished_at, oppure 3 giorni dopo created_at finché il task non termina. Per gli account Enterprise, che conservano i risultati delle API a tempo indeterminato, è circa 100 anni dopo. Consulta Conservazione degli asset.
Name
preceding_tasks
Type
integer
Description
La posizione del task in coda mentre è PENDING. 1 significa che parte come prossimo. 0 dopo che il task lascia la coda, e sempre 0 nei risultati degli elenchi.
Name
task_error
Type
object
Description
Il motivo per cui il task è fallito. null a meno che status non sia FAILED. Consulta Errori.
Name
consumed_credits
Type
integer
Description
Numero di crediti addebitati per il task, dopo eventuali rimborsi. Una richiesta che restituisce un errore non viene addebitata. Un task fallito è 0, perché Meshy lo rimborsa. L'annullamento rimborsa un task solo mentre è PENDING. Se Meshy non riesce a leggere l'addebito, una risposta get o stream omette il campo, e una richiesta di elenco restituisce 500. In tal caso, riprova la richiesta.
Name
model_urls
Type
object
Description
URL di download per il file modello, con una voce per il output.format richiesto. {} finché il task non ha esito positivo.
- Name
  glb
  Type
  string
  Description
  URL di download per il file GLB. Presente quando output.format è glb.
- Name
  obj
  Type
  string
  Description
  URL di download per un file zip con model.obj, model.mtl e texture.png. Presente quando output.format è obj.
- Name
  bundle_zip
  Type
  string
  Description
  URL di download per un file zip con tutti i file generati da Meshy. Presente quando output.format è zip.