Text zu 3D API

Die Text zu 3D API ist eine Funktion, mit der Sie die Text-zu-3D-Fähigkeiten von Meshy in Ihre eigene Anwendung integrieren können. In diesem Abschnitt finden Sie alle Informationen, die Sie für den Einstieg in diese API benötigen.

Text zu 3D verwendet einen zweistufigen Workflow. Erstellen Sie zunächst einen preview-Task (mode: "preview"), um ein 3D-Netz ohne Textur zu erzeugen, damit Sie die Form bewerten können. Übergeben Sie anschließend die Task-ID des abgeschlossenen Preview-Tasks an einen refine-Task (mode: "refine"), um dem Netz eine Textur hinzuzufügen. Beide Schritte nutzen denselben Endpunkt.


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

Create a Text to 3D Preview Task

Dieser Endpunkt erstellt eine Text-zu-3D-Vorschauaufgabe, die aus einem Text-Prompt ein untexturiertes 3D-Netz (nur Geometrie) generiert. Dies ist der erste Schritt des zweistufigen Workflows. Sobald die Vorschau erfolgreich war, verwenden Sie die zurückgegebene Aufgaben-ID, um eine Refine-Aufgabe zu erstellen für die Texturierung. Siehe Das Text-zu-3D-Aufgabenobjekt für das vollständige Antwortschema.

Parameter

  • Name
    mode
    Type
    string
    Erforderlich
    Description

    Dieses Feld sollte beim Erstellen einer Vorschauaufgabe auf "preview" gesetzt werden.

  • Name
    prompt
    Type
    string
    Erforderlich
    Description

    Beschreibt, welche Art von Objekt das 3D-Modell darstellen soll. Maximal 800 Zeichen.

  • Name
    model_type
    Type
    string
    Standard standard
    Description

    Gibt die Art der 3D-Netzerzeugung an.

    Verfügbare Werte:

    • standard: Reguläre, hochdetaillierte 3D-Netzerzeugung.
    • smart-topology: Wählt das Smart-Topology-Modell mit ai_model (meshy-t2).
    • lowpoly (veraltet): Erzeugt ein Low-Poly-Netz, das für sauberere Polygone optimiert ist. Wir empfehlen stattdessen smart-topology zu verwenden.
  • Name
    ai_model
    Type
    string
    Standard latest
    Description

    ID des zu verwendenden Modells. Die verfügbaren Werte hängen von model_type ab.

    Standardgenerierung (model_type: standard):

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

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

    • meshy-t2 (Standard): das Smart-Topology-Modell — sauberere topology, nativ getrennte Teile, Dreiecksausgabe und eine Flächenanzahl, die Sie mit target_polycount festlegen können.
  • Name
    ultra_mode
    Type
    boolean
    Standard false
    Description

    Aktiviert die Ultra-Generierung für eine höherwertige Geometrie mit feineren Oberflächendetails. Die Generierung dauert länger und kostet 5 zusätzliche Credits.

  • Name
    should_remesh
    Type
    boolean
    Standard false (meshy-6, meshy-7), true (others)
    Description

    Steuert, ob die Neuvernetzungsphase aktiviert wird. Für das qualitativ hochwertigste Modell empfehlen wir, should_remesh auf false zu setzen.

