Text till 3D API

Text till 3D API är en funktion som tillåter dig att integrera Meshy's Text till 3D-funktionalitet i din egen applikation. I detta avsnitt 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. Först skapar du en förhandsgranskning-uppgift (mode: "preview") för att generera ett 3D-nät utan textur, så du kan utvärdera formen. Sedan vidarebefordrar du ID:t för den slutförda förhandsgranskningen till en förfina-uppgift (mode: "refine") för att applicera textur på nätet. Båda stegen delar samma endpoint.


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

Skapa en Text till 3D Förhandsgranskning

Denna endpoint skapar en Text till 3D förhandsgranskningsuppgift, som genererar ett icke-texturerat 3D-nät (endast geometri) från en textprompt. Detta är det första steget av arbetsflödet i två steg. När förhandsgranskningen lyckas, använd det returnerade uppgifts-ID:t för att skapa en förfina-uppgift för texturering. Se Text till 3D Uppgiftsobjektet för hela svarsstrukturen.

Parametrar

  • Name
    mode
    Type
    string
    Obligatorisk
    Description

    Detta fält ska ställas in till "preview" när du skapar en förhandsgranskningsuppgift.

  • Name
    prompt
    Type
    string
    Obligatorisk
    Description

    Beskriv vad för slags objekt 3D-modellen är. Max 600 tecken.

  • Name
    model_type
    Type
    string
    standard standard
    Description

    Specificera typen av 3D nätgenerering.

    Tillgängliga värden:

    • standard: Vanlig högdetaljnätgenerering.
    • smart-topology: Välj Smart Topology-modellen med ai_model (meshy-t2).
    • lowpoly (föråldrad): Genererar ett låg-poly nät optimerat för renare polygoner. Vi rekommenderar att använda smart-topology istället.
  • Name
    ai_model
    Type
    string
    standard latest
    Description

    ID för modellen som ska användas. Tillgängliga värden 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, nativt separerade delar, triangulär utgång, och ett ansiktsantal du kan sätta med target_polycount.
  • Name
    ultra_mode
    Type
    boolean
    standard false
    Description

    Aktiverar Ultra-generering för högre trogenhet på geometri med finare ytdetalj. Generering tar längre tid och kräver 5 credits.

  • Name
    should_remesh
    Type
    boolean
    standard false (meshy-6, meshy-7), true (annat)
    Description

    Kontrollerar om man ska aktivera remesh-fasen. För den bästa kvaliteten rekommenderar vi att ställa should_remesh till false.

Gäller endast när should_remesh = true
  • Name
    topology
    Type
    string
    standard triangle
    Description

    Specificera topologin av den genererade modellen.

    Tillgängliga värden:

    • quad: Generera ett fyrdominerat nät.
    • triangle: Generera ett decimerat triangulärt nät.
  • Name
    decimation_mode
    Type
    integer
    Description

    Aktivera adaptiv decimation genom att ställa in en polycounthöjd. När den är satt 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
    target_polycount
    Type
    integer
    Description

    Målad antal polygoner (ytor) i utgången. 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 standard-modell. Modellen är remeshed (decimerad) till ungefär detta antal. Intervall 100 till 300,000, standard 30,000. Om decimation_mode är inställd, går den före och target_polycount ignoreras.
    • Smart Topology — med model_type: smart-topology och ai_model: meshy-t2. Modellen genereras direkt vid detta ytantalsantal; inga 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 utgången.

    symmetry_mode-fältet kontrollerar symmetrins beteende under modellgenereringsprocessen.

    De giltiga värdena är:

    • off: Inaktiverar symmetri.
    • auto: Bestämmer och tillämpar symmetri automatiskt baserat på inmatningsgeometri.
    • on: Tvingar symmetri under generering.
  • Name
    pose_mode
    Type
    string
    standard ""
    Description

    Specificera poseläget för den genererade modellen.

    Tillgängliga värden:

    • a-pose: Generera modellen i en A-pos.
    • t-pose: Generera modellen i en T-pos.
    • "" (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 en A/T-pos.

  • Name
    art_style
    Type
    string
    föråldrad
    standard realistic
    Description

    Ej stödd av Meshy-6. Förfrågningar med Meshy-6 kommer att ignorera 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 inställd på true, kommer innehållet automatiskt att kontrolleras för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks kommer uppgiften inte att fortsätta till generering.

    Texten från prompt kommer att granskas.

  • Name
    target_formats
    Type
    string[]
    Description

    Specificerar vilka 3D-filformat som ska inkluderas i utgången. Endast de begärda formaten kommer att genereras och returneras, vilket kan minska slutförandetiden för uppgiften. När det utelämnas inkluderas alla stödda format.

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

  • Name
    alpha_thumbnail
    Type
    boolean
    standard false
    Description

    När den är inställd på true, renderar uppgiften dessutom en version med transparent bakgrund (RGBA) av förhandsgranskningen och returnerar den som alpha_thumbnail_url på GET-svaret. Det befintliga thumbnail_url-fältet är oförändrat.

  • Name
    auto_size
    Type
    boolean
    standard false
    Description

    När den är inställd på true, använder tjänsten AI-vision för att automatiskt uppskatta objektets verkliga höjd och ändra storleken på modellen därefter. Ursprung kommer att standardinställas till bottom såvida inte origin_at uttryckligen är angivet.

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

    Position av ursprunget när auto_size är aktiverad.

    Tillgängliga värden: bottom, center.

Återkommer

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

Felmodeller

  • Name
    400 - Bad Request
    Description

    Begäran var oacceptabel. Vanliga orsaker:

    • Saknad parameter: En krävd 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 överstiger teckengränsen.
  • Name
    401 - Unauthorized
    Description

    Autenticering misslyckades. Kontrollera din API-nyckel.

  • Name
    402 - Payment Required
    Description

    Otillräckliga 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
# Enkel förhandsgranskning med endast obligatoriska parametrar
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"
}'

