lowpoly wordt op 30 okt 2026 uitgefaseerd. Stap vóór deze datums over op een ander model om fouten bij verzoeken te voorkomen. Alle afschaffingen bekijken

Tekst naar 3D API

Genereer 3D-modellen op basis van tekstprompts in uw eigen applicatie.

Tekst naar 3D werkt in twee stappen. Maak eerst een preview-taak (mode: "preview") om een 3D-mesh zonder textuur te genereren, zodat u de vorm kunt controleren. Stuur vervolgens het taak-ID van de geslaagde preview naar een refine-taak (mode: "refine") om de mesh te voorzien van textuur. Beide stappen gebruiken hetzelfde endpoint.


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

Een Text to 3D preview-taak aanmaken

Maakt een Tekst naar 3D preview-taak aan, die een ongetextureerde 3D-mesh (alleen geometrie) genereert op basis van een tekstprompt. Dit is de eerste stap van de workflow in twee stappen. Nadat de preview is geslaagd, stuur je de taak-ID ervan in een refine-taak om de mesh te textureren. Zie Een Text to 3D refine-taak aanmaken. Voor het volledige responsschema, zie Het Text to 3D-taakobject.

De taak wordt op de achtergrond uitgevoerd. Voor hoelang een taak doorgaans duurt, zie Verwerkingstijden.

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