Gilt nur wenn should_remesh = true
  • Name
    topology
    Type
    string
    Standard triangle
    Description

    Gibt die topology des generierten Modells an.

    Verfügbare Werte:

    • quad: Erzeugt ein überwiegend aus Vierecken bestehendes Netz.
    • triangle: Erzeugt ein dezimiertes Dreiecksnetz.
  • Name
    decimation_mode
    Type
    integer
    Description

    Aktiviert die adaptive Dezimierung durch Festlegen einer Polygonanzahl-Stufe. Wenn gesetzt, wird target_polycount ignoriert.

    Verfügbare Werte:

    • 1: Adaptiv — ultra Polygonanzahl.
    • 2: Adaptiv — hohe Polygonanzahl.
    • 3: Adaptiv — mittlere Polygonanzahl.
    • 4: Adaptiv — niedrige Polygonanzahl.
  • Name
    target_polycount
    Type
    integer
    Description

    Zielanzahl der Polygone (Flächen) in der Ausgabe. Die tatsächliche Anzahl kann je nach Geometrie vom Zielwert abweichen.

    target_polycount wirkt sich in zwei unabhängigen Fällen aus:

    • Neuvernetzung — mit should_remesh: true bei einem standard-Modell. Das Netz wird auf ungefähr diese Anzahl neu vernetzt (dezimiert). Bereich 100 bis 300.000, Standardwert 30.000. Ist decimation_mode gesetzt, hat es Priorität und target_polycount wird ignoriert.
    • Smart Topology — mit model_type: smart-topology und ai_model: meshy-t2. Das Modell wird direkt mit dieser Flächenanzahl generiert; es findet keine Neuvernetzung statt, und should_remesh ist nicht erforderlich. Bereich 100 bis 15.000, Standardwert 4.000.
  • Name
    symmetry_mode
    Type
    string
    veraltet
    Standard auto
    Description

    Veraltet. Dieser Parameter hat keinen Einfluss mehr auf die Ausgabe.

    Das Feld symmetry_mode steuert das Symmetrieverhalten während der Modellgenerierung.

    Die gültigen Werte sind:

    • off: Deaktiviert Symmetrie.
    • auto: Bestimmt und wendet Symmetrie automatisch basierend auf der Eingabegeometrie an.
    • on: Erzwingt Symmetrie während der Generierung.
  • Name
    pose_mode
    Type
    string
    Standard ""
    Description

    Gibt den Pose-mode für das generierte Modell an.

    Verfügbare Werte:

    • a-pose: Generiert das Modell in einer A-Pose.
    • t-pose: Generiert das Modell in einer T-Pose.
    • "" (leere Zeichenkette): Keine spezifische Pose angewendet.
  • Name
    is_a_t_pose
    Type
    boolean
    veraltet
    Standard false
    Description

    Verwenden Sie stattdessen pose_mode. Ob das Modell in einer A/T-Pose generiert werden soll.

  • Name
    art_style
    Type
    string
    veraltet
    Standard realistic
    Description

    Wird von Meshy-6 nicht unterstützt. Anfragen mit Meshy-6 ignorieren art_style, und einige Kombinationen können Fehler verursachen. Verfügbare Werte: realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    Standard false
    Description

    Wenn auf true gesetzt, wird der Eingabeinhalt automatisch auf potenziell schädlichen Inhalt überprüft. Wird schädlicher Inhalt erkannt, wird die Aufgabe nicht zur Generierung weitergeführt.

    Der Text aus prompt wird überprüft.

  • Name
    target_formats
    Type
    string[]
    Description

    Gibt an, welche 3D-Dateiformate in die Ausgabe aufgenommen werden sollen. Nur die angeforderten Formate werden generiert und zurückgegeben, was die Bearbeitungszeit der Aufgabe verkürzen kann. Wird das Feld weggelassen, werden alle unterstützten Formate einbezogen.

    Verfügbare Werte: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    Standard false
    Description

    Wenn auf true gesetzt, rendert die Aufgabe zusätzlich eine Version der Vorschau mit transparentem Hintergrund (RGBA) und gibt sie als alpha_thumbnail_url in der GET-Antwort zurück. Das bestehende Feld thumbnail_url bleibt unverändert.

  • Name
    auto_size
    Type
    boolean
    Standard false
    Description

    Wenn auf true gesetzt, verwendet der Dienst KI-Bildanalyse, um die reale Höhe des Objekts automatisch zu schätzen und das Modell entsprechend in der Größe anzupassen. Der Ursprung wird standardmäßig auf bottom gesetzt, sofern origin_at nicht explizit angegeben ist.

Gilt nur wenn auto_size = true
  • Name
    origin_at
    Type
    string
    Standard bottom
    Description

    Position des Ursprungs, wenn auto_size aktiviert ist.

    Verfügbare Werte: bottom, center.

Rückgabewerte

Die Eigenschaft result der Antwort enthält die Aufgaben-id der neu erstellten Text-zu-3D-Aufgabe.

