Bild till 3D API

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.


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

Parametrar

  • 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.
  • 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.

  • 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>
  • 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.

  • 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.

  • 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.

    Tillgängliga värden: glb, obj, fbx, stl, usdz, 3mf

  • 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.

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

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.

Returnerar

Svaret innehåller objektet Bild till 3D-uppgift. Se avsnittet Objektet Bild till 3D-uppgift 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

Denna 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:t för Bild till 3D-uppgiften 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

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 på och standardvärdet är 1.

  • Name
    page_size
    Type
    integer
    Description

    Gräns för sidstorlek. Standardvärdet är 10 objekt. Högsta tillåtna ä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-uppgiftsobjekten.

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

Streama en Bild till 3D-uppgift

Denna endpoint streamar realtidsuppdateringar för en Bild till 3D-uppgift med Server-Sent Events (SSE).

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för den Bild till 3D-uppgift som ska streamas.

Returnerar

Returnerar en stream av Bild till 3D-uppgiftsobjekten som Server-Sent Events.

För PENDING- eller IN_PROGRESS-uppgifter kommer svarsstreamen 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
}

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 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.

  • 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.

    • 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.

  • 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.

    • Name
      normal
      Type
      string
      Description

      Nedladdningsbar URL till normalmap-bilden.

    • Name
      roughness
      Type
      string
      Description

      Nedladdningsbar URL till grovhetskartbilden.

    • Name
      emission
      Type
      string
      Description

      Nedladdningsbar URL till emissionskartbilden.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Antalet föregående uppgifter.

  • 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).

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
}