Tekst naar 3D API

De 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 met deze API aan de slag te gaan.

Tekst naar 3D maakt gebruik van een workflow in twee stappen. Maak eerst een preview-taak (mode: "preview") om een 3D-mesh zonder textuur te genereren, zodat je de vorm kunt beoordelen. Geef vervolgens de taak-ID van de voltooide preview door aan een refine-taak (mode: "refine") om textuur op de mesh toe te passen. Beide stappen maken gebruik van dezelfde endpoint.


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

Create a Text to 3D Preview Task

Deze endpoint maakt een Text to 3D preview-taak aan, die een ongetextureerde 3D-mesh (alleen geometrie) genereert op basis van een tekstprompt. Dit is de eerste stap van de tweestapswerkwijze. Zodra de preview is geslaagd, gebruik je het geretourneerde taak-ID om een refine-taak aan te maken voor het aanbrengen van texturen. Raadpleeg The Text to 3D Task Object voor het volledige responsschema.

Parameters

  • Name
    mode
    Type
    string
    Verplicht
    Description

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

  • Name
    prompt
    Type
    string
    Verplicht
    Description

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

  • Name
    model_type
    Type
    string
    standaard standard
    Description

    Geef het type mesh-generatie op.

    Beschikbare waarden:

    • standard: Reguliere hoogwaardige mesh-generatie.
    • smart-topology: Kies het Smart Topology-model met ai_model (meshy-t2).
    • lowpoly (verouderd): Genereert een low-poly mesh die is geoptimaliseerd voor schonere polygonen. We raden aan in plaats daarvan smart-topology te gebruiken.
  • Name
    ai_model
    Type
    string
    standaard latest
    Description

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

    Standaardgeneratie (model_type: standard):

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (verouderd): gebruik in plaats daarvan meshy-7.1.

    Smart Topology-generatie (model_type: smart-topology):

    • meshy-t2 (standaard): het Smart Topology-model — schonere topology, van nature gescheiden onderdelen, driehoeksuitvoer, en een aantal vlakken dat je kunt instellen met target_polycount.
  • Name
    geometry_resolution
    Type
    string
    standaard standard
    Description

    Geometriegeneratiepas. 2k voert de Ultra-pas uit op 2048³; 4k voert deze uit op 4096³ voor het fijnste oppervlaktedetail.

    Beschikbare waarden: standard, 2k, 4k

  • Name
    ultra_mode
    Type
    boolean
    ⚠ verouderd
    standaard false
    Description

    Gebruik in plaats daarvan geometry_resolution. ultra_mode: true komt overeen met geometry_resolution: "2k".

  • Name
    should_remesh
    Type
    boolean
    standaard false (Meshy 6 and Meshy 7 models), true (others)
    Description

    Bepaalt of de remesh-fase wordt ingeschakeld. Voor het model met de hoogste kwaliteit raden we aan should_remesh in te stellen op false.

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

    Geef de topology van het gegenereerde model op.

    Beschikbare waarden:

    • quad: Genereert een mesh die overwegend uit vierhoeken bestaat.
    • triangle: Genereert een gedecimeerde driehoeksmesh.
  • Name
    decimation_mode
    Type
    integer
    Description

    Schakel adaptieve decimatie in door een polygonaantal-niveau in te stellen. Wanneer dit is 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

    Doelaantal polygonen (vlakken) in de uitvoer. Het werkelijke aantal kan afwijken van het doel, 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) tot ongeveer dit aantal. Bereik 100 tot 300.000, standaard 30.000. Als decimation_mode is ingesteld, heeft dit voorrang en wordt target_polycount genegeerd.
    • Smart Topology — met model_type: smart-topology en ai_model: meshy-t2. Het model wordt direct met dit aantal vlakken gegenereerd; er wordt geen remesh uitgevoerd en should_remesh is niet vereist. Bereik 100 tot 15.000, standaard 4.000.
  • Name
    symmetry_mode
    Type
    string
    ⚠ verouderd
    standaard auto
    Description

    Verouderd. Deze parameter heeft geen invloed meer op de uitvoer.

    Het veld symmetry_mode bepaalt het symmetriegedrag tijdens het genereren van het model.

    De geldige waarden zijn:

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

    Geef de pose-mode voor het gegenereerde model op.

    Beschikbare waarden:

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

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

  • Name
    art_style
    Type
    string
    ⚠ verouderd
    standaard realistic
    Description

    Niet ondersteund door Meshy-6. Aanvragen 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 mogelijk schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, gaat de taak niet verder naar generatie.

    De tekst uit prompt wordt gescreend.

  • Name
    target_formats
    Type
    string[]
    Description

    Geeft aan welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de aangevraagde formaten worden gegenereerd en geretourneerd, wat de doorlooptijd van de taak kan verkorten. Wanneer dit wordt weggelaten, worden alle ondersteunde formaten opgenomen.

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

  • Name
    alpha_thumbnail
    Type
    boolean
    standaard false
    Description

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

  • Name
    auto_size
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object te schatten en het model dienovereenkomstig van formaat te wijzigen. De oorsprong staat standaard op bottom, 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.