Fehlermodi

  • Name
    400 - Bad Request
    Description

    Die Anfrage war nicht akzeptabel. Häufige Ursachen:

    • Fehlender Parameter: Ein erforderlicher Parameter (z. B. prompt, mode) fehlt.
    • Ungültiger Parameter: art_style entspricht keinem der zulässigen Werte.
    • Prompt zu lang: Der prompt überschreitet das Zeichenlimit.
  • Name
    401 - Unauthorized
    Description

    Die Authentifizierung ist fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.

  • Name
    402 - Payment Required
    Description

    Unzureichende Credits, um diese Aufgabe auszuführen.

  • Name
    429 - Too Many Requests
    Description

    Sie haben Ihre Ratenbegrenzung überschritten.

Request

POST
/openapi/v2/text-to-3d
# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

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

Response

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

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

Erstellen einer Text-zu-3D-Verfeinerungsaufgabe

Dieser Endpunkt erstellt eine Text-zu-3D-Verfeinerungsaufgabe, die eine Textur auf ein fertiggestelltes Vorschau-Netz anwendet. Sie müssen die preview_task_id einer erfolgreichen Vorschauaufgabe angeben. Dies ist der zweite Schritt des zweistufigen Arbeitsablaufs.

Parameter

  • Name
    mode
    Type
    string
    Erforderlich
    Description

    Dieses Feld sollte beim Erstellen einer Verfeinerungsaufgabe auf "refine" gesetzt werden.

  • Name
    preview_task_id
    Type
    string
    Erforderlich
    Description

    Die entsprechende Vorschauaufgaben-ID.

    Der Status der angegebenen Vorschauaufgabe muss SUCCEEDED sein.

  • Name
    enable_pbr
    Type
    boolean
    Standard false
    Description

    Erzeugt zusätzlich zur Grundfarbe PBR-Texturen (metallic, roughness, normal). Eine Emissionsmap wird ebenfalls einbezogen, wenn ai_model den Wert meshy-6 hat, außer bei texture_resolution: 8k (hier wird keine Emissionsmap erzeugt). meshy-7 (und latest) erzeugt keine Emissionsmap.

  • Name
    texture_resolution
    Type
    string
    Standard 2k
    Description

    Auflösung der Grundfarbtextur. Einer der Werte 2k (2048×2048), 4k (4096×4096) oder 8k (8192×8192). Höhere Auflösungen erfassen mehr Oberflächendetails. Gilt nur für den refine-mode.

  • Name
    hd_texture
    Type
    boolean
    veraltet
    Standard false
    Description

    Verwenden Sie stattdessen texture_resolution — entspricht texture_resolution: "4k". Wenn beide gesetzt sind, hat texture_resolution Vorrang.

  • Name
    texture_prompt
    Type
    string
    Description

    Geben Sie einen zusätzlichen Text-prompt an, um den Texturierungsprozess zu steuern. Maximal 800 Zeichen.

  • Name
    texture_image_url
    Type
    string
    Description

    Geben Sie ein 2D-Bild an, um den Texturierungsprozess zu steuern. Derzeit werden die Formate .jpg, .jpeg und .png unterstützt.

    Es gibt zwei Möglichkeiten, das Bild bereitzustellen:

    • Öffentlich zugängliche URL: Eine URL, die aus dem öffentlichen Internet erreichbar ist
    • Data URI: Ein base64-kodierter Data URI des Bildes. Beispiel für einen Data URI: data:image/jpeg;base64,<Ihre base64-kodierten Bilddaten>
  • Name
    ai_model
    Type
    string
    Standard latest
    Description

    ID des zu verwendenden Modells für die Verfeinerung. Verfügbare Werte: meshy-5, meshy-6, meshy-7, latest (Meshy 7).

  • Name
    moderation
    Type
    boolean
    Standard false
    Description

    Wenn auf true gesetzt, wird der Eingabeinhalt automatisch auf potenziell schädliche Inhalte geprüft. Wird schädlicher Inhalt erkannt, wird die Aufgabe nicht zur Generierung fortgesetzt.

    Sowohl der Text aus texture_prompt als auch das Bild aus texture_image_url werden geprüft.

  • Name
    remove_lighting
    Type
    boolean
    Standard true
    Description

    Entfernt Glanzlichter und Schatten aus der Grundfarbtextur und erzeugt so ein saubereres Ergebnis, das unter individuellen Beleuchtungseinstellungen besser funktioniert.

  • Name
    target_formats
    Type
    string[]
    Description

    Gibt an, welche 3D-Dateiformate in der Ausgabe enthalten sein sollen. Es werden nur die angeforderten Formate erzeugt und zurückgegeben, was die Fertigstellungszeit der Aufgabe verkürzen kann. Wenn nicht angegeben, sind alle unterstützten Formate enthalten.

    Verfügbare Werte: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    Standard false
    Description

    Wenn auf true gesetzt, rendert die Aufgabe zusätzlich eine Version der Vorschau mit transparentem Hintergrund (RGBA) und gibt diese als alpha_thumbnail_url in der GET-Antwort zurück. Das bestehende Feld thumbnail_url bleibt unverändert.

  • Name
    auto_size
    Type
    boolean
    Standard false
    Description

    Wenn auf true gesetzt, verwendet der Dienst KI-basiertes Sehen, um die reale Höhe des Objekts automatisch zu schätzen und das Modell entsprechend in der Größe anzupassen. Der Ursprung ist standardmäßig bottom, sofern origin_at nicht explizit gesetzt ist.