Parameters

  • Name
    mode
    Type
    string
    Verplicht
    Description

    De stap van de workflow in twee stappen. Stuur preview om een preview-taak aan te maken.

  • Name
    prompt
    Type
    string
    Verplicht
    Description

    Tekst die het te genereren object beschrijft, tot 800 tekens. Langere tekst geeft 400 terug.

  • Name
    model_type
    Type
    string
    standaard standard
    Description

    Het type 3D-mesh dat gegenereerd moet worden.

    Beschikbare waarden:

    • standard: een 3D-mesh met hoog detailniveau
    • smart-topology: een Smart Topology-mesh. Kies het model met ai_model (meshy-t2 of meshy-t2.5).

    Bij smart-topology negeert Meshy should_remesh en decimation_mode, en accepteert het alleen topology: triangle.

  • Name
    ai_model
    Type
    string
    standaard latest
    Description

    Het AI-model dat het 3D-model genereert. De beschikbare waarden zijn afhankelijk van model_type.

    Standaardmodellen (model_type: standard):

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

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

    • meshy-t2: schonere topology, van nature gescheiden onderdelen, triangle-output, en een polygoonaantal dat je instelt met target_polycount
    • meshy-t2.5 (standaard): scherper detail voor game-assets, triangle-output, en een polygoonaantal dat je instelt met target_polycount

    Zie Modellen voor welk model bij jouw project past, zoals een gamekarakter of een 3D-print.

  • Name
    geometry_resolution
    Type
    string
    standaard standard
    Description

    De geometrie-generatiepas. Geldt alleen voor preview-taken. Een refine met deze parameter geeft 400 terug.

    Beschikbare waarden:

    • standard
    • 2k: voert de Ultra-pas uit op 2048³
    • 4k: voert de Ultra-pas uit op 4096³, voor fijner oppervlaktedetail

    2k vereist meshy-7.1, latest, of het verouderde meshy-7. 4k vereist meshy-7.1 of latest. Andere modellen geven 400 terug.

  • Name
    ultra_mode
    Type
    boolean
    ⚠ verouderd
    standaard false
    Description

    Stuur in plaats daarvan geometry_resolution. ultra_mode: true is hetzelfde als geometry_resolution: "2k".

  • Name
    should_remesh
    Type
    boolean
    standaard true (meshy-6-lite), false (other models)
    Description

    Of het model na generatie opnieuw gemesht moet worden. Stuur voor het 3D-model van de hoogste kwaliteit false.

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

    Het facetype van het opnieuw gemeshte model.

    Beschikbare waarden:

    • quad: een overwegend uit quads bestaande mesh
    • triangle: een gedecimeerde triangle-mesh

    Smart Topology-output bestaat alleen uit triangles. Het sturen van quad met ai_model meshy-t2 of meshy-t2.5 geeft 400 terug.

  • Name
    decimation_mode
    Type
    integer
    Description

    Adaptief polygoonaantal, per niveau. Wanneer je dit instelt, negeert Meshy target_polycount.

    Beschikbare waarden:

    • 1: ultra
    • 2: hoog
    • 3: gemiddeld
    • 4: laag
  • Name
    target_polycount
    Type
    integer
    Description

    Het aantal polygonen om naar te streven. Het resultaat kan afwijken van het doel, afhankelijk van de geometrie. Dit geldt in twee afzonderlijke gevallen:

    • Remesh: met should_remesh: true op een standard-model. Meshy remesht (decimeert) de mesh tot ongeveer dit aantal. Als je decimation_mode instelt, gebruikt Meshy dat en negeert het target_polycount.
    • Smart Topology: met model_type: smart-topology en ai_model meshy-t2 of meshy-t2.5. Meshy genereert het model direct met dit polygoonaantal. Er wordt geen remesh uitgevoerd, en je hebt should_remesh niet nodig.

    De volgende tabel toont het bereik en de standaardwaarde voor elk geval:

    GevalBereikStandaard
    Remesh100 tot 30000030000
    meshy-t2100 tot 150004000
    meshy-t2.5100 tot 3000015000

    Een waarde buiten het bereik geeft 400 terug.

    Gebruik voor een low-poly game-asset een Smart Topology-model in plaats van een standaardmodel te remeshen. Zie Modellen.

  • Name
    symmetry_mode
    Type
    string
    ⚠ verouderd
    standaard auto
    Description

    Laat deze weg. Deze parameter heeft geen effect op de output.

    Beschikbare waarden:

    • off: schakelt symmetrie uit
    • auto: past symmetrie toe op basis van de invoergeometrie
    • on: dwingt symmetrie af tijdens generatie
  • Name
    pose_mode
    Type
    string
    standaard ""
    Description

    De pose van het gegenereerde model.

    Beschikbare waarden:

    • a-pose: een A-pose
    • t-pose: een T-pose
    • "" (lege string): geen specifieke pose
  • Name
    is_a_t_pose
    Type
    boolean
    ⚠ verouderd
    standaard false
    Description

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

  • Name
    art_style
    Type
    string
    ⚠ verouderd
    standaard realistic
    Description

    Laat deze weg. Meshy negeert deze.

  • Name
    moderation
    Type
    boolean
    standaard false
    Description

    Of prompt vóór generatie gescreend moet worden op schadelijke inhoud. Als Meshy schadelijke inhoud detecteert, geeft het verzoek 400 terug en maakt Meshy geen taak aan.

  • Name
    target_formats
    Type
    string[]
    Description

    De bestandsformaten die gegenereerd moeten worden. Meshy genereert en retourneert alleen deze formaten, wat de taak kan verkorten. Als je dit weglaat, genereert Meshy elk formaat behalve 3mf, dat het alleen genereert wanneer je dit specifiek aanvraagt.

    Beschikbare waarden:

    • glb
    • obj
    • fbx
    • stl
    • usdz
    • 3mf
  • Name
    alpha_thumbnail
    Type
    boolean
    standaard false
    Description

    Of ook een preview met een transparante achtergrond (RGBA) gerenderd moet worden, geretourneerd in alpha_thumbnail_url wanneer je de taak ophaalt. thumbnail_url verandert niet.

  • Name
    auto_size
    Type
    boolean
    standaard false
    Description

    Of de werkelijke hoogte van het object met AI-visie geschat en het model daarop geschaald moet worden. Meshy plaatst de oorsprong onderaan, tenzij je origin_at instelt.

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

    Waar de oorsprong van het model geplaatst moet worden, bottom of center.

Retourneert

