Tekst naar 3D API

Tekst naar 3D API is een functie waarmee je de Tekst naar 3D mogelijkheden van Meshy in je eigen applicatie kunt integreren. In dit gedeelte vind je alle informatie die je nodig hebt om te beginnen met deze API.

Tekst naar 3D gebruikt een stappenworkflow met twee stappen. Maak eerst een preview taak (mode: "preview") om een 3D mesh zonder textuur te genereren, zodat je de vorm kunt evalueren. Geef vervolgens de voltooide preview-taak-ID door aan een verfijn taak (mode: "refine") om textuur op de mesh toe te passen. Beide stappen delen hetzelfde endpoint.


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

Maak een Tekst naar 3D Preview Taak

Dit endpoint maakt een Tekst naar 3D preview taak aan, die een ongetextureerde 3D mesh (alleen geometrie) genereert uit een tekstprompt. Dit is de eerste stap van de tweestapsworkflow. Zodra de preview slaagt, gebruik je de geretourneerde taak-ID om een verfijn taak te maken voor texturering. Verwijs naar Het Tekst naar 3D Taak Object voor het volledige reactieschema.

Parameters

  • Name
    mode
    Type
    string
    Verplicht
    Description

    Dit veld moet worden ingesteld op "preview" bij het maken van een preview taak.

  • Name
    prompt
    Type
    string
    Verplicht
    Description

    Beschrijf wat voor soort object het 3D-model is. Maximaal 600 tekens.

  • Name
    model_type
    Type
    string
    standaard standard
    Description

    Specificeer het type 3D mesh-generatie.

    Beschikbare waarden:

    • standard: Reguleren hoge-detail 3D mesh-generatie.
    • smart-topology: Kies het Smart Topology model met ai_model (meshy-t2).
    • lowpoly (verouderd): Genereert low-poly mesh geoptimaliseerd voor schonere polygonen. We raden aan om smart-topology te gebruiken.
  • Name
    ai_model
    Type
    string
    standaard latest
    Description

    ID van het model om te gebruiken. De beschikbare waarden zijn afhankelijk van model_type.

    Standaard generatie (model_type: standard):

    • meshy-5, meshy-6, meshy-7, latest (Meshy 7)

    Smart Topology generatie (model_type: smart-topology):

    • meshy-t2 (standaard): het Smart Topology model — schonere topology, inheemse gescheiden delen, driehoekuitvoer, en een aantal gezichten dat je kunt instellen met target_polycount.
  • Name
    ultra_mode
    Type
    boolean
    standaard false
    Description

    Schakelt Ultra-generatie in voor hogere getrouwheidsgeometrie met fijnere oppervlakte-detail. Generatie duurt langer en voegt 5 credits toe.

  • Name
    should_remesh
    Type
    boolean
    standaard false (meshy-6, meshy-7), true (anderen)
    Description

    Bepaalt of de remesh fase ingeschakeld moet worden. Voor het hoogste-kwaliteitmodel raden we aan should_remesh in te stellen op false.