# Förhandsgranskning med remesh och 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": "en futuristisk robotkrigare",
  "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örfina Uppgift

Denna endpoint skapar en Text till 3D förfina uppgift, som applicerar textur på ett avslutat förhandsgranskningsnät. Du måste ange preview_task_id från en lyckad förhandsgranskningsuppgift. Detta är det andra steget i arbetsflödet i två steg.

Parametrar

  • Name
    mode
    Type
    string
    Obligatorisk
    Description

    Detta fält ska sättas till "refine" när man skapar en förfina uppgift.

  • Name
    preview_task_id
    Type
    string
    Obligatorisk
    Description

    Det motsvarande förhandsgranskningsuppgifts-ID:t.

    Status för den angivna förhandsgranskningsuppgiften måste vara SUCCEEDED.

  • Name
    enable_pbr
    Type
    boolean
    standard false
    Description

    Generera PBR-mappar (metaller, ojämnhet, normal) utöver grundfärgen. En emissionskarta ingår också när ai_model är meshy-6, förutom vid texture_resolution: 8k (ingen emissionskarta produceras). meshy-7 (och latest) producerar inte en emissionskarta.

  • Name
    texture_resolution
    Type
    string
    standard 2k
    Description

    Grundfärgs texturupplösning. En av 2k (2048×2048), 4k (4096×4096), eller 8k (8192×8192). Högre upplösningar fångar mer ytdetalj. Gäller endast refine-läge.

  • 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

    Ange en extra textprompt för att guida textureringsprocessen. Max 600 tecken.

  • Name
    texture_image_url
    Type
    string
    Description

    Tillhandahåll en 2D-bild för att guida textureringsprocessen. Vi stöder för närvarande .jpg, .jpeg, och .png format.

    Det finns två sätt att tillhandahålla bilden:

    • Offentligt tillgänglig URL: En URL som är tillgänglig från det offentliga 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
    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, meshy-7, latest (Meshy 7).

  • Name
    moderation
    Type
    boolean
    standard false
    Description

    När den är inställd på true, kommer innehållet automatiskt att kontrolleras för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks kommer uppgiften inte att fortsätta 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öjdpunkter och skuggor från grundfärgstexturen, vilket ger ett renare resultat som fungerar bättre under anpassade ljusinställningar.

  • Name
    target_formats
    Type
    string[]
    Description

    Specificerar vilka 3D-filformat som ska inkluderas i utgången. Endast de begärda formaten kommer att genereras och returneras, vilket kan minska slutförandetiden för uppgiften. När det utelämnas inkluderas alla stödda format.

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

  • Name
    alpha_thumbnail
    Type
    boolean
    standard false
    Description

    När den är inställd på true, renderar uppgiften dessutom en version med transparent bakgrund (RGBA) av förhandsgranskningen och returnerar den som alpha_thumbnail_url på GET-svaret. Det befintliga thumbnail_url-fältet är oförändrat.

  • Name
    auto_size
    Type
    boolean
    standard false
    Description

    När den är inställd på true, använder tjänsten AI-vision för att automatiskt uppskatta objektets verkliga höjd och ändra storleken på modellen därefter. Ursprung kommer att standardinställas till bottom såvida inte origin_at uttryckligen är angivet.

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

    Position av ursprunget när auto_size är aktiverad.

    Tillgängliga värden: bottom, center.

Återkommer

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