Het veld result van de respons bevat de ID van de nieuwe Text to 3D-taak.

Foutmodi

  • Name
    400 - Bad Request
    Description

    Het verzoek kan niet worden uitgevoerd. Het foutbericht geeft aan welk probleem is gevonden. Bijvoorbeeld:

    • Ontbrekende parameter: Een vereiste parameter, zoals prompt of mode, ontbreekt.
    • Prompt te lang: prompt overschrijdt de tekenlimiet.
    • Niet-ondersteund model voor Ultra: geometry_resolution is 2k of 4k, met een ai_model die dit niet kan uitvoeren.

    Corrigeer het verzoek en stuur het opnieuw. Zie Fouten.

  • Name
    401 - Unauthorized
    Description

    De API-sleutel ontbreekt of is ongeldig. Controleer de Authorization-header.

  • Name
    402 - Payment Required
    Description

    Bijvoorbeeld:

    • Onvoldoende credits: Het account heeft niet genoeg credits voor deze taak, of het account heeft een credietlimiet bereikt. Controleer je credit-saldo en probeer het opnieuw.
    • Gratis abonnement: Voor het aanmaken van een taak is een betaald abonnement vereist. Upgrade je abonnement in je abonnementsinstellingen en probeer het opnieuw.
  • Name
    403 - Forbidden
    Description

    Contentmoderatie heeft de prompt of een invoerafbeelding geblokkeerd. Wijzig de invoer en probeer het opnieuw.

  • Name
    429 - Too Many Requests
    Description

    Je hebt je rate limit overschreden. Wacht en probeer het opnieuw. Zie Rate limits.


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

Een Text to 3D refine-taak maken

Maakt een Text to 3D refine-taak aan, die de mesh van een voltooide preview-taak van textuur voorziet. Stuur de ID van een geslaagde preview-taak als preview_task_id. Zie Een Text to 3D preview-taak maken. Dit is de tweede stap van de workflow in twee stappen.

De taak draait op de achtergrond. Voor de gebruikelijke duur van een taak, zie Verwerkingstijden.

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

# Refine with Meshy N1 from the preview's stored reference image
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",
  "ai_model": "meshy-n1"
}'

Response

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