Alleen van toepassing wanneer should_remesh = true
  • Name
    topology
    Type
    string
    standaard triangle
    Description

    Specificeer de topology van het gegenereerde model.

    Beschikbare waarden:

    • quad: Genereer een quad-dominante mesh.
    • triangle: Genereer een gedecimeerde driehoekmesh.
  • Name
    decimation_mode
    Type
    integer
    Description

    Schakel adaptieve decimatie in door een polygonaal niveau in te stellen. Wanneer ingesteld, wordt target_polycount genegeerd.

    Beschikbare waarden:

    • 1: Adaptief — ultra polygonaantal.
    • 2: Adaptief — hoog polygonaantal.
    • 3: Adaptief — gemiddeld polygonaantal.
    • 4: Adaptief — laag polygonaantal.
  • Name
    target_polycount
    Type
    integer
    Description

    Gewenst aantal polygonen (vlakken) in de uitvoer. Het werkelijke aantal kan afwijken van de doelstelling, afhankelijk van de geometrie.

    target_polycount heeft effect in twee onafhankelijke gevallen:

    • Remesh — met should_remesh: true op een standard model. De mesh wordt geremesht (gedecimeerd) naar ongeveer dit aantal. Bereik 100 tot 300.000, standaard 30.000. Als decimation_mode is ingesteld, krijgt dit voorrang en wordt target_polycount genegeerd.
    • Smart Topology — met model_type: smart-topology en ai_model: meshy-t2. Het model wordt direct bij dit gezichtsgetal gegenereerd; geen remesh wordt uitgevoerd en should_remesh is niet vereist. Bereik 100 tot 15.000, standaard 4.000.
  • Name
    symmetry_mode
    Type
    string
    standaard auto
    Description

    Verouderd. Deze parameter beïnvloedt de uitvoer niet meer.

    Het symmetry_mode veld regelt het symmetriegedrag tijdens het modelgeneratieproces.

    De geldige waarden zijn:

    • off: Schakelt symmetrie uit.
    • auto: Bepaalt automatisch en past symmetrie toe op basis van invoergeometrie.
    • on: Handhaaft symmetrie tijdens de generatie.
  • Name
    pose_mode
    Type
    string
    standaard ""
    Description

    Specificeer de pose mode voor het gegenereerde model.

    Beschikbare waarden:

    • a-pose: Genereer het model in een A pose.
    • t-pose: Genereer het model in een T pose.
    • "" (lege string): Geen specifieke pose toegepast.
  • Name
    is_a_t_pose
    Type
    boolean
    standaard false
    Description

    Gebruik pose_mode in plaats daarvan. Of het model in een A/T pose moet worden gegenereerd.

  • Name
    art_style
    Type
    string
    standaard realistic
    Description

    Niet ondersteund door Meshy-6. Verzoeken met Meshy-6 negeren art_style, en sommige combinaties kunnen fouten veroorzaken. Beschikbare waarden: realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, wordt de invoerinhoud automatisch gescreend op potentieel schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, zal de taak niet doorgaan naar generatie.

    De tekst uit prompt zal worden gescreend.

  • Name
    target_formats
    Type
    string[]
    Description

    Specificeert welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de aangevraagde formaten worden gegenereerd en geretourneerd, wat de taakvoltooiingstijd kan verkorten. Wanneer weggelaten, zijn alle ondersteunde formaten inbegrepen.

    Beschikbare waarden: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, renderert de taak ook een transparante achtergrond (RGBA) versie van de preview en retourneert deze als alpha_thumbnail_url in de GET-reactie. Het bestaande thumbnail_url veld blijft ongewijzigd.

  • Name
    auto_size
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, gebruikt de service AI-visie om automatisch de reële hoogte van het object te schatten en het model dienovereenkomstig te schalen. De oorsprong zal standaard naar bottom gaan, tenzij origin_at expliciet is ingesteld.

Alleen van toepassing wanneer auto_size = true
  • Name
    origin_at
    Type
    string
    standaard bottom
    Description

    Positie van de oorsprong wanneer auto_size is ingeschakeld.

    Beschikbare waarden: bottom, center.

Retourneert

De result eigenschap van de reactie bevat de taak id van de nieuw aangemaakte Tekst naar 3D taak.

Mislukkingsmodi

  • Name
    400 - Bad Request
    Description

    Het verzoek was onaanvaardbaar. Veel voorkomende oorzaken:

    • Ontbrekende parameter: Een vereiste parameter (bijv. prompt, mode) ontbreekt.
    • Ongeldige parameter: art_style is niet een van de toegestane waarden.
    • Prompt te lang: De prompt overschrijdt de tekenlimiet.
  • Name
    401 - Unauthorized
    Description

    Authenticatie mislukt. Controleer je API-sleutel.

  • Name
    402 - Payment Required
    Description

    Onvoldoende credits om deze taak uit te voeren.

  • Name
    429 - Too Many Requests
    Description

    Je hebt je rate limit overschreden.

Verzoek

POST
/openapi/v2/text-to-3d
# Eenvoudige preview met alleen vereiste parameters
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 met remesh en 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"]
}'

Reactie

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

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

Maak een Tekst naar 3D Verfijn Taak

Dit endpoint maakt een Tekst naar 3D verfijn taak aan, die textuur aan een voltooide preview mesh toevoegt. Je moet de preview_task_id van een geslaagde preview taak opgeven. Dit is de tweede stap van de tweestapsworkflow.

