Bild till 3D API

Bild till 3D API är en funktion som låter dig integrera Meshys Bild till 3D-funktioner i din egen applikation. I det här avsnittet hittar du all information som du behöver för att komma igång med detta API.

POST/openapi/v1/image-to-3d

Skapa en Bild till 3D-uppgift

Denna endpoint låter dig skapa en ny Bild till 3D-uppgift. Se The Image to 3D Task Object för att se vilka egenskaper som ingår med Bild till 3D-uppgiftsobjektet.

Parametrar

Endast en av input_task_id eller image_url är obligatorisk. Om båda tillhandahålls, har input_task_id prioritet.

Name
input_task_id
Type
string
Obligatorisk
Description
ID för en slutförd bildgenereringsuppgift vars utdata ska användas som inmatningsbild. 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:n, ha en status av SUCCEEDED och producera exakt en bild.

Name
image_url
Type
string
Obligatorisk
Description
Tillhandahåll en bild för Meshy att använda vid modellskapande. Vi stöder för närvarande .jpg, .jpeg och .png format.
Det finns två sätt att tillhandahålla bilden:
- Publikt åtkomlig URL: En URL som är åtkomlig från internet.
- Data URI: En base64-kodad data URI av bilden. Exempel på en data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
standard standard
Description
Specificera typen av 3D-nätgenerering.
Tillgängliga värden:
- standard: Regelbunden högdetaljerad 3D-nätgenerering.
- smart-topology: Välj en Smart Topology-modell med ai_model (meshy-t1 eller meshy-t2).
- lowpoly (föråldrad): Genererar ett low-poly nät optimerat för rena polygoner. Vi rekommenderar att använda smart-topology istället.
När smart-topology är valt, ignoreras topology, should_remesh och save_pre_remeshed_model.
När lowpoly är valt, ignoreras ai_model, topology, target_polycount, should_remesh och save_pre_remeshed_model.
Name
ai_model
Type
string
standard latest
Description
ID för den modell som ska användas. De tillgängliga värdena beror på model_type.
Standardgenerering (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Smart Topology-generering (model_type: smart-topology):
- meshy-t2 (standard, rekommenderas): Smart Topology-modellen — renare topology, naturligt separerade delar, triangulärt utdata och en ansiktsräkning som kan ställas in med target_polycount.
- meshy-t1: den gamla low-poly modellen; stödjer inte inställning av ansiktsräkning med target_polycount.
Name
ultra_mode
Type
boolean
standard false
Description
Aktiverar Ultra-generering för geometri med högre detaljtrohet och finare ytdetaljer.
Endast stöd när ai_model är meshy-7 (eller latest).
Name
should_texture
Type
boolean
standard true
Description
Bestämmer om texturer skapas. Om satt till false hoppas texture-fasen över, och nätet tillhandahålls utan texturer.

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 baskulören. En emissionskarta ingår också när ai_model är meshy-6, utom vid texture_resolution: 8k. meshy-7 och latest producerar ingen emissionskarta.
Name
texture_resolution
Type
string
standard 2k
Description
Basfärgsupplösningens texturfärg. En av 2k (2048×2048), 4k (4096×4096) eller 8k (8192×8192). Högre upplösningar fångar fler ytdetaljer.
4k och 8k är inte tillgängliga med ai_model: meshy-5. 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 har texture_resolution företräde.
Name
texture_prompt
Type
string
Description
Tillhandahåll en textprompt för att styra textureringen. 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 .jpg, .jpeg och .png format.
Det finns två sätt att tillhandahålla bilden:
- Publikt åtkomlig URL: En URL som är åtkomlig från internet
- Data URI: En base64-kodad data URI av bilden. Exempel på en data URI: data:image/jpeg;base64,<your base64-encoded image data>
Bildtexturering fungerar kanske inte optimalt om det finns betydande skillnader i geometri mellan den ursprungliga asset 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 tillhandahålls, så kommer texture_prompt att användas för att texturera modellen som standard. Texturering via antingen text eller bild kostar 10 credits per uppgift.

Name
should_remesh
Type
boolean
standard false (meshy-6, meshy-7), true (others)
Description
Styr om remesh-fasen ska aktiveras. För den högsta kvalitetsmodellen 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
Specificera topologin för den genererade modellen.
Tillgängliga värden:
- quad: Generera ett fyrkantsdominerat nät.
- triangle: Generera ett decimerat triangulärt nät.
Name
decimation_mode
Type
integer
Description
Aktivera adaptiv decimering genom att ställa in en polycount-nivå. När den är inställd ignoreras target_polycount.
Tillgängliga värden:
- 1: Adaptiv — ultra polycount.
- 2: Adaptiv — hög polycount.
- 3: Adaptiv — medium polycount.
- 4: Adaptiv — låg polycount.
Name
save_pre_remeshed_model
Type
boolean
standard false
Description
När satt till true, lagrar Meshy också en extra GLB-fil innan remesh-fasen är slutförd.

Name
target_polycount
Type
integer
Description
Målat antal polygoner (ansikten) i utdata. Det faktiska antalet kan avvika från målet beroende på geometrin.
target_polycount träder i kraft i två oberoende fall:
- Remesh — med should_remesh: true på en standardmodell. Nätet remeshades (decimeras) till cirka detta antal. Intervall 100 till 300 000, standard 30 000. Om decimation_mode är inställd, har den prioritet och target_polycount ignoreras.
- Smart Topology — med model_type: smart-topology och ai_model: meshy-t2. Modellen genereras direkt på detta antalsytor; ingen remesh utförs och should_remesh krävs inte. Intervall 100 till 15 000, standard 4 000.

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: Bestämmer och tillämpar automatiskt symmetri baserat på ingångsgeometrin.
- on: Tvingar symmetri under generering.
Name
pose_mode
Type
string
standard ""
Description
Specificera pose mode för den genererade modellen.
Tillgängliga värden:
- a-pose: Generera modellen i ett A pose.
- t-pose: Generera modellen i ett T pose.
- "" (tom sträng): Ingen specifik pose tillämpad.
Name
is_a_t_pose
Type
boolean
⚠ föråldrad
standard false
Description
Använd pose_mode istället. Huruvida modellen ska genereras i ett A/T pose.
Name
image_enhancement
Type
boolean
standard true
Description
Optimerar inmatningsbilden för bättre resultat. Sätt false för att bevara det exakta utseendet av inmatningsbilden utan någon stilbearbetning.
Endast stöd när ai_model är meshy-6, meshy-7 eller latest.
Name
remove_lighting
Type
boolean
standard true
Description
Tar bort höjdpunkter och skuggor från baskulören, vilket ger ett renare resultat som fungerar bättre under egna belysningsinställningar.
Endast stöd när ai_model är meshy-6.
Name
moderation
Type
boolean
standard false
Description
När den är satt till true, granskas automatiskt inmatningens innehåll för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks kommer uppgiften inte att gå vidare till generering.
Innehållet från image_url, texture_image_url och texture_prompt input kommer att granskas.
Name
target_formats
Type
string[]
Description
Specificerar vilka 3D-filformat som ska inkluderas i utdata. Endast de begärda formaten kommer att genereras och returneras, vilket kan minska uppgiftens slutförandetid. När det utelämnas inkluderas alla stödda format.
Tillgängliga värden: glb, obj, fbx, stl, usdz, 3mf
När det utelämnas genereras alla format utom 3mf. 3mf ingår endast när det uttryckligen anges.
Name
auto_size
Type
boolean
standard false
Description
När den är satt till true, använder tjänsten AI vision för att automatiskt uppskatta objektets verkliga världshöjd och ändra modellens storlek därefter. Ursprung kommer att vara bottom om inte origin_at uttryckligen är inställt.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När den är satt till true, renderar uppgiften dessutom en gennomskinlig 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 satt till true, renderar uppgiften dessutom fyra kardinalvyn miniatyrbilder (fram, höger, bak, vänster) och returnerar dem under thumbnail_urls på GET-svaret. Det befintliga thumbnail_url-fältet förblir oförändrat och fortsätter att peka på framvyn, så befintliga klienter påverkas inte.
Lägger till cirka 3 sekunder till uppgiftens latenstid.

Gäller endast när auto_size = true

Name
origin_at
Type
string
standard bottom
Description
Positionen för origo när auto_size är aktiverat.
Tillgängliga värden: bottom, center.

Returnerar

result-egenskapen i svaret innehåller uppgiftens id för den nyligen skapade Bild till 3D-uppgiften.

Felmodi

Name
400 - Bad Request
Description
Begäran var oacceptabel. Vanliga orsaker:
- Saknad parameter: Antingen image_url eller input_task_id måste tillhandahållas.
- Ogiltlig infogningsuppgift: input_task_id måste hänvisa till en SUCCEEDED Text till Bild eller Bild till Bild uppgift som producerar exakt en bild.
- Ogiltlig bildformat: Den tillhandahållna image_url är inte ett stödt format (.jpg, .jpeg, .png).
- Oåtkomlig URL: image_url kunde inte laddas ner (404 eller timeout).
- Ogiltig Data URI: Base64-strängen är felaktig.
- Ogiltig parameterkombination: enable_pbr stöds bara när should_texture är sant.
Name
401 - Unauthorized
Description
Autentisering misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckligt med credits för att genomföra denna uppgift.
Name
429 - Too Many Requests
Description
Du har överskridit din hastighetsgräns.

Request

POST

/openapi/v1/image-to-3d

# Enkel begäran med obligatoriska parametrar
curl 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>"
  }'

