Förvandla dina foton till anpassade kylskåpsmagneter — en färglagd
djupreliefbild i rundad rektangelform med en platt magnetisk baksida,
anpassad för kylskåpet — i två steg: prototype genererar en färglagd
konceptbild från din inmatade bild, sedan omvandlar build den
konceptbilden till en relief-3D-modell. De två stegen länkas samman via
input_task_id.
POST /openapi/creative-lab/fridge-magnet/v1/prototype
Genererar en enda färglagd konceptbild från källfotot. Uppgifts-ID:t som
returneras är det du skickar som input_task_id till build-endpointen. Se
The Fridge Magnet Prototype Task Object
för svarets form.
Parametrar
Name
image_url
Type
string
Obligatorisk
Description
Källfoto som Meshy ska färglägga till en konceptbild redo för kylskåpsmagnet. Vi stöder för närvarande formaten .jpg, .jpeg, .png och .webp.
Det finns två sätt att tillhandahålla bilden:
Publikt tillgänglig URL: En URL som är tillgänglig från det öppna internet.
Data URI: En base64-kodad data-URI för bilden. Exempel på en data-URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Valfritt uppgiftsnamn för visningsändamål. Max 100 tecken.
Name
remove_background
Type
boolean
standard false
Description
När detta anges till true returneras prototypbilden som en transparent RGBA-PNG med bakgrunden borttagen, så att du kan sammanfoga motivet med valfri bakgrund.
Detta styr endast bilden som denna endpoint returnerar. Det är separat från build-alternativet med samma namn (standard true), som styr bakgrundsborttagning innan reliefbearbetning.
Returer
Egenskapen result i svaret innehåller uppgifts-id:t för den nyligen skapade kylskåpsmagnet-prototypuppgiften. Fråga Get a Task-endpointen eller prenumerera på stream tills uppgiften når SUCCEEDED, och skicka sedan det ID:t till build-endpointen som input_task_id.
Felfall
Name
400 - Bad Request
Description
Begäran kunde inte accepteras. Vanliga orsaker:
Saknad parameter: image_url krävs.
Ogiltigt bildformat: Den angivna image_url har inte ett format som stöds (.jpg, .jpeg, .png, .webp).
Bilddimensioner utanför intervallet: Bilden är för liten, överskrider maximal filstorlek eller överskrider maximalt antal pixlar.
Onåbar URL: image_url kunde inte laddas ner (404 eller timeout).
Ogiltig Data URI: Base64-strängen är felaktigt utformad.
Innehåll flaggat: Den angivna bilden flaggades av moderation för NSFW eller immateriella rättigheter.
Name
401 - Unauthorized
Description
Autentiseringen misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckligt med credits för att utföra denna uppgift.
Name
429 - Too Many Requests
Description
Du har överskridit din hastighetsgräns.
Request
POST
/openapi/creative-lab/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/fridge-magnet/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>" }'
Response
{"result":"01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
Genererar den slutgiltiga 3D-utskrivbara kylskåpsmagneten från en lyckad
prototyp-uppgift. Byggprocessen kör en pipeline för höjdkartsrelief på
prototypens färglagda konceptbild och levererar en enda nät-artefakt i
det format du begär. Se
The Fridge Magnet Build Task Object för
svarets struktur.
Parametrar
Name
input_task_id
Type
string
Obligatorisk
Description
Uppgifts-ID för en prototypuppgift skapad via samma OpenAPI-endpoint. Prototypen måste ha skapats med samma API-nyckel, måste ha nått SUCCEEDED, och måste ha producerat exakt en kandidatbild.
Prototypuppgifter skapade via webappen accepteras inte — byggändpunkten accepterar endast prototypuppgifter som producerats av POST /openapi/creative-lab/fridge-magnet/v1/prototype och avvisar alla andra källor med 404.
Name
name
Type
string
Description
Valfritt uppgiftsnamn för visningssyften. Maximalt 100 tecken.
options
Valfria justeringsparametrar för reliefgeometrin. Varje fält har ett förnuftigt standardvärde — skicka bara de du vill åsidosätta.
Name
badge_shape
Type
string
standard rounded-rect
Description
Konturform för kylskåpsmagneten. Tillgängliga värden:
circle
rounded-rect (standard)
hexagon
shield
star
Name
size_mm
Type
number
standard 60
Description
Sidlängd för den avgränsande kvadraten för kylskåpsmagneten, i millimeter. Intervall: (0, 400].
Name
relief_height_mm
Type
number
standard 3.3
Description
Maximal relieffhöjd ovanför basen, i millimeter. Intervall: [0, 20].
Name
relief_offset_mm
Type
number
standard 0
Description
Vertikal förskjutning som tillämpas på reliefen före extrudering, i millimeter. Intervall: [0, 20].
Name
base_thickness_mm
Type
number
standard 2.0
Description
Tjocklek på den platta baskonstruktionen bakom reliefen, i millimeter. Standardvärdet för kylskåpsmagneten är en robustare bas på 2 mm — det ger magneten tillräcklig kropp för att greppa kylskåpet utan att reliefen känns skör. Intervall: [0, 20].
Name
has_closed_back
Type
boolean
standard true
Description
Om baksidan av kylskåpsmagneten är förseglad som en sluten yta (sidan du limmar magneten på). Sätt till false för ett öppet skal.
Name
relief_curve
Type
string
standard linear
Description
Överföringskurva som mappar djupkartsvärden till relieffhöjd. Tillgängliga värden:
linear (standard)
gamma
s-curve
Name
curve_param
Type
number
standard 1.0
Description
Formparameter för överföringskurvan (endast meningsfull när relief_curve är gamma). Intervall: (0, 10].
Name
invert_depth
Type
boolean
standard false
Description
Inverterar tolkningen av djupkartan så att mörkare områden blir högre relief.
Name
smoothing
Type
number
standard 0.24
Description
Utjämningsstyrka som tillämpas på djupkartan innan reliefen extraheras. Intervall: [0, 10].
Name
relief_scale
Type
number
standard 1.0
Description
Vertikal skalfaktor som tillämpas utöver relief_height_mm. Intervall: (0, 10].
Name
depth_threshold
Type
number
standard 0.1
Description
Lågpassgräns för djupkartsvärden; allt under detta klipps av till noll. Intervall: [0, 1].
Name
remove_background
Type
boolean
standard true
Description
Tar automatiskt bort bakgrunden från prototypens konceptbild innan reliefen skapas.
Skild från prototypparametern med samma namn (standard false), som styr om själva prototypbilden returneras med transparens.
Name
export_resolution
Type
integer
standard 512
Description
Nätupplösning som används för export. Intervall: [64, 2048].
output
Valfri väljare för överföringsformat. Standardvärde är glb.
Name
format
Type
string
standard glb
Description
Artefaktpaket som returneras av byggåtgärden. Tillgängliga värden:
glb (standard) — returnerar en enda model.glb under model_urls.glb.
obj — zippar model.obj + model.mtl + texture.png och returnerar paketet under model_urls.obj.
zip — zippar varje artefakt som generatorn skapar och returnerar paketet under model_urls.bundle_zip.
Returer
result-egenskapen i svaret innehåller uppgifts-id för den nyskapade byggåtgärden för kylskåpsmagneten. Fråga Get a Task-ändpunkten eller prenumerera på stream tills uppgiften når SUCCEEDED, och ladda sedan ner artefakten från den enda posten i model_urls.
Felfall
Name
400 - Bad Request
Description
Begäran var oacceptabel. Vanliga orsaker:
Saknad parameter: input_task_id krävs.
Ogiltig UUID: input_task_id är inte en giltig UUID.
Överordnad uppgift ej lyckad: Den refererade prototypuppgiften har ännu inte nått SUCCEEDED.
Ingen kandidat: Prototypuppgiften lyckades men producerade ingen kandidatbild.
Alternativ utanför intervall: Ett av fälten i options låg utanför sitt tillåtna intervall eller enum-uppsättning.
Name
401 - Unauthorized
Description
Autentiseringen misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckligt med credits för att utföra denna uppgift.
Name
404 - Not Found
Description
Den refererade prototypuppgiften finns inte, tillhör en annan användare, eller skapades via webappen (endast prototypuppgifter i API-mode kan kedjas till en byggåtgärd).
Hämta en prototyp- eller bygguppgift givet ett giltigt uppgifts-id. URL-sökvägen
måste matcha uppgiftens steg — en bygguppgift som hämtas via
/prototype/:id returnerar 404, och vice versa.
Avbryt en kylskåpsmagnet-uppgift. Om uppgiften fortfarande är PENDING
återbetalas de credits som förbrukades vid skapandet. Uppgifter som redan
är IN_PROGRESS avbryts utan återbetalning (arbetaren kan redan förbruka
resurser). Uppgifter som redan har nått ett sluttillstånd
(SUCCEEDED, FAILED, CANCELED) kan inte avbrytas.
URL-sökvägen måste matcha uppgiftens steg — DELETE på
/prototype/:buildId returnerar 404.
Sökvägsparametrar
Name
id
Type
path
Description
Unik identifierare för den kylskåpsmagnet-uppgift som ska avbrytas.
Returer
Returnerar 204 No Content vid lyckat resultat med en tom body.
Felscenarier
Name
400 - Bad Request
Description
Uppgiften befinner sig redan i ett sluttillstånd och kan inte avbrytas.
Name
404 - Not Found
Description
Uppgiften finns inte, tillhör en annan användare, eller dess steg matchar inte URL-sökvägen.
Streama realtidsuppdateringar för en kylskåpsmagnet-uppgift via Server-Sent Events (SSE).
URL-sökvägen måste matcha uppgiftens steg — att öppna en ström vid
/prototype/:buildId/stream skickar en enda event: error-payload med
status_code: 404 och stänger strömmen.
Parametrar
Name
id
Type
path
Description
Unik identifierare för den kylskåpsmagnet-uppgift som ska streamas.
Returer
Returnerar en ström av Fridge Magnet Prototype
eller Fridge Magnet Build uppgiftsobjekt som
Server-Sent Events. Varje ram innehåller hela uppgiftsobjektet för steget — samma form som
Get-endpointen returnerar — så medan uppgiften är PENDING eller IN_PROGRESS är
utdatafälten helt enkelt inte ifyllda ännu (null, [] eller {}) och
finished_at är null.
// Error event example (wrong stage or task not found)event: errordata: {"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 PENDING frame below is abbreviated to the fields that change.event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","progress": 0,"status": "PENDING"}event: messagedata: {"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": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***" }}
Hämta en paginerad lista över dina kylskåpsmagnet-uppgifter för ett enskilt steg. URL-sökvägen
väljer steget — /prototype returnerar prototyp-uppgifter; /build
returnerar build-uppgifter. Uppgifter från det andra steget ingår inte i något av
svaren.
Sökvägsparametrar
Name
stage
Type
path
Obligatorisk
Description
Antingen prototype eller build. Samlingen returnerar endast uppgifter
vars steg matchar URL:en — att hämta /prototype returnerar aldrig
build-uppgifter och vice versa.
Frågeparametrar
Name
page_num
Type
integer
standard 1
Description
Sidnummer för paginering.
Name
page_size
Type
integer
standard 10
Description
Gräns för sidstorlek. Maximalt tillåtet är 100 objekt.
Name
sort_by
Type
string
standard -created_at
Description
Fält att sortera efter. Tillgängliga värden:
+created_at: Sortera efter skapelsetid i stigande ordning.
-created_at: Sortera efter skapelsetid i fallande ordning.
Fridge Magnet Prototype-uppgiftsobjektet är en arbetsenhet som Meshy håller reda på för att
generera en färglagd konceptbild från ett källfoto. Resultatet av
detta steg kedjas vidare till byggsteget
via input_task_id.
Egenskaper
Name
id
Type
string
Description
Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-id som implementationsdetalj bör du inte göra några antaganden om id:ts format.
Name
type
Type
string
Description
Uppgiftens typ. Värdet är creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
Uppgiftsnamnet som angavs när uppgiften skapades. Tom sträng om inget namn angavs.
Name
status
Type
string
Description
Uppgiftens status. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Uppgiftens progress. Om uppgiften ännu inte har startat kommer denna egenskap att vara 0. När uppgiften har lyckats blir den 100.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när uppgiften skapades, i millisekunder.
En tidsstämpel representerar antalet millisekunder som förflutit sedan 1 januari 1970 UTC, enligt
RFC 3339-standarden.
Till exempel representeras fredagen den 1 september 2023 kl. 12:00:00 GMT som 1693569600000. Detta gäller
för alla tidsstämplar i Meshy API.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften ännu inte har startat kommer denna egenskap att vara 0.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften ännu inte är avslutad kommer denna egenskap att vara 0.
Name
expires_at
Type
timestamp
Description
Tidsstämpel för när uppgiftens resultat upphör att gälla, i millisekunder.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Värdet i detta fält är endast meningsfullt om uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Felinformation för misslyckade uppgifter. Se Fel för den fullständiga referensen för task_error-objektet.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna uppgift. Finns när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).
Name
image_urls
Type
array of strings
Description
Nedladdningsbara URL:er för de konceptbildskandidater som genererats av denna prototypuppgift. För närvarande returnerar API:et alltid exakt en kandidat; fältet är en array så att framtida revisioner kan tillhandahålla flera kandidater utan en bakåtkompatibilitetsbrytande ändring.
Fridge Magnet-byggobjektet är en arbetsenhet som Meshy håller reda på för att
generera det slutgiltiga 3D-nätet för kylskåpsmagneten från en lyckad prototyp-task. Byggprocessen
kör en depth-map-relief-pipeline på prototypens konceptbild och
publicerar en enda nät-artefakt i det format som anroparen begärde.
Egenskaper
Name
id
Type
string
Description
Unik identifierare för tasken.
Name
type
Type
string
Description
Typ av task. Värdet är creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
Tasknamnet som angavs när tasken skapades. Tom sträng om inget namn angavs.
Name
status
Type
string
Description
Status för tasken. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Förlopp (progress) för tasken. Om tasken ännu inte har startat blir denna egenskap 0. När tasken har lyckats blir den 100.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när tasken skapades, i millisekunder.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när tasken startades, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när tasken avslutades, i millisekunder.
Name
expires_at
Type
timestamp
Description
Tidsstämpel för när taskresultatet upphör att gälla, i millisekunder.
Name
preceding_tasks
Type
integer
Description
Antalet föregående tasks. Endast meningsfullt när status är PENDING.
Name
task_error
Type
object
Description
Feldetaljer för misslyckade tasks. Se Fel för den fullständiga referensen för task_error-objektet.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna task. Returnerar 0 för FAILED-tasks (credits återbetalas vid misslyckande).
Name
model_urls
Type
object
Description
Nedladdningsbara URL:er för den genererade artefakten, med artefaktnamn som nyckel. Innehåller alltid exakt en post — formatet som begärdes via byggbegärans output.format. Nyckeln matchar det begärda formatet:
Name
glb
Type
string
Description
Nedladdningsbar URL till GLB-filen. Finns när output.format var glb (standardvärdet).
Name
obj
Type
string
Description
Nedladdningsbar URL till en zip-bunt som innehåller model.obj, model.mtl och texture.png. Finns när output.format var obj.
Name
bundle_zip
Type
string
Description
Nedladdningsbar URL till en zip-bunt med samtliga artefakter som generatorn producerar. Finns när output.format var zip.