Parameters

  • Name
    mode
    Type
    string
    Verplicht
    Description

    De stap van de workflow in twee stappen. Stuur refine om een refine-taak aan te maken.

  • Name
    preview_task_id
    Type
    string
    Verplicht
    Description

    De ID van de preview-taak die van textuur moet worden voorzien. De preview-taak moet de status SUCCEEDED hebben.

  • Name
    enable_pbr
    Type
    boolean
    standaard false
    Description

    Of ook PBR-maps (metallic, roughness en normal) moeten worden gegenereerd naast de basiskleur.

    Met ai_model meshy-6 genereert Meshy ook een emissiemap, behalve bij texture_resolution: 8k. meshy-6-lite, meshy-7, meshy-7.1 en latest genereren geen emissiemap. Dat geldt ook voor een refine van een meshy-t2- of meshy-t2.5-preview waarbij ai_model niet is ingesteld. Met ai_model: meshy-n1 geeft true een 400.

  • Name
    texture_resolution
    Type
    string
    standaard 2k
    Description

    De resolutie van de basiskleurtextuur. Geldt alleen voor refine-taken. Een preview met deze parameter geeft 400.

    Beschikbare waarden:

    • 2k: 2048×2048
    • 4k: 4096×4096
    • 8k: 8192×8192

    Hogere resoluties leggen meer oppervlaktedetail vast. 4k en 8k vereisen ai_model meshy-6, meshy-7.1 of latest. Met meshy-n1 geven ze 400. Bij 8k genereert Meshy geen emissiemap.

  • Name
    hd_texture
    Type
    boolean
    ⚠ verouderd
    standaard false
    Description

    Stuur in plaats daarvan texture_resolution. hd_texture: true is hetzelfde als texture_resolution: "4k". Als u beide stuurt, gebruikt Meshy texture_resolution.

  • Name
    texture_prompt
    Type
    string
    Description

    Tekst die de textuurvorming stuurt, tot 800 tekens. Langere tekst geeft 400. Stuur texture_prompt of texture_image_url, niet beide. Als u beide stuurt, gebruikt Meshy texture_prompt. Met ai_model: meshy-n1 geeft het sturen hiervan 400.

  • Name
    texture_image_url
    Type
    string
    Description

    Een 2D-afbeelding die de textuurvorming stuurt, als openbare URL of als base64-gecodeerde Data URI, zoals data:image/jpeg;base64,<uw base64-gecodeerde afbeeldingsgegevens>.

    De afbeelding moet een .jpg-, .jpeg-, .png- of .webp-bestand zijn van maximaal 20 MB, minimaal 32 pixels aan elke zijde en maximaal 178.956.970 pixels (breedte × hoogte).

    Met ai_model: meshy-n1 gebruikt Meshy deze afbeelding als vooraanzicht voor de textuurvorming.

  • Name
    ai_model
    Type
    string
    standaard inherited from the preview task
    Description

    Het AI-model dat de mesh van textuur voorziet.

    Beschikbare waarden:

    • meshy-6-lite
    • meshy-6
    • meshy-7.1
    • latest: Meshy 7.1
    • meshy-n1: een 2K-basiskleurtextuur, uitsluitend op basis van een referentieafbeelding. Geen tekstprompt, geen PBR-maps, geen 4K of 8K.
    • meshy-7 (verouderd): stuur in plaats daarvan meshy-7.1

    Laat deze parameter weg om het model van de preview-taak te gebruiken, zodat de preview en de bijbehorende refine van begin tot eind met hetzelfde model draaien. Stuur een waarde om dit te overschrijven. Een expliciete latest wordt op dezelfde manier herleid als bij de preview-taak, zodat een latest-preview en de bijbehorende latest-refine altijd hetzelfde textuurmodel gebruiken.

    Met meshy-n1 voorziet Meshy van textuur op basis van texture_image_url. Zonder deze parameter gebruikt Meshy de referentieafbeelding die is opgeslagen bij een meshy-7.1- of latest-preview. Elke andere preview geeft 400, tenzij u texture_image_url meestuurt. De preview mag maximaal 7.999.999 driehoeken bevatten. Een preview die is geremesht naar quads geeft 400.

  • Name
    moderation
    Type
    boolean
    standaard false
    Description

    Of texture_prompt en texture_image_url vóór het genereren moeten worden gescreend op schadelijke inhoud. Als Meshy schadelijke inhoud detecteert, geeft het verzoek 400 en maakt Meshy geen taak aan.

  • Name
    remove_lighting
    Type
    boolean
    standaard true
    Description

    Of hooglichten en schaduwen uit de basiskleurtextuur moeten worden verwijderd. Het resultaat is zo schoner en werkt beter bij aangepaste belichting.

    Heeft alleen effect wanneer ai_model meshy-6 is. meshy-7.1 en latest accepteren deze parameter maar negeren hem, net als een refine van een meshy-t2- of meshy-t2.5-preview waarbij ai_model niet is ingesteld. Het sturen hiervan met meshy-6-lite geeft 400. Met meshy-n1 geeft true een 400.

  • Name
    target_formats
    Type
    string[]
    Description

    De bestandsformaten die moeten worden gegenereerd. Meshy genereert en retourneert alleen deze formaten, wat de taak kan verkorten. Als u dit weglaat, genereert Meshy elk formaat behalve 3mf, dat alleen wordt gegenereerd wanneer u erom vraagt.

    Beschikbare waarden:

    • glb
    • obj
    • fbx
    • stl
    • usdz
    • 3mf
  • Name
    alpha_thumbnail
    Type
    boolean
    standaard false
    Description

    Of ook een preview met transparante achtergrond (RGBA) moet worden gerenderd, geretourneerd in alpha_thumbnail_url wanneer u de taak opvraagt. thumbnail_url verandert niet.

  • Name
    auto_size
    Type
    boolean
    standaard false
    Description

    Of de werkelijke hoogte van het object moet worden geschat met AI-visie en het model daarop in formaat moet worden aangepast. Meshy plaatst de oorsprong onderaan, tenzij u origin_at instelt.

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

    Waar de oorsprong van het model moet worden geplaatst, bottom of center.