# Med remesh, PBR och A-pose
curl 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"]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-3d/:id

Hämta en Bild till 3D-uppgift

Denna endpoint låter dig hämta en Bild till 3D-uppgift med ett giltigt uppgift id. Se The Image to 3D Task Object för att se vilka egenskaper som ingår med Bild till 3D-uppgiftsobjektet.

Parametrar

Name
id
Type
path
Description
Unikt identifierare för Bild till 3D-uppgiften att hämta.

Returnerar

Svaret innehåller Bild till 3D-uppgiftsobjektet. Kontrollera The Image to 3D Task Object sektion för detaljer.

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

DELETE/openapi/v1/image-to-3d/:id

Radera en Bild till 3D-uppgift

Denna endpoint raderar permanent en Bild till 3D-uppgift, inklusive alla associerade modeller och data. Denna åtgärd är oåterkallelig.

Sökvägsparametrar

Name
id
Type
path
Description
ID för Bild till 3D-uppgiften att radera.

Returnerar

Returnerar 200 OK vid framgång.

Request

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returnerar 200 Ok vid framgång.

GET/openapi/v1/image-to-3d

Lista Bild till 3D-uppgifter

Denna endpoint låter dig hämta en lista över Bild till 3D-uppgifter.

Parametrar

Valfria attribut

