Text till 3D API

Text till 3D API är en funktion som låter dig integrera Meshys Text 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.

Text till 3D använder ett arbetsflöde i två steg. Skapa först en förhandsgranskningsuppgift (mode: "preview") för att generera ett 3D-nät utan textur, så att du kan utvärdera formen. Skicka sedan den slutförda förhandsgranskningens uppgifts-ID till en förfiningsuppgift (mode: "refine") för att applicera textur på nätet (mesh). Båda stegen delar samma endpoint.


POST/openapi/v2/text-to-3d

Skapa en Text till 3D-förhandsgranskningsuppgift

Denna endpoint skapar en Text till 3D-förhandsgranskningsuppgift, som genererar ett otexturerat 3D-nät (endast geometri) från en textprompt. Detta är det första steget i arbetsflödet med två steg. När förhandsgranskningen lyckas använder du det returnerade uppgifts-ID:t för att skapa en refine-uppgift för texturering. Se Text till 3D-uppgiftsobjektet för det fullständiga svarsschemat.

Parametrar

  • Name
    mode
    Type
    string
    Obligatorisk
    Description

    Detta fält ska sättas till "preview" när du skapar en förhandsgranskningsuppgift.

  • Name
    prompt
    Type
    string
    Obligatorisk
    Description

    Beskriv vilken typ av objekt 3D-modellen är. Högst 600 tecken.

  • 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 detaljnivå.
    • 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_remesh
    Type
    boolean
    standard false (meshy-6), true (others)
    Description

    Styr om remesh-fasen ska aktiveras. När den är satt till false returnerar API:et direkt det triangulära nätet 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 är angiven 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
    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 automatiskt och tillämpar symmetri baserat på inmatningsgeometri.
    • 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
    art_style
    Type
    string
    föråldrad
    standard realistic
    Description

    Stöds inte av Meshy-6. Begäranden som använder Meshy-6 ignorerar art_style, och vissa kombinationer kan orsaka fel. Tillgängliga värden: realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    standard false
    Description

    När den är satt till true granskas inmatningsinnehållet automatiskt för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks fortsätter uppgiften inte till generering.

    Texten från 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 tiden tills uppgiften är klar. När detta utelämnas inkluderas alla format som stöds.

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

  • Name
    alpha_thumbnail
    Type
    boolean
    standard false
    Description

    När den är satt till true renderar uppgiften dessutom en version av förhandsgranskningen 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
    auto_size
    Type
    boolean
    standard false
    Description

    När den är satt till true använder tjänsten AI-seende för att automatiskt uppskatta objektets verkliga höjd och ändra storlek på modellen därefter. Origo blir som standard bottom om inte origin_at uttryckligen anges.

Gäller endast när auto_size = true
  • Name
    origin_at
    Type
    string
    standard bottom
    Description

    Position för origo när auto_size är aktiverat.

    Tillgängliga värden: bottom, center.

Returnerar

Egenskapen result i svaret innehåller uppgiftens id för den nyskapade Text till 3D-uppgiften.

Fellägen

  • Name
    400 - Bad Request
    Description

    Begäran kunde inte accepteras. Vanliga orsaker:

    • Saknad parameter: En obligatorisk parameter (t.ex. prompt, mode) saknas.
    • Ogiltig parameter: art_style är inte ett av de tillåtna värdena.
    • För lång prompt: prompt överskrider teckengränsen.
  • 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/v2/text-to-3d
# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Preview with remesh and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

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

POST/openapi/v2/text-to-3d

Skapa en Text till 3D-förfiningsuppgift

Denna endpoint skapar en Text till 3D-förfiningsuppgift, som applicerar textur på ett färdigt förhandsvisningsnät. Du måste ange preview_task_id från en lyckad förhandsvisningsuppgift. Detta är det andra steget i arbetsflödet med två steg.