Resultaten

Het veld result van de respons bevat de ID van de nieuwe Text to 3D-taak.

Foutmodi

  • Name
    400 - Bad Request
    Description

    Het verzoek kan niet worden uitgevoerd. Het foutbericht geeft aan welk probleem is gevonden. Bijvoorbeeld:

    • Ongeldige taak-ID: preview_task_id is ongeldig of komt niet overeen met een van uw preview-taken.
    • Taak nog niet gereed: De preview-taak is nog niet geslaagd.
    • Modelmismatch: Het AI-model van de preview-taak werkt niet met het gevraagde refine-model.
    • Niet-ondersteund model voor remove_lighting: remove_lighting werd gestuurd met ai_model: "meshy-6-lite".
    • Geen referentieafbeelding voor Meshy N1: ai_model: meshy-n1 werd gestuurd zonder texture_image_url, en de preview heeft geen referentieafbeelding die Meshy N1 kan gebruiken. Stuur texture_image_url.
    • Quad-preview voor Meshy N1: ai_model: meshy-n1 werd gestuurd voor een preview die naar quads is geremesht. Verfijn deze met een ander ai_model.
    • Te veel driehoeken voor Meshy N1: Met ai_model: meshy-n1 heeft de preview meer dan 7.999.999 driehoeken. Verfijn deze met een ander ai_model.
    • Niet-ondersteunde optie voor Meshy N1: ai_model: meshy-n1 werd gestuurd met een van deze opties:
      • texture_prompt
      • enable_pbr: true
      • texture_resolution van 4k of 8k
      • hd_texture: true zonder texture_resolution
      • remove_lighting: true

    Herstel het verzoek en stuur het opnieuw. Zie Fouten.

  • Name
    401 - Unauthorized
    Description

    De API-sleutel ontbreekt of is ongeldig. Controleer de header Authorization.

  • Name
    402 - Payment Required
    Description

    Bijvoorbeeld:

    • Onvoldoende credits: Het account heeft onvoldoende credits voor deze taak, of het account heeft een credietlimiet bereikt. Controleer uw creditsaldo en probeer het opnieuw.
    • Gratis abonnement: Voor het aanmaken van een taak is een betaald abonnement vereist. Upgrade uw abonnement via uw abonnementsinstellingen en probeer het opnieuw.
  • Name
    403 - Forbidden
    Description

    Contentmoderatie heeft de prompt of een invoerafbeelding geblokkeerd. Wijzig de invoer en probeer het opnieuw.

  • Name
    429 - Too Many Requests
    Description

    U heeft uw rate limit overschreden. Wacht en probeer het opnieuw. Zie Rate limits.


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

Haal een Tekst naar 3D-taak op

Retourneert een Tekst naar 3D-taak aan de hand van de bijbehorende ID. Dit werkt zowel voor preview- als refine-taken.

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": null,

  "consumed_credits": 20
}

Parameters

  • Name
    id
    Type
    path
    Description

    De taak-ID uit de aanmaakrespons.

Retourwaarde

Het Tekst naar 3D-taakobject.

Voorbeelden

De volgende tabel toont een voorbeeldmodel voor elke mode.

ModeVoorbeeldmodel
PreviewPreview model
RefineRefined model

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

Een Tekst naar 3D-taak verwijderen

Verwijdert een Tekst naar 3D-taak permanent, inclusief de bijbehorende modellen en gegevens. Je kunt een verwijdering niet ongedaan maken.

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