Gilt nur wenn auto_size = true
  • Name
    origin_at
    Type
    string
    Standard bottom
    Description

    Position des Ursprungs, wenn auto_size aktiviert ist.

    Verfügbare Werte: bottom, center.

Rückgabewerte

Die Eigenschaft result der Antwort enthält die Aufgaben-id der neu erstellten Text-zu-3D-Aufgabe.

Fehlermodi

  • Name
    400 - Bad Request
    Description

    Die Anfrage war nicht akzeptabel. Häufige Ursachen:

    • Ungültige Aufgaben-ID: Die preview_task_id ist ungültig oder existiert nicht.
    • Aufgabe nicht bereit: Die Vorschauaufgabe war noch nicht erfolgreich.
    • Modell-Inkompatibilität: Das KI-Modell der Vorschauaufgabe ist mit dem angeforderten Verfeinerungsmodell nicht kompatibel.
  • Name
    401 - Unauthorized
    Description

    Die Authentifizierung ist fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.

  • Name
    402 - Payment Required
    Description

    Nicht genügend Credits, um diese Aufgabe auszuführen.

  • Name
    404 - Not Found
    Description

    Die durch preview_task_id angegebene Vorschauaufgabe wurde nicht gefunden.

  • Name
    429 - Too Many Requests
    Description

    Sie haben Ihre Ratenbegrenzung überschritten.

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

Einen Text-zu-3D-Task abrufen

Dieser Endpunkt ermöglicht es Ihnen, einen Text-zu-3D-Task anhand einer gültigen Task-id abzurufen. Weitere Informationen dazu, welche Eigenschaften im Text-zu-3D-Task-Objekt enthalten sind, finden Sie unter Das Text-zu-3D-Task-Objekt.

Dieser Endpunkt funktioniert sowohl für Vorschau- als auch für Verfeinerungs-Tasks.

Parameter

  • Name
    id
    Type
    path
    Description

    Eindeutige Kennung für den abzurufenden Text-zu-3D-Task.

Rückgabewerte

Die Antwort enthält das Text-zu-3D-Task-Objekt. Weitere Details finden Sie im Abschnitt Das Text-zu-3D-Task-Objekt.

Beispiele

ModeBeispielmodell
VorschauPreview model
VerfeinernRefined 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

Eine Text zu 3D-Aufgabe löschen

Dieser Endpunkt löscht eine Text zu 3D-Aufgabe dauerhaft, einschließlich aller zugehörigen Modelle und Daten. Diese Aktion ist unumkehrbar.

Pfadparameter

  • Name
    id
    Type
    path
    Description

    Die ID der zu löschenden Text zu 3D-Aufgabe.

Rückgabe

Gibt bei Erfolg 200 OK zurück.

Request

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

Response

// Returns 200 Ok on success.

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