Returns

De eigenschap result van de respons bevat het taak-id van de nieuw aangemaakte Text to 3D-taak.

Foutmodi

  • Name
    400 - Bad Request
    Description

    Het verzoek was onaanvaardbaar. Veelvoorkomende 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.
    • Niet-ondersteund model voor low poly: ai_model: "meshy-6-lite" ondersteunt model_type: "lowpoly" niet.
    • Niet-ondersteund model voor Ultra: geometry_resolution vereist meshy-7.1 of latest.
  • 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.

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 Ultra 4K geometry, 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",
  "ai_model": "meshy-7.1",
  "geometry_resolution": "4k",
  "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

Create a Text to 3D Refine Task

Dit endpoint creëert een Text to 3D refine-taak, die een textuur toepast op een voltooide preview-mesh. U moet de preview_task_id opgeven van een geslaagde preview-taak. Dit is de tweede stap van de tweestapsworkflow.

Parameters

  • Name
    mode
    Type
    string
    Verplicht
    Description

    Dit veld moet worden ingesteld op "refine" bij het aanmaken van een refine-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. Er wordt ook een emission map meegeleverd wanneer ai_model is ingesteld op meshy-6, behalve bij texture_resolution: 8k (dan wordt geen emission map geproduceerd). meshy-6-lite, meshy-7.1 en latest produceren geen emission map.

  • Name
    texture_resolution
    Type
    string
    standaard 2k
    Description

    Resolutie van de basiskleurtextuur. Een van 2k (2048×2048), 4k (4096×4096), of 8k (8192×8192). Hogere resoluties leggen meer oppervlaktedetail vast. Geldt alleen voor de refine-mode.

  • Name
    hd_texture
    Type
    boolean
    ⚠ verouderd
    standaard false
    Description

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

  • Name
    texture_prompt
    Type
    string
    Description

    Geef een aanvullende tekstprompt op om het textureringsproces te sturen. Maximaal 800 tekens.

  • Name
    texture_image_url
    Type
    string
    Description

    Geef een 2D-afbeelding op om het textureringsproces te sturen. We ondersteunen momenteel de formaten .jpg, .jpeg, en .png.

    Er zijn twee manieren om de afbeelding op te geven:

    • Publiek 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 inherited from the preview task
    Description

    ID van het model dat gebruikt wordt voor het refinen.

    Beschikbare waarden:

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (verouderd): gebruik in plaats daarvan meshy-7.1.

    Laat deze parameter weg om het model over te nemen dat door de preview-taak wordt gebruikt, zodat een preview en de bijbehorende refine end-to-end op hetzelfde model blijven. Geef een expliciete waarde op om deze overname te overschrijven.

  • 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, gaat de taak niet door naar generatie.

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

  • Name
    remove_lighting
    Type
    boolean
    standaard true
    Description

    Verwijdert highlights en schaduwen uit de basiskleurtextuur, wat een schoner resultaat oplevert dat beter werkt onder aangepaste belichtingsopstellingen.

  • Name
    target_formats
    Type
    string[]
    Description

    Geeft aan welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de aangevraagde formaten worden gegenereerd en geretourneerd, wat de voltooiingstijd van de taak kan verkorten. Indien weggelaten, worden alle ondersteunde formaten opgenomen.

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

  • Name
    alpha_thumbnail
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, rendert de taak bovendien een versie van de preview met transparante achtergrond (RGBA) en retourneert deze als alpha_thumbnail_url in het GET-antwoord. Het bestaande veld thumbnail_url blijft ongewijzigd.

  • Name
    auto_size
    Type
    boolean
    standaard false
    Description

    Wanneer ingesteld op true, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object te schatten en het model dienovereenkomstig aan te passen. De oorsprong staat standaard op bottom, 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.