Padparameters

  • Name
    id
    Type
    path
    Description

    De ID van de te verwijderen taak.

Taakstatus

Het verwijderen van een taak met status PENDING betaalt de credits terug die zijn gebruikt bij het aanmaken ervan.

Een taak met status IN_PROGRESS kan niet worden verwijderd. Het verzoek geeft 409 Conflict terug, en de taak blijft actief. Meshy betaalt geen credits terug voor een taak die al is gestart, dus het verwijderen ervan zou je zowel de credits als het resultaat kosten. Wacht tot de taak de status SUCCEEDED, FAILED of CANCELED bereikt, en verwijder hem dan.

Het verwijderen van een taak met een definitieve status (SUCCEEDED, FAILED of CANCELED) betaalt de bijbehorende credits niet terug.

Retourwaarden

200 OK wanneer de taak is verwijderd, of 409 Conflict wanneer de taak IN_PROGRESS is.


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

Lijst van Tekst naar 3D-taken

Geeft een lijst van uw Tekst naar 3D-taken terug.

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": null,

    "consumed_credits": 20
  }
]

Parameters

  • Name
    page_num
    Type
    integer
    standaard 1
    Description

    Het paginanummer dat moet worden geretourneerd, tot 255. Een hogere waarde levert 400 op.

  • Name
    page_size
    Type
    integer
    standaard 10
    Description

    Het aantal taken per pagina, tot 100.

  • Name
    sort_by
    Type
    string
    Description

    De sorteervolgorde.

    Beschikbare waarden:

    • +created_at: oudste eerst
    • -created_at: nieuwste eerst

Retourwaarden

Een gepagineerde lijst van Tekst naar 3D-taakobjecten.


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

Stream een Text to 3D-taak

Streamt de updates van een Tekst naar 3D-taak als Server-Sent Events (SSE).

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.
// These examples are shortened. Each event holds the full task object.
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": null,

"consumed_credits": 20
}

Parameters

  • Name
    id
    Type
    path
    Description

    De taak-ID uit de respons van het aanmaken.

Retourwaarden

Een stream van Tekst naar 3D-taakobjecten als Server-Sent Events.

Elk event bevat het volledige taakobject, in dezelfde vorm als die de Get-endpoint retourneert. Zolang de taak PENDING of IN_PROGRESS is, hebben de resultaatvelden nog geen waarden.


Het Text to 3D taakobject

Een Text to 3D taakobject beschrijft één taak die een 3D-model genereert op basis van een tekst-prompt. Het bevat de status, de progress en de modelbestanden wanneer de taak slaagt. Text to 3D heeft twee fases, preview en refine. Een preview-taak genereert een 3D-model dat alleen uit een mesh bestaat, en een refine-taak genereert een getextureerd 3D-model op basis van het resultaat van de preview.

