Bild till 3D API är en funktion som låter dig integrera funktionerna för Bild till 3D i Meshy 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 Bild till 3D-uppgift. Se
Objektet Bild till 3D-uppgift för att se vilka
egenskaper som ingår i objektet Bild till 3D-uppgift.
Parametrar
Endast en av input_task_id eller image_url är obligatorisk. 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 ska användas som indatabild. Denna uppgift måste vara en av följande uppgifter: Text till bild eller Bild till bild. Dessutom måste den ha körts via API:t, ha statusen SUCCEEDED och producera exakt en bild.
Name
image_url
Type
string
Obligatorisk
Description
Tillhandahåll en bild som Meshy kan använda vid modellskapandet. Vi stöder för närvarande formaten .jpg, .jpeg och .png.
Det finns två sätt att tillhandahålla 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>.
Name
model_type
Type
string
standard standard
Description
Ange typen av 3D-nätgenerering.
Tillgängliga värden:
standard: Vanlig 3D-nätgenerering med hög detaljrikedom.
lowpoly: Genererar low-poly nät optimerat för renare polygoner.
När lowpoly väljs ignoreras ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model.
Name
ai_model
Type
string
standard latest
Description
ID för modellen som ska användas. Tillgängliga värden: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
standard true
Description
Avgör om texturer genereras. Om den sätts 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 basfärgen. En emission map ingår också när ai_model är meshy-6 eller latest.
Name
hd_texture
Type
boolean
standard false
Description
Generera basfärgstexturen i 4K-upplösning (4096×4096) för högre detaljrikedom.
Stöds endast när ai_model är meshy-6 eller latest. PBR-mappar genereras alltid i 2K.
Name
texture_prompt
Type
string
Description
Tillhandahåll 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öder för närvarande formaten .jpg, .jpeg och .png.
Det finns två sätt att tillhandahålla 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 kanske inte fungerar optimalt om det finns betydande geometriskillnader mellan den ursprungliga asseten och den uppladdade bilden. Endast en av texture_image_url eller texture_prompt får 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. Texturering via antingen text eller bild kostar 10 credits per uppgift.
Name
should_remesh
Type
boolean
standard false (meshy-6), true (others)
Description
Styr om remesh-fasen ska aktiveras. När den sätts till false returnerar API:t det triangulära nätet (mesh) med högst precision.
Gäller endast när should_remesh = true
Name
topology
Type
string
standard triangle
Description
Ange topology 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 polygonantal-nivå. När den 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 den sätts till true lagrar Meshy också en extra GLB-fil innan remesh-fasen slutförs.
Name
symmetry_mode
Type
string
⚠ föråldrad
standard auto
Description
Föråldrad (deprecated). Denna parameter påverkar inte längre utdata.
Fältet symmetry_mode styr symmetribeteende under modellgenereringsprocessen.
De giltiga värdena är:
off: Inaktiverar symmetri.
auto: Avgör och tillämpar automatiskt symmetri baserat på indatageometri.
on: Framtvingar symmetri under generering.
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 indatabilden för bättre resultat. Sätt till false för att bevara indatabildens exakta utseende utan någon stilbearbetning.
Stöds endast när ai_model är meshy-6 eller latest.
Name
remove_lighting
Type
boolean
standard true
Description
Tar bort högdagrar och skuggor från basfärgstexturen, vilket ger ett renare resultat som fungerar bättre under anpassade ljussättningar.
Stöds endast när ai_model är meshy-6 eller latest.
Name
moderation
Type
boolean
standard false
Description
När den sätts till true kommer indatainnehållet automatiskt att granskas för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks fortsätter uppgiften inte till generering.
Innehållet från indatafälten image_url, texture_image_url och texture_prompt kommer att granskas.
Name
target_formats
Type
string[]
Description
Anger vilka 3D-filformat som ska inkluderas i utdata. Endast de begärda formaten genereras och returneras, vilket kan minska uppgiftens slutförandetid. När detta utelämnas inkluderas alla format som stöds.
När detta utelämnas genereras alla format utom 3mf. 3mf inkluderas endast när det uttryckligen anges.
Name
auto_size
Type
boolean
standard false
Description
När den sätts till true använder tjänsten AI-vision för att automatiskt uppskatta objektets verkliga höjd och ändra modellens storlek därefter. Origo sätts som standard till bottom om inte origin_at uttryckligen anges.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När den sätts till true renderar uppgiften dessutom en version av förhandsvisningen med transparent bakgrund (RGBA) och returnerar den som alpha_thumbnail_url i GET-svaret. Det befintliga fältet thumbnail_url är oförändrat.
Name
multi_view_thumbnails
Type
boolean
standard false
Description
När den sätts till true renderar uppgiften dessutom fyra miniatyrbilder från huvudvyer (fram, höger, bak, vänster) och returnerar dem under thumbnail_urls i GET-svaret. Det befintliga fältet thumbnail_url är oförändrat och fortsätter att peka 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.
Returer
Egenskapen result i svaret innehåller uppgiftens id för den nyligen skapade Bild till 3D-uppgiften.
Fellägen
Name
400 - Bad Request
Description
Begäran kunde inte godtas. Vanliga orsaker:
Saknad parameter: Antingen image_url eller input_task_id måste anges.
Ogiltig indatauppgift: input_task_id måste hänvisa till en SUCCEEDED Text till bild- eller Bild till bild-uppgift som producerar exakt en bild.
Ogiltigt bildformat: Den angivna image_url har inte ett format som stöds (.jpg, .jpeg, .png).
Oåtkomlig URL: image_url kunde inte laddas ned (404 eller timeout).
Ogiltig Data URI: Base64-strängen är felaktigt formaterad.
Ogiltig parameterkombination: enable_pbr stöds endast när should_texture är true.
Name
401 - Unauthorized
Description
Autentisering 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/image-to-3d
# Simple request with required paramscurl https://api.meshy.ai/openapi/v1/image-to-3d \ -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>" }'# With remesh, PBR, and A-posecurl https://api.meshy.ai/openapi/v1/image-to-3d \ -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>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Denna endpoint låter dig hämta en Bild till 3D-uppgift med ett giltigt id.
Se Objektet Bild till 3D-uppgift för att se vilka
egenskaper som ingår i objektet Bild till 3D-uppgift.
Parametrar
Name
id
Type
path
Description
Unik identifierare för Bild till 3D-uppgiften som ska hämtas.
Bild till 3D-uppgiftsobjektet är en arbetsenhet som Meshy håller reda på för att generera en 3D-modell från en bild som indata.
Objektet har följande egenskaper:
Egenskaper
Name
id
Type
string
Description
Unik identifierare för uppgiften. Även om vi använder ett k-sorterbart UUID för uppgifts-id:n som
implementeringsdetalj bör du inte göra några antaganden om id:ts format.
Name
type
Type
string
Description
Typ av Bild till 3D-uppgift. Värdet är 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 genereras, i stä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 när 3mf begärdes via target_formats.
Name
pre_remeshed_glb
Type
string
Description
Nedladdningsbar URL till den ursprungliga GLB-utmatningen före 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 modellfilens miniatyrbild. 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 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 miniatyrbilder i kardinalvyer av den genererade 3D-modellen. Varje värde är en signerad URL till en 512×512 PNG som renderats med samma material och belysning som thumbnail_url. Användbart för att förhandsvisa modellen från flera vinklar i batch-pipelines utan att ladda ner GLB.
Finns endast när uppgiften skapades med multi_view_thumbnails: true och har nått SUCCEEDED. Äldre uppgifter och uppgifter som skapats utan opt-in inkluderar inte detta fält.
Name
front
Type
string
Description
Frontvy, 0° rotation runt den vertikala axeln (matchar thumbnail_url).
Name
right
Type
string
Description
Högervy, 90° rotation.
Name
back
Type
string
Description
Bakvy, 180° rotation.
Name
left
Type
string
Description
Vänstervy, 270° rotation.
Name
texture_prompt
Type
string
Description
Textprompten som användes för att styra textureringsprocessen.
Name
texture_image_url
Type
string
Description
Nedladdningsbar URL till texturbilden som användes för att styra textureringsprocessen.
Name
progress
Type
integer
Description
Uppgiftens progress. Om uppgiften inte har startat ännu kommer denna egenskap att vara 0. När uppgiften har lyckats blir detta 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 har gått sedan 1 januari 1970 UTC, enligt
standarden RFC 3339.
Till exempel representeras fredag 1 september 2023 12:00:00 PM 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 uppgiftsresultatet 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 ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
En array med textur-URL-objekt som genereras från uppgiften. Normalt innehåller detta endast ett textur-URL-objekt. Varje textur-URL har följande egenskaper:
Name
base_color
Type
string
Description
Nedladdningsbar URL till baskartbilden för färg.
Name
metallic
Type
string
Description
Nedladdningsbar URL till metallickartbilden.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
normal
Type
string
Description
Nedladdningsbar URL till normalmap-bilden.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
roughness
Type
string
Description
Nedladdningsbar URL till grovhetskartbilden.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
emission
Type
string
Description
Nedladdningsbar URL till emissionskartbilden.
Om uppgiften skapas 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 för detta fält är endast meningsfullt om uppgiftsstatusen är PENDING.
Name
task_error
Type
object
Description
Feldetaljer 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 uppgiftsstatusen är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid fel).