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 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 Bild till 3D-uppgiftsobjektet för att se vilka egenskaper som ingår i Bild till 3D-uppgiftsobjektet.

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 för en slutförd bildgenereringsuppgift vars utdata ska användas som inbild. Denna uppgift måste vara en av följande uppgiftstyper: Text till bild eller Bild till bild. Dessutom måste den ha körts via API:et, 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:
- Offentligt tillgänglig URL: En URL som är åtkomlig från den öppna internet.
- Data URI: En base64-kodad data-URI för bilden. Exempel på en data-URI: data:image/jpeg;base64,<din base64-kodade bilddata>.

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.
- smart-topology: Välj en Smart Topology-modell med ai_model (meshy-t2).
- lowpoly (föråldrad): Genererar ett low-poly-nät optimerat för renare polygoner. Vi rekommenderar att du använder smart-topology istället.
När smart-topology väljs ignoreras topology, should_remesh och save_pre_remeshed_model.
När lowpoly väljs ignoreras ai_model, topology, target_polycount, should_remesh och save_pre_remeshed_model.
Name
ai_model
Type
string
standard latest
Description
ID för modellen 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): Smart Topology-modellen — renare topology, naturligt separerade delar, triangelutdata och ett polygonantal du kan ange med target_polycount.
Name
ultra_mode
Type
boolean
standard false
Description
Aktiverar Ultra-generering för geometri med högre trohet och finare ytdetaljer.
Stöds endast när ai_model är meshy-7 (eller latest).
Name
should_texture
Type
boolean
standard true
Description
Avgör om texturer genereras. Om det 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 emissionsmapp inkluderas även när ai_model är meshy-6, förutom vid texture_resolution: 8k. meshy-7 och latest producerar inte någon emissionsmapp.
Name
texture_resolution
Type
string
standard 2k
Description
Upplösning för basfärgstexturen. Ett av 2k (2048×2048), 4k (4096×4096), eller 8k (8192×8192). Högre upplösningar fångar mer ytdetalj.
4k och 8k är inte tillgängliga med ai_model: meshy-5. Vid 8k produceras ingen emissionsmapp.
Name
hd_texture
Type
boolean
⚠ föråldrad
standard false
Description
Använd texture_resolution istället — motsvarar texture_resolution: "4k". Om 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
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:
- Offentligt tillgänglig URL: En URL som är åtkomlig från det öppna internet
- Data URI: En base64-kodad data-URI för bilden. Exempel på en data-URI: data:image/jpeg;base64,<din base64-kodade bilddata>
Bildtexturering kan fungera suboptimalt om det finns betydande geometriska skillnader mellan originaltillgå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 användas för att textera modellen. 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 modellen med högst kvalitet 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 topology för den genererade modellen.
Tillgängliga värden:
- quad: Generera ett nät som domineras av quads.
- triangle: Generera ett decimerat triangelnät.
Name
decimation_mode
Type
integer
Description
Aktivera adaptiv decimering genom att ange en polygonantalnivå. När detta anges ignoreras target_polycount.
Tillgängliga värden:
- 1: Adaptiv — ultra 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 sätts till true lagrar Meshy även en extra GLB-fil innan remesh-fasen är slutförd.

Name
target_polycount
Type
integer
Description
Önskat antal polygoner (ytor) i utdatan. Det faktiska antalet kan avvika från målet beroende på geometrin.
target_polycount gäller i två oberoende fall:
- Remesh — med should_remesh: true på en standard-modell. Nätet remeshas (decimeras) till ungefär detta antal. Intervall 100 till 300 000, standard 30 000. Om decimation_mode är angivet har det prioritet och target_polycount ignoreras.
- Smart Topology — med model_type: smart-topology och ai_model: meshy-t2. Modellen genereras direkt med detta antal ytor; ingen remesh kö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 utdatan.
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ående geometri.
- on: Tvingar 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 inbilden för bättre resultat. Sätt till false för att bevara inbildens exakta utseende utan någon stilbearbetning.
Stöds endast när ai_model är meshy-6, meshy-7 eller latest.
Name
remove_lighting
Type
boolean
standard true
Description
Tar bort highlights och skuggor från basfärgstexturen, vilket ger ett renare resultat som fungerar bättre med anpassade ljussättningar.
Stöds endast när ai_model är meshy-6.
Name
moderation
Type
boolean
standard false
Description
När detta sätts till true kommer inmatningsinnehållet automatiskt att granskas 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 kommer att granskas.
Name
target_formats
Type
string[]
Description
Anger vilka 3D-filformat som ska ingå i utdatan. Endast de begärda formaten genereras och returneras, vilket kan minska tiden det tar att slutföra uppgiften. Om detta utelämnas ingår alla format som stöds.
Tillgängliga värden: glb, obj, fbx, stl, usdz, 3mf
Om detta utelämnas genereras alla format förutom 3mf. 3mf ingår endast när det uttryckligen anges.
Name
auto_size
Type
boolean
standard false
Description
När detta sätts till true använder tjänsten AI-syn för att automatiskt uppskatta objektets verkliga höjd och ändrar storlek på modellen därefter. Origo standardvärde är bottom om inte origin_at uttryckligen anges.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När detta 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 förblir oförändrat.
Name
multi_view_thumbnails
Type
boolean
standard false
Description
När detta sätts till true renderar uppgiften dessutom fyra kardinalvys-miniatyrer (fram, 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å vyn framifrån, så befintliga klienter påverkas inte.
Lägger till ungefär 3 sekunder till uppgiftens svarstid.

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 uppgiftens id för den nyskapade Bild till 3D-uppgiften.

Felläge

Name
400 - Bad Request
Description
Begäran var inte godtagbar. Vanliga orsaker:
- Saknad parameter: Antingen image_url eller input_task_id måste anges.
- Ogiltig ingångsuppgift: input_task_id måste referera 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).
- Onåbar URL: image_url kunde inte laddas ner (404 eller timeout).
- Ogiltig Data URI: Base64-strängen är felformad.
- Ogiltig parameterkombination: enable_pbr stöds endast när should_texture är true.
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/image-to-3d