Name
page_num
Type
integer
Description
Sidnummer för paginering. Börjar och standardvärde är 1.
Name
page_size
Type
integer
Description
Sidstorleksgräns. Standardvärde är 10 objekt. Maximalt tillåtna är 50 objekt.
Name
sort_by
Type
string
Description
Fält för sortering. Tillgängliga värden:
- +created_at: Sortera efter skapandetid i stigande ordning.
- -created_at: Sortera efter skapandetid i fallande ordning.

Returnerar

Returnerar en paginerad lista över The Image to 3D Task Objects.

Request

GET

/openapi/v1/image-to-3d

curl https://api.meshy.ai/openapi/v1/image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {
      "message": ""
    },
    "consumed_credits": 30
  }
]

GET/openapi/v1/image-to-3d/:id/stream

Strömma en Bild till 3D-uppgift

Denna endpoint strömmar uppdateringar i realtid för en Bild till 3D-uppgift med hjälp av Server-Sent Events (SSE).

Parametrar

Name
id
Type
path
Description
Unikt identifierare för Bild till 3D-uppgiften att strömma.

Returnerar

Returnerar en ström av The Image to 3D Task Objects som Server-Sent Events.

För PENDING eller IN_PROGRESS uppgifter kommer svarströmmen endast att inkludera nödvändiga progress och status fält.

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Exempel på felhändelse
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Exempel på meddelandehändelser illustrerar uppgiftens framsteg.
// För PENDING eller IN_PROGRESS uppgifter kommer svarströmmen inte inkludera alla fält.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
  "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