Text-zu-3D-Aufgaben auflisten

Dieser Endpunkt ermöglicht es Ihnen, eine Liste von Text-zu-3D-Aufgaben abzurufen.

Parameter

  • Name
    page_num
    Type
    integer
    Standard 1
    Description

    Seitennummer für die Paginierung.

  • Name
    page_size
    Type
    integer
    Standard 10
    Description

    Begrenzung der Seitengröße. Maximal erlaubt sind 50 Einträge.

  • Name
    sort_by
    Type
    string
    Description

    Feld, nach dem sortiert werden soll.

    Verfügbare Werte:

    • +created_at: Sortierung nach Erstellungszeit in aufsteigender Reihenfolge.
    • -created_at: Sortierung nach Erstellungszeit in absteigender Reihenfolge.

Rückgabe

Gibt eine paginierte Liste von Text-zu-3D-Aufgabenobjekten zurück.

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

Text-zu-3D-Aufgabe streamen

Dieser Endpunkt streamt Echtzeit-Updates für eine Text-zu-3D-Aufgabe mittels Server-Sent Events (SSE).

Parameter

  • Name
    id
    Type
    path
    Description

    Eindeutige Kennung der zu streamenden Text-zu-3D-Aufgabe.

Rückgabewerte

Gibt einen Stream von Text-zu-3D-Aufgabenobjekten als Server-Sent Events zurück.

Bei Aufgaben mit dem Status PENDING oder IN_PROGRESS enthält der Antwort-Stream nur die notwendigen Felder progress und 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
}

Das Text zu 3D Task-Objekt

Das Text zu 3D Task-Objekt ist eine Arbeitseinheit, die Meshy verwaltet, um aus einer Text-Eingabe ein 3D-Modell zu generieren. Es gibt zwei Phasen der Text zu 3D API, preview und refine. Die Preview-Phase dient der Erzeugung eines reinen Netz-3D-Modells, und die Refine-Phase dient der Erzeugung eines texturierten 3D-Modells basierend auf dem Ergebnis der Preview-Phase.

Das Objekt besitzt die folgenden Eigenschaften:

Eigenschaften

  • Name
    id
    Type
    string
    Description

    Eindeutige Kennung der Aufgabe. Obwohl wir als Implementierungsdetail eine k-sortierbare UUID für Task-IDs verwenden, sollten Sie keine Annahmen über das Format der ID treffen.

  • Name
    type
    Type
    string
    Description

    Typ der Text zu 3D-Aufgabe. Mögliche Werte sind text-to-3d-preview für Aufgaben der Preview-Phase und text-to-3d-refine für Aufgaben der Refine-Phase.

  • Name
    model_urls
    Type
    object
    Description

    Herunterladbare URL zur texturierten 3D-Modelldatei, die von Meshy generiert wurde. Die Eigenschaft für ein Format wird ausgelassen, wenn das Format nicht generiert wurde, anstatt eine leere Zeichenfolge zurückzugeben.

    • Name
      glb
      Type
      string
      Description

      Herunterladbare URL zur GLB-Datei.

    • Name
      fbx
      Type
      string
      Description

      Herunterladbare URL zur FBX-Datei.

    • Name
      usdz
      Type
      string
      Description

      Herunterladbare URL zur USDZ-Datei.

    • Name
      obj
      Type
      string
      Description

      Herunterladbare URL zur OBJ-Datei.

    • Name
      mtl
      Type
      string
      Description

      Herunterladbare URL zur MTL-Datei.

    • Name
      stl
      Type
      string
      Description

      Herunterladbare URL zur STL-Datei.

    • Name
      3mf
      Type
      string
      Description

      Herunterladbare URL zur 3MF-Datei. Nur vorhanden, wenn 3mf über target_formats angefordert wurde.

  • Name
    prompt
    Type
    string
    Description

    Dies ist der unveränderte prompt, der zur Erstellung der Aufgabe verwendet wurde.

  • Name
    negative_prompt
    Type
    string
    veraltet
    Description

    Wird aus Gründen der Abwärtskompatibilität beibehalten. Dieses Feld hat keine funktionale Auswirkung auf generierte Modelle.

  • Name
    art_style
    Type
    string
    veraltet
    Description

    Der unveränderte art_style, der zur Erstellung der Preview-Aufgabe verwendet wurde. Wird von Meshy-6 nicht unterstützt.

  • Name
    texture_richness
    Type
    string
    veraltet
    Description

    Wird aus Gründen der Abwärtskompatibilität beibehalten. Dieses Feld hat keine funktionale Auswirkung auf generierte Modelle.

  • Name
    texture_prompt
    Type
    string
    Description

    Zusätzlicher Text-Prompt, der zur Steuerung des Texturierungsprozesses während der Refine-Phase bereitgestellt wird.

  • Name
    ultra_mode
    Type
    boolean
    Description

    Gibt den Wert von ultra_mode wieder, mit dem die Preview-Aufgabe erstellt wurde. Nur vorhanden bei meshy-7- (oder latest-)Preview-Aufgaben, bei denen ultra_mode explizit gesetzt wurde; andernfalls ausgelassen.

  • Name
    texture_image_url
    Type
    string
    Description

    Herunterladbare URL zum Texturbild, das zur Steuerung des Texturierungsprozesses verwendet wurde.

  • Name
    thumbnail_url
    Type
    string
    Description

    Herunterladbare URL zur Miniaturansicht der Modelldatei.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Herunterladbare URL zu einer Version von thumbnail_url mit transparentem Hintergrund (RGBA). Nur vorhanden, wenn die Aufgabe mit alpha_thumbnail: true erstellt wurde und die transparente Vorschau erfolgreich gerendert wurde; andernfalls wird dieses Feld ausgelassen.

  • Name
    video_url
    Type
    string
    veraltet
    Description

    Herunterladbare URL zum Vorschauvideo. Wird in einer zukünftigen Version entfernt.

  • Name
    progress
    Type
    integer
    Description

    Fortschritt der Aufgabe. Wenn die Aufgabe noch nicht gestartet wurde, ist diese Eigenschaft 0. Sobald die Aufgabe erfolgreich abgeschlossen wurde, wird sie 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Zeitstempel, wann die Aufgabe gestartet wurde, in Millisekunden. Wenn die Aufgabe noch nicht gestartet wurde, ist diese Eigenschaft 0.

  • Name
    created_at
    Type
    timestamp
    Description

    Zeitstempel, wann die Aufgabe erstellt wurde, in Millisekunden.

  • Name
    finished_at
    Type
    timestamp
    Description

    Zeitstempel, wann die Aufgabe abgeschlossen wurde, in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen wurde, ist diese Eigenschaft 0.

  • Name
    status
    Type
    string
    Description

    Status der Aufgabe. Mögliche Werte sind PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    texture_urls
    Type
    array
    Description

    Ein Array von Textur-URL-Objekten, die aus der Aufgabe generiert werden. Normalerweise enthält dieses nur ein Textur-URL-Objekt. Jede Textur-URL besitzt die folgenden Eigenschaften:

    • Name
      base_color
      Type
      string
      Description

      Herunterladbare URL zum Basisfarbbild.

    • Name
      metallic
      Type
      string
      Description

      Herunterladbare URL zum Metallic-Map-Bild.

    • Name
      normal
      Type
      string
      Description

      Herunterladbare URL zum Normal-Map-Bild.

    • Name
      roughness
      Type
      string
      Description

      Herunterladbare URL zum Roughness-Map-Bild.

    • Name
      emission
      Type
      string
      Description

      Herunterladbare URL zum Emission-Map-Bild.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Die Anzahl der vorangehenden Aufgaben.

  • Name
    task_error
    Type
    object
    Description

    Fehlerdetails für fehlgeschlagene Aufgaben. Siehe Fehler für die vollständige Referenz des task_error-Objekts.

  • Name
    consumed_credits
    Type
    integer
    Description

    Die Anzahl der von dieser Aufgabe verbrauchten Credits. Vorhanden, wenn der Aufgabenstatus PENDING, IN_PROGRESS oder SUCCEEDED ist. Gibt für FAILED-Aufgaben 0 zurück (Credits werden bei Fehlschlag zurückerstattet).

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
}