Parametrar

  • Name
    mode
    Type
    string
    Obligatorisk
    Description

    Detta fält ska anges till "refine" när du skapar en förfiningsuppgift.

  • Name
    preview_task_id
    Type
    string
    Obligatorisk
    Description

    Motsvarande ID för förhandsvisningsuppgiften.

    Statusen för den angivna förhandsvisningsuppgiften måste vara SUCCEEDED.

  • Name
    enable_pbr
    Type
    boolean
    standard false
    Description

    Generera PBR-mappar (metallic, roughness, normal) utöver basfärgen. En emission map inkluderas 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

    Ange en ytterligare textprompt för att styra textureringsprocessen. Högst 600 tecken.

  • Name
    texture_image_url
    Type
    string
    Description

    Ange 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 åtkomlig URL: En URL som är åtkomlig 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
    ai_model
    Type
    string
    standard latest
    Description

    ID för modellen som ska användas för förfining. Tillgängliga värden: meshy-5, meshy-6, latest (Meshy 6).

  • Name
    moderation
    Type
    boolean
    standard false
    Description

    När detta anges till true granskas indatainnehållet automatiskt för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks fortsätter uppgiften inte till generering.

    Både texten från texture_prompt och bilden från texture_image_url kommer att granskas.

  • 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
    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
    alpha_thumbnail
    Type
    boolean
    standard false
    Description

    När detta anges 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 ändras inte.

  • Name
    auto_size
    Type
    boolean
    standard false
    Description

    När detta anges till true använder tjänsten AI-seende för att automatiskt uppskatta objektets verkliga höjd och ändra storlek på modellen därefter. Origo blir som standard bottom om inte origin_at uttryckligen anges.

Gäller endast när auto_size = true
  • Name
    origin_at
    Type
    string
    standard bottom
    Description

    Position för origo när auto_size är aktiverat.

    Tillgängliga värden: bottom, center.

Returnerar

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

Fellägen

  • Name
    400 - Bad Request
    Description

    Begäran var ogiltig. Vanliga orsaker:

    • Ogiltigt uppgifts-ID: preview_task_id är ogiltigt eller finns inte.
    • Uppgiften är inte redo: Förhandsvisningsuppgiften har inte lyckats ännu.
    • Modellinkompatibilitet: Förhandsvisningsuppgiftens AI-modell är inkompatibel med den begärda förfiningsmodellen.
  • 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
    404 - Not Found
    Description

    Förhandsvisningsuppgiften som anges av preview_task_id hittades inte.

  • Name
    429 - Too Many Requests
    Description

    Du har överskridit din hastighetsgräns.

Request

POST
/openapi/v2/text-to-3d
# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

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

GET/openapi/v2/text-to-3d/:id

Hämta en Text till 3D-uppgift

Denna endpoint låter dig hämta en Text till 3D-uppgift med ett giltigt id. Se Text till 3D-uppgiftsobjektet för att se vilka egenskaper som ingår i Text till 3D-uppgiftsobjektet.

Denna endpoint fungerar för både förhandsgransknings- och förfiningsuppgifter.

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för den Text till 3D-uppgift som ska hämtas.

Returnerar

Svaret innehåller Text till 3D-uppgiftsobjektet. Se avsnittet Text till 3D-uppgiftsobjektet för detaljer.

Exempel

ModeExempelmodell
FörhandsgranskningPreview model
FörfiningRefined model

Request

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?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=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

Ta bort en Text till 3D-uppgift

Denna endpoint tar permanent bort en Text till 3D-uppgift, inklusive alla tillhörande modeller och data. Denna åtgärd är oåterkallelig.

Sökvägsparametrar

  • Name
    id
    Type
    path
    Description

    ID:t för Text till 3D-uppgiften som ska tas bort.

Returnerar

Returnerar 200 OK vid lyckat resultat.

Request

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

Response

// Returns 200 Ok on success.

GET/openapi/v2/text-to-3d

Lista Text till 3D-uppgifter

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

Parametrar

  • Name
    page_num
    Type
    integer
    standard 1
    Description

    Sidnummer för paginering.

  • Name
    page_size
    Type
    integer
    standard 10
    Description

    Gräns för sidstorlek. 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 Text till 3D-uppgiftsobjekten.

Request

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "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=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

