Flera bilder till 3D API är en funktion som tillåter dig att integrera Meshys Flera bilder till 3D-kapabiliteter i din egen applikation. I denna sektion hittar du all information du behöver för att komma igång med detta API.
Denna endpoint tillåter dig att skapa en ny Flera bilder till 3D-uppgift. Se
Multi-Image to 3D Task Object för att se vilka
egenskaper som inkluderas med objektet Multi-Image to 3D Task.
Parametrar
Endast en av input_task_id eller image_urls är obligatorisk. Om båda ges prioriteras input_task_id.
Name
input_task_id
Type
string
Obligatorisk
Description
ID för en slutförd bildgenereringsuppgift vars utdata (1-4 bilder) ska användas som indatan. Denna uppgift måste vara en av följande: 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
Tillhandahåll 1 till 4 bilder för Meshy att använda vid modellskapande. Vi stödjer för närvarande formaten .jpg, .jpeg och .png. Alla bilder bör föreställa samma objekt från olika vinklar för bästa resultat.
Det finns två sätt att tillhandahålla varje bild:
Offentligt tillgänglig URL: En URL som är tillgänglig från det offentliga internet.
Data URI: En base64-kodad data URI av bilden. Exempel på en data URI: data:image/jpeg;base64,<dina base64-kodade bilddata>.
För meshy-7 (eller latest) används den första bilden som primär (frontal) vy. Ordningen på de återstående bilderna spelar ingen roll.
Name
ai_model
Type
string
standard latest
Description
ID för modellen att använda. Tillgängliga värden: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
should_texture
Type
boolean
standard true
Description
Bestämmer om texturer skapas. Om den ställs in på false hoppas texturfasen över, och en nätmodell utan texturer ges.
Gäller endast när should_texture = true
Name
enable_pbr
Type
boolean
standard false
Description
Generera PBR-mappar (metallisk, råhet, normal) utöver grundfärgen. En emissionskarta inkluderas också när ai_model är meshy-6, utom vid texture_resolution: 8k. meshy-7 och latest producerar inte en emissionskarta.
Name
texture_resolution
Type
string
standard 2k
Description
Grundfärgtexturens upplösning. En av 2k (2048×2048), 4k (4096×4096) eller 8k (8192×8192). Högre upplösningar fångar mer ytdetaljer.
4k och 8k kräver ai_modelmeshy-6, meshy-7 eller latest. Vid 8k produceras ingen emissionskarta.
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 är inställda tar texture_resolution företräde.
Name
texture_prompt
Type
string
Description
Ge en textprompt för att styra textureringsprocessen. Max 600 tecken.
Name
texture_image_url
Type
string
Description
Tillhandahåll en 2D-bild för att styra textureringsprocessen. Vi stödjer för närvarande formaten .jpg, .jpeg och .png.
Det finns två sätt att tillhandahålla bilden:
Offentligt tillgänglig URL: En URL som är tillgänglig från det offentliga internet.
Data URI: En base64-kodad data URI av bilden. Exempel på en data URI: data:image/jpeg;base64,<dina base64-kodade bilddata>
Bildtexturering kan inte fungera optimalt om det finns betydande geometrisk skillnad 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 parametrar ges, kommer texture_prompt att användas för att texturera modellen som standard.
Name
should_remesh
Type
boolean
standard false (meshy-6), true (others)
Description
Kontrollerar om remesh-fasen ska möjliggöras. För den högsta kvalitetsmodellen rekommenderar vi att sätta should_remesh till false.
Gäller endast när should_remesh = true
Name
topology
Type
string
standard triangle
Description
Ange topologin på den genererade modellen.
Tillgängliga värden:
quad: Generera en fyrkantigt dominant nät.
triangle: Generera ett decimerat triangelnät.
Name
target_polycount
Type
integer
standard 30,000
Description
Ange det önskade antalet polygoner i den genererade modellen. Det faktiska antalet polygoner kan avvika från målet beroende på komplexiteten hos geometrin.
Det giltiga värdeintervallet varierar beroende på användarnivån:
100 till 300,000 (inklusive)
Name
decimation_mode
Type
integer
Description
Aktivera adaptiv decimering genom att ställa in en nivå för polygonantal. När den är inställd ignoreras target_polycount.
Tillgängliga värden:
1: Adaptiv — ultra polygonantal.
2: Adaptiv — högt polygonantal.
3: Adaptiv — medel polygonantal.
4: Adaptiv — lågt polygonantal.
Name
save_pre_remeshed_model
Type
boolean
standard false
Description
När den sätts till true, sparar Meshy också en extra GLB-fil innan remesh-fasen avslutas.
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: Inget symmetribeteende.
auto: Bestämmer och tillämpar symmetri automatiskt baserat på indata-geometri.
on: Tvingar fram symmetri under generering.
Name
pose_mode
Type
string
standard ""
Description
Ange posläget för den genererade modellen.
Tillgängliga värden:
a-pose: Generera modellen i ett A-nyp.
t-pose: Generera modellen i ett T-nyp.
"" (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 ett A/T-pose.
Name
image_enhancement
Type
boolean
standard true
Description
Optimerar indata bilderna för bättre resultat. Ställ in på false för att bevara det exakta utseendet på indata bilderna utan någon stilbehandling.
Endast stöd när ai_model är meshy-6, meshy-7 eller latest.
Name
remove_lighting
Type
boolean
standard true
Description
Tar bort ljuseffekter och skuggor från grundfärgtexturen, vilket ger ett renare resultat som fungerar bättre under anpassade ljusinställningar.
Endast stöd när ai_model är ‘meshy-6’, ‘meshy-7’ eller ‘latest’.
Name
moderation
Type
boolean
standard false
Description
När den är inställd på true kommer innehållet att automatiskt genomgå en kontroll för potentiellt skadligt innehåll. Om skadligt innehåll får påträffas kommer uppgiften inte att fortsättas till generering.
Varje bild från image_urls och texten från texture_prompt kommer att skannas.
Name
target_formats
Type
string[]
Description
Anger vilka 3D-filformat som ska inkluderas i utmatningen. Endast de begärda formaten kommer att genereras och returneras, vilket kan minska uppgiftens slutförande tid.
När den inte anges genereras alla format utom 3mf. 3mf inkluderas endast när den anges explicit.
Name
auto_size
Type
boolean
standard false
Description
När den är inställd på true använder tjänsten AI-vision för att automatiskt uppskatta objektets faktiska höjd och ändra storleken på modellen därefter. Origin kommer att anges till bottom såvida inte origin_at anges explicit.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När den är inställd till true renderar uppgiften dessutom en transparent bakgrund (RGBA) version av förhandsvisningen och returnerar den som alpha_thumbnail_url på GET svaret. Det befintliga thumbnail_url fältet förblir oförändrat.
Name
multi_view_thumbnails
Type
boolean
standard false
Description
När den är inställd till true renderar uppgiften dessutom fyra kardinalvy miniatyrbilder (front, right, back, left) och returnerar dem under thumbnail_urls på GET-svaret. Det befintliga thumbnail_url-fältet förblir oförändrat och pekar fortfarande på frontvyn, så befintliga klienter påverkas inte.
Lägger till cirka 3 sekunder till uppgiftens latens.
Gäller endast när auto_size = true
Name
origin_at
Type
string
standard bottom
Description
Position för origo när auto_size är aktiverat. Tillgängliga värden: bottom, center.
Returnerar
result-egenskapen av svaret innehåller uppgiftens id för den nyskapade Flera bilder till 3D-uppgiften.
Felaktiga lägen
Name
400 - Bad Request
Description
Begäran var oacceptabel. Vanliga orsaker:
Saknad parameter: Antingen image_urls eller input_task_id måste anges.
Ogiltig indatauppgift: input_task_id måste hänvisa till en SUCCEEDED-uppgift Text till Bild, Bild till Bild eller någon variant av multi-vy.
Ogiltig bildantal: image_urls måste innehålla mellan 1 och 4 bilder.
Ogiltigt bildformat: En eller flera bilder i image_urls stöds inte.
Oåtkomlig URL: En eller flera image_urls kunde inte laddas ner.
Name
401 - Unauthorized
Description
Autentisering misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckliga credits för att utföra denna uppgift.
Name
429 - För många förfrågningar
Description
Du har överskridit din hastighetsgräns.
Begäran
POST
/openapi/v1/multi-image-to-3d
# Enkel begärancurlhttps://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>" ] }'# Med PBR-texturering och 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>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Denna endpoint tillåter dig att hämta en flera bilder till 3D-uppgift given en giltig uppgift id.
Se Multi-Image to 3D Task Object för att se vilka
egenskaper som inkluderas med objektet Multi-Image to 3D Task.
Parametrar
Name
id
Type
path
Description
Unik identifierare för den flera bilder till 3D-uppgift som ska hämtas.
Returnerar
Svaret innehåller Multi-Image to 3D-uppgiftsobjektet. Kontrollera
Multi-Image to 3D Task Object-sektionen för detaljer.
Flera bilder till 3D Uppgiftsobjekt är en arbetsenhet som Meshy håller reda på för att generera en 3D-modell från flera bilder (mellan 1 till 4 inklusive). Bilderna bör vara av samma objekt, helst 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-sortabel UUID för uppgifts-id:n som en implementationsdetalj, bör du inte göra några antaganden om formatet på id.
Name
type
Type
string
Description
Typ av Flera bilder till 3D-uppgiften. 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 kommer att utelämnas om formatet inte genereras 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 är närvarande.
Name
stl
Type
string
Description
Nedladdningsbar URL till STL-filen.
Name
3mf
Type
string
Description
Nedladdningsbar URL till 3MF-filen. Endast närvarande när 3mf begärdes via target_formats.
Name
pre_remeshed_glb
Type
string
Description
Nedladdningsbar URL till den ursprungliga GLB-utdata innan remeshing.
Tillgänglig endast 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 modelfilen. Motsvarar thumbnail_urls.front närvarande, hålls för bakåtkompatibilitet.
Name
alpha_thumbnail_url
Type
string
Description
Nedladdningsbar URL till en transparent bakgrund (RGBA) version av thumbnail_url. Endast närvarande när uppgiften skapades med alpha_thumbnail: true och den transparenta förhandsvisningen lyckades renderas; annars utelämnas detta fält.
Name
thumbnail_urls
Type
object
Description
Nedladdningsbara URL:er för fyra kardinalvyer av den genererade 3D-modellen. Varje värde är en signerad URL till en 512×512 PNG renderad med samma material och belysning som thumbnail_url. Användbar för att förhandsgranska modellen från flera vinklar i batchpipeline utan att ladda ner GLB.
Endast närvarande när uppgiften skapades med multi_view_thumbnails: true och har nått SUCCEEDED. Äldre uppgifter och uppgifter skapade utan opt-in kommer inte inkludera detta fält.
Name
front
Type
string
Description
Frontvy, 0° rotation runt den vertikala axeln (matchar thumbnail_url).
Name
right
Type
string
Description
Höger vy, 90° rotation.
Name
back
Type
string
Description
Bakvy, 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
progress
Type
integer
Description
Framsteget av uppgiften. Om uppgiften inte har påbörjats än kommer denna egenskap vara 0. När uppgiften lyckats, kommer detta bli 100.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när uppgiften startade, i millisekunder. Om uppgiften inte har startat än kommer denna egenskap vara 0.
En tidsstämpel representerar antalet millisekunder som förflutit sedan den 1 januari 1970 UTC, i enlighet med
RFC 3339 standard.
Till exempel, fredag den 1 september 2023 kl. 12:00:00 GMT representeras 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 uppgiftsresultatet löper ut, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften inte har avslutats än, kommer denna egenskap vara 0.
Name
status
Type
string
Description
Status för uppgiften. Möjliga värden är en av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
En matris av textur-URL-objekt som genereras från uppgiften. Normalt innehåller denna matris endast en textur-URL-objekt. Varje textur-URL har följande egenskaper:
Name
base_color
Type
string
Description
Nedladdningsbar URL till basfärgens kartbild.
Name
metallic
Type
string
Description
Nedladdningsbar URL till den metalliska kartbilden.
Om uppgiften är skapad med enable_pbr: false utelämnas denna egenskap.
Name
normal
Type
string
Description
Nedladdningsbar URL till normalmap-bilden.
Om uppgiften är skapad med enable_pbr: false utelämnas denna egenskap.
Name
roughness
Type
string
Description
Nedladdningsbar URL till råhetens kartbild.
Om uppgiften är skapad med enable_pbr: false utelämnas denna egenskap.
Name
emission
Type
string
Description
Nedladdningsbar URL till emissionsbildens kartbild.
Om uppgiften är skapad med enable_pbr: false eller ai_model är meshy-5, utelämnas denna egenskap.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Värdet av detta fält är betydelsefullt endast om uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Felfakta för misslyckade uppgifter. Se Errors för hela referensen av task_error-objektet.
Name
consumed_credits
Type
integer
Description
Antalet cr uxcon betänk tas i uppgiften. Närvarande när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (krediter återbetalas vid misslyckande).