# Simple request with required params
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>"
  }'

# With remesh, PBR, and 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

Detta endpoint tillåter dig att hämta en Bild till 3D-uppgift givet ett giltigt uppgifts-id. Se Bild till 3D-uppgiftsobjektet för att se vilka egenskaper som ingår i Bild till 3D-uppgiftsobjektet.

Parametrar

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

Returnerar

Svaret innehåller Bild till 3D-uppgiftsobjektet. Kontrollera Bild till 3D-uppgiftsobjektet avsnittet 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

Ta bort en Bild till 3D-uppgift

Detta endpoint tar permanent bort 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 den Bild till 3D-uppgift som ska tas bort.

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

// Returns 200 Ok on success.

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

Lista Bild till 3D-uppgifter

Detta endpoint tillåter dig att 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 standard är 1.
Name
page_size
Type
integer
Description
Sidstorleksbegränsning. Standard är 10 objekt. Maximal tillåten är 50 objekt.
Name
sort_by
Type
string
Description
Fält att sortera efter. 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 Bild till 3D-uppgiftsobjekt.

Förfrågan

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}"

Svar

[
  {
    "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 realtidsuppdateringar för en Bild till 3D-uppgift med hjälp av Server-Sent Events (SSE).

Parametrar

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

Returnerar

Returnerar en ström av Bild till 3D-uppgiftsobjekt 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

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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
}

Objektet för Bild till 3D-uppgift

Objektet för Bild till 3D-uppgift är en arbetsenhet som Meshy håller reda på för att generera en 3D-modell från en bildinmatning. 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 som implementeringsdetalj, bör du inte göra några antaganden om formatet på id.
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 genererad 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, returnerad 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. Endast närvarande när 3mf begärdes via target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Nedladdningsbar URL till den ursprungliga GLB-utgången före omtopologi.
  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 finns, behållen 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 renderades framgångsrikt; annars utelämnas detta fält.
Name
thumbnail_urls
Type
object
Description
Nedladdningsbara URL:er för fyra kardinalvy-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 batch-pipelines 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 att inkludera detta fält.
- Name
  front
  Type
  string
  Description
  Främre vy, 0° rotation runt den vertikala axeln (matchar 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 texturbilden som användes för att styra textureringsprocessen.
Name
ultra_mode
Type
boolean
Description
Återspeglar ultra_mode-värdet som uppgiften skapades med. Endast närvarande för meshy-7 (eller latest) uppgifter som uttryckligen ställer in ultra_mode; utelämnas annars.
Name
progress
Type
integer
Description
Framsteg för uppgiften. 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 startade, 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 RFC 3339-standarden. Till exempel, fredag 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 är avslutad ännu kommer denna egenskap att 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 array av textur-URL-objekt som genereras från uppgiften. Normalt innehåller detta endast en textur-URL-objekt. Varje textur-URL har följande egenskaper:
- Name
  base_color
  Type
  string
  Description
  Nedladdningsbar URL till basfärgskartbilden.
- Name
  metallic
  Type
  string
  Description
  Nedladdningsbar URL till metallkartbilden.
  Om uppgiften skapas med enable_pbr: false, kommer denna egenskap att utelämnas.
- Name
  normal
  Type
  string
  Description
  Nedladdningsbar URL till normalmap-bilden.
  Om uppgiften skapas med enable_pbr: false, kommer denna egenskap att utelämnas.
- Name
  roughness
  Type
  string
  Description
  Nedladdningsbar URL till ojämnhetskartbilden.
  Om uppgiften skapas med enable_pbr: false, kommer denna egenskap att 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 att utelämnas.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Värdet på detta fält är meningsfullt endast om uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Felfunktioner för misslyckade uppgifter. Se Fel för den fullständiga task_error-objektreferensen.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna uppgift. Närvarande när uppgiftens status är PENDING, IN_PROGRESS, eller SUCCEEDED. Returnerar 0 för FAILED uppgifter (credits återbetalas vid misslyckande).

Exempel på Bild till 3D-uppgiftsobjekt

{
  "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
}