Felmodeller

  • Name
    400 - Bad Request
    Description

    Begäran var oacceptabel. Vanliga orsaker:

    • Ogiltigt uppgifts-ID: preview_task_id är ogiltig eller finns inte.
    • Uppgift inte redo: Förhandsgranskningsuppgiften har inte lyckats än.
    • Modellmismatch: Förhandsgranskningsuppgiftens AI-modell är inkompatibel med den begärda förfiningsmodellen.
  • Name
    401 - Unauthorized
    Description

    Autenticering misslyckades. Kontrollera din API-nyckel.

  • Name
    402 - Payment Required
    Description

    Otillräckliga credits för att utföra denna uppgift.

  • Name
    404 - Not Found
    Description

    Förhandsgranskningsuppgiften specificerad 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
# Grundläggande förfiningsuppgift
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
}'

# Förfina med auto-size och 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 givet ett giltigt uppgifts id. Se Text till 3D Uppgiftsobjektet för att se vilka egenskaper som ingår med Text till 3D uppgiftsobjektet.

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

Parametrar

  • Name
    id
    Type
    path
    Description

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

Återkommer

Svaret innehåller Text till 3D uppgiftsobjektet. Kolla Text till 3D Uppgiftsobjektet sektionen för detaljer.

Exempel

LägeExempelmodell
FörhandsgranskningFörhandsgranskad modell
FörfinaFörfinad modell

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

Återkommer

Återkommer 200 OK vid framgång.

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

// Återkommer 200 Ok vid framgång.

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

    Sidstorleksbegränsning. 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.

Återkommer

Återkommer en paginerad lista över Text till 3D Uppgiftsobjekt.

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-uppgift som ska strömmas.

Återkommer

Återkommer en ström av Text till 3D Uppgiftsobjekt som Server-Sent Events.

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

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
}

Text till 3D Uppgiftsobjektet

Text till 3D Uppgiftsobjektet är en arbetsenhet som Meshy håller reda på för att generera en 3D-modell från en text inmatning. Det finns två steg i Text till 3D API, preview och refine. Förhandsgranskningssteget är för att generera en modell endast med nät, och förfiningssteget är för att generera en texturerad 3D-modell baserat på resultatet av förhandsgranskningssteget.

Objektet har följande egenskaper:

Egenskaper

  • Name
    id
    Type
    string
    Description

    Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-ID:n som implementeringsdetalj, bör du inte göra några antaganden om formatet på ID:t.

  • Name
    type
    Type
    string
    Description

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

  • 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 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
      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. Endast närvarande när 3mf begärdes via target_formats.

  • Name
    prompt
    Type
    string
    Description

    Detta är omodifierad prompt som användes för att skapa uppgiften.

  • Name
    negative_prompt
    Type
    string
    föråldrad
    Description

    Kvarstår för bakåtkompatibilitet. Detta fält har ingen funktionell inverkan på genererade modeller.

  • Name
    art_style
    Type
    string
    föråldrad
    Description

    Det omodifierade art_style som användes för att skapa förhandsgranskningsuppgiften. Ej stödd av Meshy-6.

  • Name
    texture_richness
    Type
    string
    föråldrad
    Description

    Kvarstår för bakåtkompatibilitet. Detta fält har ingen funktionell inverkan på genererade modeller.

  • Name
    texture_prompt
    Type
    string
    Description

    Extra textprompt som tillhandahålls för att vägleda textureringsprocessen under förfiningssteget.

  • Name
    ultra_mode
    Type
    boolean
    Description

    Återger ultra_mode-värdet som förhandsgranskningsuppgiften skapades med. Endast närvarande för meshy-7 (eller latest) förhandsgranskningsuppgifter som uttryckligen satte ultra_mode; utelämnas annars.

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

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Nedladdningsbar URL till en version med transparent bakgrund (RGBA) av thumbnail_url. Endast närvarande 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 release.

  • Name
    progress
    Type
    integer
    Description

    Framsteg för uppgiften. Om uppgiften inte har börjat än, kommer denna egenskap att vara 0. När uppgiften har lyckats, kommer denna att bli 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften inte har startat än, 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 avslutades, i millisekunder. Om uppgiften inte är avslutad än, 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 grundfärgskartsbilden.

    • Name
      metallic
      Type
      string
      Description

      Nedladdningsbar URL till metallkartansbilden.

    • Name
      normal
      Type
      string
      Description

      Nedladdningsbar URL till normalmap bild.

    • Name
      roughness
      Type
      string
      Description

      Nedladdningsbar URL till ojämnhetskartansbilden.

    • Name
      emission
      Type
      string
      Description

      Nedladdningsbar URL till emissionskartansbilden.

  • 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 full task_error-objektreferens.

  • Name
    consumed_credits
    Type
    integer
    Description

    Antalet credits som konsumeras av denna uppgift. Närvarande när uppgiftsstatusen är PENDING, IN_PROGRESS, eller SUCCEEDED. Returnerar 0 för FAILED uppgifter (credits återbetalas vid misslyckande).

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