Parameters

  • Name
    mode
    Type
    string
    Verplicht
    Description

    Dit veld moet worden ingesteld op "refine" bij het maken van een verfijn taak.

  • Name
    preview_task_id
    Type
    string
    Verplicht
    Description

    De bijbehorende preview taak id.

    De status van de opgegeven preview taak moet SUCCEEDED zijn.

  • Name
    enable_pbr
    Type
    boolean
    standaard false
    Description

    Genereer PBR Maps (metallic, roughness, normal) naast de basiskleur. Een emissiekaart is ook inbegrepen wanneer ai_model meshy-6 is, behalve bij texture_resolution: 8k (geen emissiekaart wordt geproduceerd). meshy-7 (en latest) produceert geen emissiekaart.

  • Name
    texture_resolution
    Type
    string
    standaard 2k
    Description

    Resolutie van basiskleurtexturen. Een van 2k (2048×2048), 4k (4096×4096) of 8k (8192×8192). Hogere resoluties leggen meer oppervlakdetail vast. Alleen van toepassing op de refine mode.

  • Name
    hd_texture
    Type
    boolean
    standaard false
    Description

    Gebruik texture_resolution in plaats daarvan — equivalent aan texture_resolution: "4k". Wanneer beide zijn ingesteld, krijgt texture_resolution voorrang.

  • Name
    texture_prompt
    Type
    string
    Description

    Geef een aanvullende tekstprompt om het textureerproces te leiden. Maximaal 600 tekens.

  • Name
    texture_image_url
    Type
    string
    Description

    Bied een 2D-afbeelding aan om het textureerproces te leiden. We ondersteunen momenteel .jpg, .jpeg, en .png formats.

    Er zijn twee manieren om de afbeelding te verstrekken:

    • Openbaar toegankelijke URL: Een URL die toegankelijk is vanaf het openbare internet
    • Data URI: Een base64-gecodeerde Data URI van de afbeelding. Voorbeeld van een Data URI: data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    ai_model
    Type
    string
    standaard latest
    Description

    ID van het model dat voor verfijning moet worden gebruikt. Beschikbare waarden: meshy-5, meshy-6, meshy-7, latest (Meshy 7).

  • Name
    moderation
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, wordt de invoerinhoud automatisch gescreend op potentieel schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, zal de taak niet doorgaan naar generatie.

    Zowel de tekst uit texture_prompt als de afbeelding uit texture_image_url zullen worden gescreend.

  • Name
    remove_lighting
    Type
    boolean
    standaard true
    Description

    Verwijdert highlights en schaduwen uit de basiskleurtextuur, wat resulteert in een schoner resultaat dat beter werkt onder aangepaste verlichtingsopstellingen.

  • Name
    target_formats
    Type
    string[]
    Description

    Specificeert welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de aangevraagde formaten worden gegenereerd en geretourneerd, wat de taakvoltooiingstijd kan bekorten. Wanneer weggelaten, zijn alle ondersteunde formaten inbegrepen.

    Beschikbare waarden: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, renderert de taak ook een transparante achtergrond (RGBA) versie van de preview en retourneert deze als alpha_thumbnail_url in de GET-reactie. Het bestaande thumbnail_url veld blijft ongewijzigd.

  • Name
    auto_size
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, gebruikt de service AI-visie om automatisch de reële hoogte van het object te schatten en het model dienovereenkomstig te schalen. De oorsprong zal standaard naar bottom gaan, tenzij origin_at expliciet is ingesteld.

Alleen van toepassing wanneer auto_size = true
  • Name
    origin_at
    Type
    string
    standaard bottom
    Description

    Positie van de oorsprong wanneer auto_size is ingeschakeld.

    Beschikbare waarden: bottom, center.

Retourneert

De result eigenschap van de reactie bevat de taak id van de nieuw aangemaakte Tekst naar 3D taak.

Mislukkingsmodi

  • Name
    400 - Bad Request
    Description

    Het verzoek was onaanvaardbaar. Veel voorkomende oorzaken:

    • Ongeldige taak-ID: De preview_task_id is ongeldig of bestaat niet.
    • Taak niet klaar: De preview taak is nog niet geslaagd.
    • Modelmismatch: Het AI-model van de preview taak is niet compatibel met het gevraagde verfijn model.
  • Name
    401 - Unauthorized
    Description

    Authenticatie mislukt. Controleer je API-sleutel.

  • Name
    402 - Payment Required
    Description

    Onvoldoende credits om deze taak uit te voeren.

  • Name
    404 - Not Found
    Description

    De preview taak gespecificeerd door preview_task_id is niet gevonden.

  • Name
    429 - Too Many Requests
    Description

    Je hebt je rate limit overschreden.

Verzoek

POST
/openapi/v2/text-to-3d
# Basis verfijn taak
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
}'