Bild till 3D-uppgiftsobjektet

Bild till 3D-uppgiftsobjektet är en arbetsenhet som Meshy håller reda på för att generera en 3D-modell från en bild inmatning. Objektet har följande egenskaper:

Egenskaper

Name
id
Type
string
Description
Unikt 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 id:ns 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. Parametern 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-exports 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ärts via target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Nedladdningsbar URL till den ursprungliga GLB-utgången 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 miniatyrbilden av modellfilen. Motsvarar thumbnail_urls.front när den är närvarande, hålls för bakåtkompatibilitet.
Name
alpha_thumbnail_url
Type
string
Description
Nedladdningsbar URL till en gennomskinlig bakgrund (RGBA) version av thumbnail_url. Endast närvarande när uppgiften skapades med alpha_thumbnail: true och den gennomskinliga förhandsvisningen renderades framgångsrikt; anners utelämnas detta fält.
Name
thumbnail_urls
Type
object
Description
Nedladdningsbara URL:er för fyra kardinalvyn miniatyrbilder 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 batchlinjer 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 anslutning kommer inte att inkludera detta fält.
- Name
  front
  Type
  string
  Description
  Främre vy, 0° rotation runt den vertikala axeln (motsvarar thumbnail_url).
- Name
  right
  Type
  string
  Description
  Höger vy, 90° rotation.
- Name
  back
  Type
  string
  Description
  Bakre 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_url
Type
string
Description
Nedladdningsbar URL till textureringen av den bild som användes för att styra textureringsprocessen.
Name
ultra_mode
Type
boolean
Description
Speglar ultra_mode-värdet som uppgiften skapades med. Endast närvarande för uppgifter med meshy-7 (eller latest) som uttryckligen anger ultra_mode; annars utelämnas det.
Name
progress
Type
integer
Description
Framsteg för uppgiften. Om uppgiften inte har startat ännu, kommer denna egenskap vara 0. När uppgiften har lyckats, blir det 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 vara 0.
En tidsstämpel representerar antalet millisekunder som förflutet sedan 1 januari 1970 UTC, i enlighet med RFC 3339 standard. Till exempel, fredag den 1 september 2023 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 går ut, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften inte har avslutats ännu, 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 lista över texture URL-objekt som genereras från uppgiften. Normalt innehåller den endast en texture URL-objekt. Varje texture URL har följande egenskaper:
- Name
  base_color
  Type
  string
  Description
  Nedladdningsbar URL till baskulörens kartbild.
- Name
  metallic
  Type
  string
  Description
  Nedladdningsbar URL till den metalliska kartbilden.
  Om uppgiften skapas med enable_pbr: false, kommer denna egenskap utelämnas.
- Name
  normal
  Type
  string
  Description
  Nedladdningsbar URL till normalmap-kartbilden.
  Om uppgiften skapas med enable_pbr: false, kommer denna egenskap utelämnas.
- Name
  roughness
  Type
  string
  Description
  Nedladdningsbar URL till kartbilden råhet.
  Om uppgiften skapas med enable_pbr: false, kommer denna egenskap utelämnas.
- Name
  emission
  Type
  string
  Description
  Nedladdningsbar URL till emissionskartbilden.
  Om uppgiften skapas med enable_pbr: false, eller ai_model är meshy-5, meshy-7 eller latest, kommer denna egenskap utelämnas.
Name
preceding_tasks
Type
integer
Description
Antal föregående uppgifter.
Värdet på detta fält är meningsfullt endast om uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Felinformation för misslyckade uppgifter. Se Errors för fullständig task_error objektreferens.
Name
consumed_credits
Type
integer
Description
Antalet krediter som förbrukats av denna uppgift. Närvarande när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (krediter återbetalas vid fel).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}