Eigenschappen

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": null,

  "consumed_credits": 20
}
  • Name
    id
    Type
    string
    Description

    De taak-ID. Behandel dit als een ondoorzichtige string en vertrouw niet op het format ervan.

  • Name
    type
    Type
    string
    Description

    Het taaktype, text-to-3d-preview voor een preview-taak of text-to-3d-refine voor een refine-taak.

  • Name
    model_urls
    Type
    object
    Description

    Download-URL's voor het gegenereerde 3D-model, één per bestandsformaat. Een formaat dat de taak niet heeft gegenereerd, heeft geen sleutel, in plaats van een lege string.

    • Name
      glb
      Type
      string
      Description

      Het GLB-bestand.

    • Name
      fbx
      Type
      string
      Description

      Het FBX-bestand.

    • Name
      usdz
      Type
      string
      Description

      Het USDZ-bestand.

    • Name
      obj
      Type
      string
      Description

      Het OBJ-bestand.

    • Name
      mtl
      Type
      string
      Description

      Het MTL-bestand.

    • Name
      stl
      Type
      string
      Description

      Het STL-bestand.

    • Name
      3mf
      Type
      string
      Description

      Het 3MF-bestand. Alleen aanwezig wanneer target_formats 3mf bevat.

  • Name
    prompt
    Type
    string
    Description

    De prompt die je hebt verstuurd om de taak aan te maken, ongewijzigd.

  • Name
    texture_prompt
    Type
    string
    Description

    De tekstprompt die je hebt verstuurd om de texturing in de refine-fase te sturen.

  • Name
    ultra_mode
    Type
    boolean
    ⚠ verouderd
    Description

    Gebruik in plaats daarvan geometry_resolution.

  • Name
    geometry_resolution
    Type
    string
    Description

    De Ultra-tier waarmee de preview-taak is uitgevoerd, 2k of 4k. Dit veld ontbreekt voor standard.

  • Name
    texture_image_url
    Type
    string
    Description

    Download-URL voor de afbeelding die je hebt verstuurd om de texturing te sturen.

  • Name
    thumbnail_url
    Type
    string
    Description

    Download-URL voor een thumbnailafbeelding van het 3D-model.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Download-URL voor een versie van thumbnail_url met een transparante achtergrond (RGBA). Alleen aanwezig wanneer je de taak hebt aangemaakt met alpha_thumbnail: true en Meshy de transparante preview heeft gerenderd.

  • Name
    progress
    Type
    integer
    Description

    Hoeveel van de taak is voltooid, als percentage. Dit is 0 totdat de taak start en 100 wanneer deze slaagt.

  • Name
    started_at
    Type
    timestamp
    Description

    Tijdstip waarop de taak is gestart, in Unix-milliseconden. Dit is 0 totdat de taak start.

  • Name
    created_at
    Type
    timestamp
    Description

    Tijdstip waarop de taak is aangemaakt, in Unix-milliseconden.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tijdstip waarop de taak is beëindigd, in Unix-milliseconden. Dit is 0 totdat de taak eindigt.

  • Name
    status
    Type
    string
    Description

    De taakstatus, een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, of CANCELED.

  • Name
    texture_urls
    Type
    array
    Description

    Download-URL's voor de gegenereerde textuurkaarten, als een array van objecten. Deze bevat gewoonlijk één object. Elk object heeft de volgende velden:

    • Name
      base_color
      Type
      string
      Description

      De base color-kaart.

    • Name
      metallic
      Type
      string
      Description

      De metallic-kaart. Afwezig wanneer je de taak hebt aangemaakt met enable_pbr: false.

    • Name
      normal
      Type
      string
      Description

      De normal map. Afwezig wanneer je de taak hebt aangemaakt met enable_pbr: false.

    • Name
      roughness
      Type
      string
      Description

      De roughness-kaart. Afwezig wanneer je de taak hebt aangemaakt met enable_pbr: false.

    • Name
      emission
      Type
      string
      Description

      De emission-kaart. Afwezig in elk van de volgende gevallen:

      • Je hebt de taak aangemaakt met enable_pbr: false.
      • ai_model is meshy-6-lite, meshy-7, meshy-7.1, of latest.
      • texture_resolution is 8k.
      • De taak verfijnt een meshy-t2- of meshy-t2.5-preview zonder ai_model in te stellen.
  • Name
    preceding_tasks
    Type
    integer
    Description

    Het aantal taken dat vóór deze taak in de wachtrij staat. De waarde is alleen zinvol zolang de taak PENDING is.

  • Name
    task_error
    Type
    object
    Description

    De foutdetails wanneer de taak mislukt. Dit is null tenzij de status FAILED is. Zie Fouten.

  • Name
    consumed_credits
    Type
    integer
    Description

    Het aantal credits dat de taak heeft gebruikt. Aanwezig wanneer de status PENDING, IN_PROGRESS, of SUCCEEDED is. Dit is 0 voor een FAILED-taak, omdat Meshy de credits terugbetaalt wanneer een taak mislukt.