# Verfijn met auto-size en GLB formaat
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
}'

Reactie

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

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

Haal een Tekst naar 3D Taak Op

Dit endpoint stelt je in staat om een Tekst naar 3D taak op te halen, gegeven een geldige taak id. Verwijs naar Het Tekst naar 3D Taak Object om te zien welke eigenschappen zijn inbegrepen bij het Tekst naar 3D taakobject.

Dit endpoint werkt voor zowel preview- als verfijntaken.

Parameters

  • Name
    id
    Type
    path
    Description

    Unieke identificatie voor de Tekst naar 3D taak om op te halen.

Retourneert

De reactie bevat het Tekst naar 3D taakobject. Check Het Tekst naar 3D Taak Object sectie voor details.

Voorbeelden

ModeVoorbeeldmodel
PreviewVoorbeeldmodel
RefineVerfijnd model

Verzoek

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

Reactie

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

Verwijder een Tekst naar 3D Taak

Dit endpoint verwijdert permanent een Tekst naar 3D taak, inclusief alle bijbehorende modellen en gegevens. Deze actie is onomkeerbaar.

Pad Parameters

  • Name
    id
    Type
    path
    Description

    De ID van de Tekst naar 3D taak om te verwijderen.

Retourneert

Retourneert 200 OK bij succes.

Verzoek

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

Reactie

// Retourneert 200 Ok bij succes.

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

Lijst Tekst naar 3D Taken

Dit endpoint stelt je in staat om een lijst van Tekst naar 3D taken op te halen.

Parameters

  • Name
    page_num
    Type
    integer
    standaard 1
    Description

    Paginanummer voor paginering.

  • Name
    page_size
    Type
    integer
    standaard 10
    Description

    Paginagrootte limiet. Maximaal toegestaan is 50 items.

  • Name
    sort_by
    Type
    string
    Description

    Veld om te sorteren.

    Beschikbare waarden:

    • +created_at: Sorteren op creatietijd in oplopende volgorde.
    • -created_at: Sorteren op creatietijd in aflopende volgorde.

Retourneert

Retourneert een gepagineerde lijst van De Tekst naar 3D Taak Objecten.

Verzoek

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

Reactie

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

Stream een Tekst naar 3D Taak

Dit endpoint streamt realtime updates voor een Tekst naar 3D taak met behulp van Server-Sent Events (SSE).

Parameters

  • Name
    id
    Type
    path
    Description

    Unieke identificatie voor de Tekst naar 3D taak om te streamen.

Retourneert

Retourneert een stream van Het Tekst naar 3D Taak Objecten als Server-Sent Events.

Voor PENDING of IN_PROGRESS taken, de reactiestroom zal alleen de benodigde progress en status velden bevatten.

Verzoek

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

// Foutgebeurtenisvoorbeeld
event: error
data: {
  "status_code": 404,
  "message": "Taak niet gevonden"
}

// Berichtgebeurtenisvoorbeelden illustreren taakvoortgang.
// Voor PENDING of IN_PROGRESS taken, zal de reactiestroom niet alle velden bevatten.
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
}

Het Tekst naar 3D Taak Object

Het Tekst naar 3D Taak Object is een werkunit die Meshy bijhoudt om een 3D-model te genereren vanuit een tekst input. Er zijn twee stadia van de Tekst naar 3D API, preview en refine. Het preview stadium is voor het genereren van een alleen-mesh 3D-model, en het verfijn stadium is voor het genereren van een getextureerd 3D-model op basis van het resultaat van het preview stadium.

Het object heeft de volgende eigenschappen:

Eigenschappen

  • Name
    id
    Type
    string
    Description

    Unieke identificatie voor de taak. Terwijl we een k-sorteerbare UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames maken over het format van de id.

  • Name
    type
    Type
    string
    Description

    Type van de Tekst naar 3D taak. Mogelijke waarden zijn text-to-3d-preview voor preview stadium taken en text-to-3d-refine voor verfijn stadium taken.

  • Name
    model_urls
    Type
    object
    Description

    Downloadbare URL naar het getextureerde 3D-modelbestand gegenereerd door Meshy. De eigenschap voor een formaat wordt weggelaten als het formaat niet wordt gegenereerd in plaats van een lege string te retourneren.

    • Name
      glb
      Type
      string
      Description

      Downloadbare URL naar het GLB-bestand.

    • Name
      fbx
      Type
      string
      Description

      Downloadbare URL naar het FBX-bestand.

    • Name
      usdz
      Type
      string
      Description

      Downloadbare URL naar het USDZ-bestand.

    • Name
      obj
      Type
      string
      Description

      Downloadbare URL naar het OBJ-bestand.

    • Name
      mtl
      Type
      string
      Description

      Downloadbare URL naar het MTL-bestand.

    • Name
      stl
      Type
      string
      Description

      Downloadbare URL naar het STL-bestand.

    • Name
      3mf
      Type
      string
      Description

      Downloadbare URL naar het 3MF-bestand. Alleen aanwezig wanneer 3mf was aangevraagd via target_formats.

  • Name
    prompt
    Type
    string
    Description

    Dit is de onbewerkte prompt die werd gebruikt om de taak te maken.

  • Name
    negative_prompt
    Type
    string
    Description

    Onderhouden voor achterwaartse compatibiliteit. Dit veld heeft geen functionele impact op gegenereerde modellen.

  • Name
    art_style
    Type
    string
    Description

    De onbewerkte art_style die werd gebruikt om de preview taak te maken. Niet ondersteund door Meshy-6.

  • Name
    texture_richness
    Type
    string
    Description

    Onderhouden voor achterwaartse compatibiliteit. Dit veld heeft geen functionele impact op gegenereerde modellen.

  • Name
    texture_prompt
    Type
    string
    Description

    Aanvullende tekstprompt verstrekt om het texturering proces tijdens het verfijn stadium te leiden.

  • Name
    ultra_mode
    Type
    boolean
    Description

    Echoët de ultra_mode waarde die de preview taak werd gemaakt met. Alleen aanwezig voor meshy-7 (of latest) preview taken die expliciet ultra_mode instelden; anders weggelaten.

  • Name
    texture_image_url
    Type
    string
    Description

    Downloadbare URL naar de textureafbeelding die werd gebruikt om het texturering proces te leiden.

  • Name
    thumbnail_url
    Type
    string
    Description

    Downloadbare URL naar de thumbnail afbeelding van het modelbestand.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Downloadbare URL naar een transparante achtergrond (RGBA) versie van thumbnail_url. Alleen aanwezig wanneer de taak werd gecreëerd met alpha_thumbnail: true en de transparante preview succesvol werd gerenderd; anders wordt dit veld weggelaten.

  • Name
    video_url
    Type
    string
    Description

    Downloadbare URL naar de preview video. Zal in een toekomstige release worden verwijderd.

  • Name
    progress
    Type
    integer
    Description

    Voortgang van de taak. Als de taak nog niet is gestart, zal deze eigenschap 0 zijn. Zodra de taak is geslaagd, wordt dit 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Tijdstempel van wanneer de taak werd gestart, in milliseconden. Als de taak nog niet is gestart, zal deze eigenschap 0 zijn.

  • Name
    created_at
    Type
    timestamp
    Description

    Tijdstempel van wanneer de taak werd gecreëerd, in milliseconden.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tijdstempel van wanneer de taak werd voltooid, in milliseconden. Als de taak nog niet is voltooid, zal deze eigenschap 0 zijn.

  • Name
    status
    Type
    string
    Description

    Status van de taak. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    texture_urls
    Type
    array
    Description

    Een lijst van textuur URL-objecten die zijn gegenereerd uit de taak. Normaal gesproken bevat dit slechts één textuur URL-object. Elke textuur URL heeft de volgende eigenschappen:

    • Name
      base_color
      Type
      string
      Description

      Downloadbare URL naar de basiskleurkaart afbeelding.

    • Name
      metallic
      Type
      string
      Description

      Downloadbare URL naar de metallic kaart afbeelding.

    • Name
      normal
      Type
      string
      Description

      Downloadbare URL naar de normal map afbeelding.

    • Name
      roughness
      Type
      string
      Description

      Downloadbare URL naar de roughness map afbeelding.

    • Name
      emission
      Type
      string
      Description

      Downloadbare URL naar de emissiekaart afbeelding.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Het aantal voorgaande taken.

  • Name
    task_error
    Type
    object
    Description

    Foutdetails voor mislukte taken. Zie Fouten voor de volledige task_error objectreferentie.

  • Name
    consumed_credits
    Type
    integer
    Description

    Het aantal credits dat door deze taak is verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS, of SUCCEEDED is. Retourneert 0 voor FAILED taken (credits worden terugbetaald bij falen).

Voorbeeld Tekst naar 3D Taak 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
}