Returnwaarden

De result-eigenschap van het antwoord bevat de taak-id van de nieuw aangemaakte Text to 3D-taak.

Foutmodi

  • Name
    400 - Bad Request
    Description

    Het verzoek was onacceptabel. Veelvoorkomende oorzaken:

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

    Authenticatie mislukt. Controleer uw API-sleutel.

  • Name
    402 - Payment Required
    Description

    Onvoldoende credits om deze taak uit te voeren.

  • Name
    404 - Not Found
    Description

    De preview-taak die is opgegeven via preview_task_id is niet gevonden.

  • Name
    429 - Too Many Requests
    Description

    U heeft uw rate limit overschreden.

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

Een Text to 3D-taak ophalen

Met dit endpoint kun je een Tekst naar 3D-taak ophalen op basis van een geldige taak-id. Raadpleeg Het Text to 3D-taakobject om te zien welke eigenschappen zijn opgenomen in het Text to 3D-taakobject.

Dit endpoint werkt zowel voor preview- als refine-taken.

Parameters

  • Name
    id
    Type
    path
    Description

    Unieke identifier van de op te halen Text to 3D-taak.

Retourwaarden

De response bevat het Text to 3D-taakobject. Raadpleeg de sectie Het Text to 3D-taakobject voor details.

Voorbeelden

ModeVoorbeeldmodel
PreviewPreview model
RefineRefined 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

Een Tekst naar 3D-taak verwijderen

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

Padparameters

  • Name
    id
    Type
    path
    Description

    De ID van de Tekst naar 3D-taak die verwijderd moet worden.

Taakstatus

Een taak die nog PENDING is, wordt verwijderd en de credits die bij het aanmaken zijn verbruikt, worden terugbetaald.

Een taak die al IN_PROGRESS is, kan niet worden verwijderd: het verzoek wordt afgewezen met 409 Conflict en de taak blijft doorlopen. Credits voor een taak waarmee de worker al is begonnen, zijn niet terugvorderbaar, dus door deze halverwege te verwijderen zou je zowel de credits als het resultaat kwijtraken. Wacht tot de taak SUCCEEDED, FAILED of CANCELED bereikt, en verwijder deze dan.

Een taak in een eindtoestand (SUCCEEDED, FAILED of CANCELED) wordt verwijderd zonder terugbetaling.

Retourwaarden

Geeft 200 OK terug bij succes, of 409 Conflict wanneer de taak IN_PROGRESS is.

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

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

List Text to 3D Tasks

Deze endpoint stelt je in staat 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

    Limiet voor paginagrootte. Maximaal toegestaan is 100 items.

  • Name
    sort_by
    Type
    string
    Description

    Veld om op te sorteren.

    Beschikbare waarden:

    • +created_at: Sorteer op aanmaaktijd in oplopende volgorde.
    • -created_at: Sorteer op aanmaaktijd in aflopende volgorde.

Retourneert

Retourneert een gepagineerde lijst van The Text to 3D Task Objects.

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

Stream een Text to 3D Taak

Deze 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 die gestreamd moet worden.

Retourneert

Retourneert een stream van De Text to 3D Task Objects als Server-Sent Events.