Strömma en Text till 3D-uppgift

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

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för Text till 3D-uppgiften som ska strömmas.

Returnerar

Returnerar en ström av Text till 3D-uppgiftsobjekten som Server-Sent Events.

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

Request

GET
/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v2/text-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",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"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": 20
}

Uppgiftsobjektet för Text till 3D

Uppgiftsobjektet för Text till 3D är en arbetsenhet som Meshy håller reda på för att generera en 3D-modell från en text-inmatning. Det finns två stadier i Text till 3D-API:et, preview och refine. Preview-stadiet används för att generera en 3D-modell med enbart nät, och refine-stadiet används för att generera en texturerad 3D-modell baserad på resultatet från preview-stadiet.

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 implementationsdetalj bör du inte göra några antaganden om formatet för id:t.

  • Name
    type
    Type
    string
    Description

    Typ av Text till 3D-uppgift. Möjliga värden är text-to-3d-preview för uppgifter i förhandsgranskningssteget och text-to-3d-refine för uppgifter i förfiningssteget.

  • Name
    model_urls
    Type
    object
    Description

    Nedladdningsbar URL till den texturerade 3D-modellfilen som genererats 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
      usdz
      Type
      string
      Description

      Nedladdningsbar URL till USDZ-filen.

    • Name
      obj
      Type
      string
      Description

      Nedladdningsbar URL till OBJ-filen.

    • Name
      mtl
      Type
      string
      Description

      Nedladdningsbar URL till MTL-filen.

    • 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
    prompt
    Type
    string
    Description

    Detta är den oförändrade prompt som användes för att skapa uppgiften.

  • Name
    negative_prompt
    Type
    string
    föråldrad
    Description

    Bibehålls för bakåtkompatibilitet. Detta fält har ingen funktionell påverkan på genererade modeller.

  • Name
    art_style
    Type
    string
    föråldrad
    Description

    Den oförändrade art_style som användes för att skapa förhandsgranskningsuppgiften. Stöds inte av Meshy-6.

  • Name
    texture_richness
    Type
    string
    föråldrad
    Description

    Bibehålls för bakåtkompatibilitet. Detta fält har ingen funktionell påverkan på genererade modeller.

  • Name
    texture_prompt
    Type
    string
    Description

    Ytterligare text-prompt som tillhandahålls för att vägleda textureringsprocessen under förfiningssteget.

  • Name
    texture_image_url
    Type
    string
    Description

    Nedladdningsbar URL till texturbilden som användes för att vägleda textureringsprocessen.

  • Name
    thumbnail_url
    Type
    string
    Description

    Nedladdningsbar URL till miniatyrbilden för modellfilen.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Nedladdningsbar URL till en version med transparent bakgrund (RGBA) av thumbnail_url. Finns endast när uppgiften skapades med alpha_thumbnail: true och den transparenta förhandsgranskningen renderades framgångsrikt; annars utelämnas detta fält.

  • Name
    video_url
    Type
    string
    föråldrad
    Description

    Nedladdningsbar URL till förhandsgranskningsvideon. Kommer att tas bort i en framtida version.

  • Name
    progress
    Type
    integer
    Description

    Uppgiftens progress. Om uppgiften inte har startats ännu kommer denna egenskap att vara 0. När uppgiften har slutförts framgångsrikt blir detta 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften inte har startats ännu kommer denna egenskap att vara 0.

  • Name
    created_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften skapades, 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 bilden för basfärgskartan.

    • Name
      metallic
      Type
      string
      Description

      Nedladdningsbar URL till bilden för metallic-kartan.

    • Name
      normal
      Type
      string
      Description

      Nedladdningsbar URL till normalmapbilden.

    • Name
      roughness
      Type
      string
      Description

      Nedladdningsbar URL till bilden för roughness-kartan.

    • Name
      emission
      Type
      string
      Description

      Nedladdningsbar URL till bilden för emissionskartan.

  • 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 fullständig objektreferens för task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Antalet credits som förbrukats av denna uppgift. Finns när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid fel).

Example Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "seed": 1234,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "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": 20
}