Flera bilder till 3D API är en funktion som gör att du kan integrera Meshys funktioner för Flera bilder till 3D i din egen applikation. I det här avsnittet hittar du all information
du behöver för att komma igång med detta API.
Denna endpoint låter dig skapa en ny Flera bilder till 3D-uppgift. Se
Flera bilder till 3D-uppgiftsobjektet för att se vilka
egenskaper som ingår i Flera bilder till 3D-uppgiftsobjektet.
Parametrar
Endast en av input_task_id eller image_urls krävs. Om båda anges har input_task_id prioritet.
Name
input_task_id
Type
string
Obligatorisk
Description
ID:t för en slutförd bildgenereringsuppgift vars utdata (1–4 bilder) ska användas som indata. Denna uppgift måste vara en av följande uppgifter: Text till bild, Bild till bild, Text till bild Flervy, eller Bild till bild Flervy. Dessutom måste den ha körts via API:et och ha statusen SUCCEEDED.
Name
image_urls
Type
array
Obligatorisk
Description
Ange 1 till 4 bilder som Meshy ska använda för att skapa modellen. Vi stöder för närvarande formaten .jpg, .jpeg och .png. Alla bilder bör visa samma objekt från olika vinklar för bästa resultat.
Det finns två sätt att ange varje bild:
Publikt tillgänglig URL: En URL som är tillgänglig från det publika 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>.
För meshy-7.1 (eller latest) används den första bilden som primär (front) vy. Ordningen på de återstående bilderna spelar ingen roll.
Avgör om texturer genereras. Om det ställs till false hoppas texturfasen över, vilket ger ett nät utan texturer.
Gäller endast när should_texture = true
Name
enable_pbr
Type
boolean
standard false
Description
Generera PBR-mappar (metallic, roughness, normal) utöver grundfärgen. En emissionsmapp inkluderas också när ai_model är meshy-6, förutom vid texture_resolution: 8k. meshy-6-lite, meshy-7.1 och latest genererar ingen emissionsmapp.
Name
texture_resolution
Type
string
standard 2k
Description
Upplösning för grundfärgstexturen. En av 2k (2048×2048), 4k (4096×4096) eller 8k (8192×8192). Högre upplösningar fångar mer ytdetalj.
4k och 8k kräver ai_modelmeshy-6, meshy-7.1 eller latest. Vid 8k genereras ingen emissionsmapp.
Name
hd_texture
Type
boolean
⚠ föråldrad
standard false
Description
Använd texture_resolution istället — motsvarar texture_resolution: "4k". När båda anges har texture_resolution prioritet.
Name
texture_prompt
Type
string
Description
Ange en textprompt för att styra textureringsprocessen. Max 800 tecken.
Name
texture_image_url
Type
string
Description
Ange en 2d-bild för att styra textureringsprocessen. Vi stöder för närvarande formaten .jpg, .jpeg och .png.
Det finns två sätt att ange bilden:
Publikt tillgänglig URL: En URL som är tillgänglig från det publika 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>
Bildtexturering kan fungera suboptimalt om det finns betydande geometriska skillnader mellan den ursprungliga tillgången och den uppladdade bilden. Endast en av texture_image_url eller texture_prompt kan användas för att styra textureringsprocessen. Om båda parametrarna anges kommer texture_prompt som standard att användas för att texturera modellen.
Name
texture_image_urls
Type
string[]
Description
Ange 1 till 4 bilder som visar samma objekt från olika vinklar för att styra textureringen. Den första bilden är den primära (front) vyn; ordningen på de återstående vyerna (vänster, bak, höger) spelar ingen roll.
Varje element accepterar samma format som texture_image_url (en publikt tillgänglig URL eller en base64 data URI, .jpg/.jpeg/.png).
Dessa bilder styr endast texturen och är oberoende av image_urls — de två listorna kan innehålla olika bilder och olika antal bilder.
Kräver ai_modelmeshy-7.1 eller latest. Kan inte kombineras med texture_image_url eller texture_prompt.
Name
should_remesh
Type
boolean
standard false (Meshy 6 and Meshy 7 models), true (others)
Description
Styr om remesh-fasen ska aktiveras. För modellen med högst kvalitet rekommenderar vi att ställa in should_remesh till false.
Gäller endast när should_remesh = true
Name
topology
Type
string
standard triangle
Description
Ange topologin för den genererade modellen.
Tillgängliga värden:
quad: Generera ett quad-dominerat nät.
triangle: Generera ett decimerat triangelnät.
Name
target_polycount
Type
integer
standard 30,000
Description
Ange målantalet polygoner i den genererade modellen. Det faktiska antalet polygoner kan avvika från målet beroende på geometrins komplexitet.
Det giltiga värdeintervallet varierar beroende på användarnivå:
100 till 300 000 (inklusive)
Name
decimation_mode
Type
integer
Description
Aktivera adaptiv decimering genom att ange en polygonantalsnivå. När detta anges ignoreras target_polycount.
Tillgängliga värden:
1: Adaptiv — ultrahögt polygonantal.
2: Adaptiv — högt polygonantal.
3: Adaptiv — medelhögt polygonantal.
4: Adaptiv — lågt polygonantal.
Name
save_pre_remeshed_model
Type
boolean
standard false
Description
När detta ställs till true sparar Meshy även en extra GLB-fil innan remesh-fasen slutförts.
Name
symmetry_mode
Type
string
⚠ föråldrad
standard auto
Description
Föråldrad. Denna parameter påverkar inte längre utdata.
Fältet symmetry_mode styr symmetribeteendet under modellgenereringsprocessen.
De giltiga värdena är:
off: Inaktiverar symmetri.
auto: Avgör och tillämpar symmetri automatiskt baserat på inmatad geometri.
on: Framtvingar symmetri under genereringen.
Name
pose_mode
Type
string
standard ""
Description
Ange pose-mode för den genererade modellen.
Tillgängliga värden:
a-pose: Generera modellen i en A-pose.
t-pose: Generera modellen i en T-pose.
"" (tom sträng): Ingen specifik pose tillämpas.
Name
is_a_t_pose
Type
boolean
⚠ föråldrad
standard false
Description
Använd pose_mode istället. Om modellen ska genereras i en A/T-pose.
Name
image_enhancement
Type
boolean
standard true
Description
Optimerar indatabilderna för bättre resultat. Ställ till false för att bevara indatabildernas exakta utseende utan någon stilbearbetning.
Endast stödd när ai_model är meshy-6, meshy-7.1 eller latest.
Name
remove_lighting
Type
boolean
standard true
Description
Tar bort highlights och skuggor från grundfärgstexturen, vilket ger ett renare resultat som fungerar bättre under anpassade ljussättningar.
Endast stödd när ai_model är meshy-6, meshy-7.1 eller latest.
Name
moderation
Type
boolean
standard false
Description
När detta ställs till true kommer det inmatade innehållet automatiskt att granskas för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks kommer uppgiften inte att fortsätta till generering.
Varje bild från image_urls och texten från texture_prompt kommer att granskas.
Name
target_formats
Type
string[]
Description
Anger vilka 3D-filformat som ska ingå i utdata. Endast de begärda formaten genereras och returneras, vilket kan minska uppgiftens genomförandetid.
Om detta utelämnas genereras alla format förutom 3mf. 3mf inkluderas endast när det uttryckligen anges.
Name
auto_size
Type
boolean
standard false
Description
När detta ställs till true använder tjänsten AI-syn för att automatiskt uppskatta objektets höjd i verkligheten och ändrar modellens storlek därefter. Origo kommer som standard att vara bottom om inte origin_at uttryckligen anges.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När detta ställs till true renderar uppgiften dessutom en version av förhandsgranskningen med transparent bakgrund (RGBA) och returnerar den som alpha_thumbnail_url i GET-svaret. Det befintliga fältet thumbnail_url förblir oförändrat.
Name
multi_view_thumbnails
Type
boolean
standard false
Description
När detta ställs till true renderar uppgiften dessutom fyra kardinalvyer som miniatyrer (front, höger, bak, vänster) och returnerar dem under thumbnail_urls i GET-svaret. Det befintliga fältet thumbnail_url förblir oförändrat och pekar fortfarande på framvyn, så befintliga klienter påverkas inte.
Lägger till ungefär 3 sekunders latens för uppgiften.
Gäller endast när auto_size = true
Name
origin_at
Type
string
standard bottom
Description
Origos position när auto_size är aktiverat. Tillgängliga värden: bottom, center.
Returvärden
Egenskapen result i svaret innehåller uppgifts-id:t för den nyligen skapade Flera bilder till 3D-uppgiften.
Felläge
Name
400 - Bad Request
Description
Begäran var inte godtagbar. Vanliga orsaker:
Saknad parameter: Antingen image_urls eller input_task_id måste anges.
Ogiltig inmatningsuppgift: input_task_id måste peka på en SUCCEEDED Text till bild-, Bild till bild-, eller flervy-variantuppgift.
Ogiltigt antal bilder: image_urls måste innehålla mellan 1 och 4 bilder, och texture_image_urls mellan 1 och 4.
Ogiltigt bildformat: En eller flera bilder i image_urls har format som inte stöds.
Motstridiga texturindata: texture_image_urls kan inte kombineras med texture_image_url eller texture_prompt, och kräver should_texture: true.
Modell stöds inte för flervy-textur: texture_image_urls kräver ai_modelmeshy-7.1 eller latest.
Oåtkomlig URL: En eller flera element i image_urls eller texture_image_urls kunde inte laddas ner.
Upplösning stöds inte för flera bilder som indata: geometry_resolution: "4k" är inte tillgänglig för denna endpoint; använd 2k eller standard.
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/v1/multi-image-to-3d
# Simple requestcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ] }'# With Ultra 2K geometry, PBR texturing and GLB formatcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ], "ai_model": "meshy-7.1", "geometry_resolution": "2k", "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Denna endpoint gör det möjligt att hämta en Flera bilder till 3D-uppgift givet ett giltigt uppgifts-id.
Se The Multi-Image to 3D Task Object för att se vilka
egenskaper som ingår i objektet för Flera bilder till 3D-uppgiften.
Parametrar
Name
id
Type
path
Description
Unik identifierare för den Flera bilder till 3D-uppgift som ska hämtas.
Denna endpoint tar permanent bort en Flera bilder till 3D-uppgift, inklusive alla tillhörande modeller och data. Denna åtgärd är oåterkallelig.
Sökvägsparametrar
Name
id
Type
path
Description
ID:t för den Flera bilder till 3D-uppgift som ska tas bort.
Uppgiftsstatus
En uppgift som fortfarande är PENDING tas bort och de credits som
förbrukades vid skapandet återbetalas.
En uppgift som redan är IN_PROGRESS kan inte tas bort: begäran
avvisas med 409 Conflict och uppgiften fortsätter att köras. Credits för en uppgift
som arbetaren redan har påbörjat kan inte återbetalas, så att ta bort den mitt i körningen
skulle kosta dig både credits och resultatet. Vänta tills den når
SUCCEEDED, FAILED eller CANCELED, och ta sedan bort den.
En uppgift i ett slutgiltigt tillstånd (SUCCEEDED, FAILED eller CANCELED) tas bort
utan återbetalning.
Returer
Returnerar 200 OK vid lyckad borttagning, eller 409 Conflict när uppgiften är
IN_PROGRESS.
// 200 OK on success, with an empty body.//// 409 Conflict when the task is IN_PROGRESS — the task is left running:{"message":"Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."}
Multi-Image till 3D-uppgiftsobjektet är en arbetsenhet som Meshy håller reda på för att generera en 3d-modell från flera bilder (mellan 1 och 4 inklusive). Bilderna bör vara av samma objekt, ideellt från olika vyer eller vinklar.
Objektet har följande egenskaper:
Egenskaper
Name
id
Type
string
Description
Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-id:n som
implementationsdetalj bör du inte göra några antaganden om formatet på id:t.
Name
type
Type
string
Description
Typ av Multi-Image till 3D-uppgift. Värdet är multi-image-to-3d.
Name
model_urls
Type
object
Description
Nedladdningsbar URL till den texturerade 3D-modellfilen som genereras av Meshy. Egenskapen för ett format utelämnas om formatet inte genererats, istället för att returnera en tom sträng.
Name
glb
Type
string
Description
Nedladdningsbar URL till GLB-filen.
Name
fbx
Type
string
Description
Nedladdningsbar URL till FBX-filen.
Name
obj
Type
string
Description
Nedladdningsbar URL till OBJ-filen.
Name
usdz
Type
string
Description
Nedladdningsbar URL till USDZ-filen.
Name
mtl
Type
string
Description
Nedladdningsbar URL till MTL-filen, returneras tillsammans med OBJ-exporter när texturer finns.
Name
stl
Type
string
Description
Nedladdningsbar URL till STL-filen.
Name
3mf
Type
string
Description
Nedladdningsbar URL till 3MF-filen. Finns endast med när 3mf begärdes via target_formats.
Name
pre_remeshed_glb
Type
string
Description
Nedladdningsbar URL till den ursprungliga GLB-utdatan innan remeshning.
Endast tillgänglig när uppgiften skapades med både should_remesh: true och save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Nedladdningsbar URL till miniatyrbilden av modellfilen. Motsvarar thumbnail_urls.front när den finns, behålls för bakåtkompatibilitet.
Name
alpha_thumbnail_url
Type
string
Description
Nedladdningsbar URL till en version av thumbnail_url med transparent bakgrund (RGBA). Finns endast med när uppgiften skapades med alpha_thumbnail: true och den transparenta förhandsvisningen renderades korrekt; annars utelämnas detta fält.
Name
thumbnail_urls
Type
object
Description
Nedladdningsbara URL:er för fyra kardinalvy-miniatyrer av den genererade 3D-modellen. Varje värde är en signerad URL till en 512×512 PNG-bild renderad med samma material och belysning som thumbnail_url. Användbart för att förhandsgranska modellen från flera vinklar i batch-pipelines utan att ladda ner GLB-filen.
Finns endast med när uppgiften skapades med multi_view_thumbnails: true och har nått SUCCEEDED. Äldre uppgifter och uppgifter som skapats utan detta aktiverat kommer inte att inkludera detta fält.
Name
front
Type
string
Description
Framifrån-vy, 0° rotation kring den vertikala axeln (motsvarar thumbnail_url).
Name
right
Type
string
Description
Höger vy, 90° rotation.
Name
back
Type
string
Description
Bakifrån-vy, 180° rotation.
Name
left
Type
string
Description
Vänster vy, 270° rotation.
Name
texture_prompt
Type
string
Description
Textprompten som användes för att styra textureringsprocessen.
Name
texture_image_urls
Type
string[]
Description
Nedladdningsbara URL:er till texturreferensbilderna som användes för att skapa uppgiften, i den ordning de tillhandahölls. Finns endast med när uppgiften skapades med texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ föråldrad
Description
Föråldrad; läs geometry_resolution istället.
Name
geometry_resolution
Type
string
Description
Ultra-nivån uppgiften kördes på (2k); utelämnas för standard.
Name
progress
Type
integer
Description
Uppgiftens progress. Om uppgiften inte har startat ännu kommer denna egenskap att vara 0. När uppgiften har lyckats kommer detta att bli 100.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften inte har startat ännu kommer denna egenskap att vara 0.
En tidsstämpel representerar antalet millisekunder som förflutit sedan 1 januari 1970 UTC, enligt
standarden RFC 3339.
Till exempel representeras fredagen den 1 september 2023 12:00:00 GMT som 1693569600000. Detta gäller
för alla tidsstämplar i Meshy API.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när uppgiften skapades, i millisekunder.
Name
expires_at
Type
timestamp
Description
Tidsstämpel för när uppgiftens resultat upphör att gälla, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften slutfördes, i millisekunder. Om uppgiften inte är slutförd ännu kommer denna egenskap att vara 0.
Name
status
Type
string
Description
Uppgiftens status. Möjliga värden är en av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
En array med texturURL-objekt som genereras från uppgiften. Normalt innehåller denna endast ett texturURL-objekt. Varje texturURL har följande egenskaper:
Name
base_color
Type
string
Description
Nedladdningsbar URL till basfärgskartans bild.
Name
metallic
Type
string
Description
Nedladdningsbar URL till metallic-kartans bild.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
normal
Type
string
Description
Nedladdningsbar URL till normalmappens bild.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
roughness
Type
string
Description
Nedladdningsbar URL till roughness-kartans bild.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
emission
Type
string
Description
Nedladdningsbar URL till emission-kartans bild.
Om uppgiften skapas med enable_pbr: false, eller om ai_model är meshy-6-lite, utelämnas denna egenskap.
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 med när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).