Voor taken met status PENDING of IN_PROGRESS bevat de responsstream alleen de noodzakelijke velden progress en 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
}

The Text to 3D Task Object

Het Text to 3D Task-object is een werkeenheid die Meshy bijhoudt om een 3D-model te genereren op basis van een tekst-invoer. Er zijn twee fasen van de Text to 3D API, preview en refine. De preview-fase is voor het genereren van een 3D-model dat alleen uit een mesh bestaat, en de refine-fase is voor het genereren van een getextureerd 3D-model op basis van het resultaat van de preview-fase.

Het object heeft de volgende eigenschappen:

Eigenschappen

  • Name
    id
    Type
    string
    Description

    Unieke identifier voor de taak. Hoewel we een k-sorteerbare UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames doen over het formaat van de id.

  • Name
    type
    Type
    string
    Description

    Type van de Text to 3D-taak. Mogelijke waarden zijn text-to-3d-preview voor taken in de preview-fase en text-to-3d-refine voor taken in de refine-fase.

  • Name
    model_urls
    Type
    object
    Description

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

    • 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 is aangevraagd via target_formats.

  • Name
    prompt
    Type
    string
    Description

    Dit is de ongewijzigde prompt die is gebruikt om de taak aan te maken.

  • Name
    negative_prompt
    Type
    string
    ⚠ verouderd
    Description

    Behouden voor achterwaartse compatibiliteit. Dit veld heeft geen functionele invloed op gegenereerde modellen.

  • Name
    art_style
    Type
    string
    ⚠ verouderd
    Description

    De ongewijzigde art_style die is gebruikt om de preview-taak aan te maken. Niet ondersteund door Meshy-6.

  • Name
    texture_richness
    Type
    string
    ⚠ verouderd
    Description

    Behouden voor achterwaartse compatibiliteit. Dit veld heeft geen functionele invloed op gegenereerde modellen.

  • Name
    texture_prompt
    Type
    string
    Description

    Aanvullende tekstprompt die wordt gebruikt om het textureringsproces tijdens de refine-fase te sturen.

  • Name
    ultra_mode
    Type
    boolean
    ⚠ verouderd
    Description

    Verouderd; lees in plaats daarvan geometry_resolution.

  • Name
    geometry_resolution
    Type
    string
    Description

    De Ultra-tier waarmee de preview-taak is uitgevoerd (2k of 4k); wordt weggelaten voor standard.

  • Name
    texture_image_url
    Type
    string
    Description

    Downloadbare URL naar de textuurafbeelding die is gebruikt om het textureringsproces te sturen.

  • 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 versie van thumbnail_url met transparante achtergrond (RGBA). Alleen aanwezig wanneer de taak is aangemaakt met alpha_thumbnail: true en de transparante preview succesvol is gerenderd; anders wordt dit veld weggelaten.

  • Name
    video_url
    Type
    string
    ⚠ verouderd
    Description

    Downloadbare URL naar de previewvideo. Wordt in een toekomstige release verwijderd.

  • Name
    progress
    Type
    integer
    Description

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

  • Name
    started_at
    Type
    timestamp
    Description

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

  • Name
    created_at
    Type
    timestamp
    Description

    Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.

  • Name
    finished_at
    Type
    timestamp
    Description

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

  • 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 array van texture URL-objecten die door de taak zijn gegenereerd. Normaal gesproken bevat dit slechts één texture URL-object. Elke texture URL heeft de volgende eigenschappen:

    • Name
      base_color
      Type
      string
      Description

      Downloadbare URL naar de base color map-afbeelding.

    • Name
      metallic
      Type
      string
      Description

      Downloadbare URL naar de metallic map-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 emission map-afbeelding.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Het aantal voorafgaande taken.

  • Name
    task_error
    Type
    object
    Description

    Foutdetails voor mislukte taken. Zie Fouten voor de volledige referentie van het task_error-object.

  • 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. Geeft 0 terug voor FAILED-taken (credits worden terugbetaald bij mislukking).

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
}