lowpoly wird am 30.10.2026 abgeschaltet. Wechseln Sie vor diesen Terminen das Modell, um Fehler bei Anfragen zu vermeiden. Alle Abkündigungen ansehen

Multi-Bild zu 3D API

Erstelle ein 3D-Modell aus ein bis vier Bildern desselben Objekts, die aus unterschiedlichen Blickwinkeln aufgenommen wurden.


POST/openapi/v1/multi-image-to-3d

Create a Multi-Image to 3D task

Erstellt eine Multi-Bild-zu-3D-Aufgabe. Die Aufgabe läuft im Hintergrund. Wie lange eine Aufgabe in der Regel dauert, erfahren Sie unter Verarbeitungszeiten. Welche Felder eine Aufgabe besitzt, erfahren Sie unter Das Multi-Bild-zu-3D-Aufgabenobjekt.

Request

POST
/openapi/v1/multi-image-to-3d
# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ]
  }'

# With Ultra 2K geometry, PBR texturing, and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "geometry_resolution": "2k",
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

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

Parameter

  • Name
    input_task_id
    Type
    string
    Erforderlich
    Description

    Erforderlich, sofern Sie nicht image_urls senden. Die ID einer Text-zu-Bild- oder Bild-zu-Bild-Aufgabe, einschließlich einer Mehransicht-Aufgabe. Meshy verwendet deren ein bis vier Bilder als Eingabe. Die Aufgabe muss eine sein, die Sie mit der API erstellt haben und den Status SUCCEEDED besitzt.

  • Name
    image_urls
    Type
    array
    Erforderlich
    Description

    Erforderlich, sofern Sie nicht input_task_id senden. Ein bis vier Bilder, jeweils als öffentliche URL oder als Data URI, zum Beispiel data:image/jpeg;base64,<ihre base64-codierten Bilddaten>. Wenn Sie beides senden, verwendet Meshy input_task_id.

    Jedes Bild muss eine .jpg-, .jpeg-, .png- oder .webp-Datei von höchstens 20 MB sein. Mehr als vier Bilder führt zu 400.

    Für die besten Ergebnisse sollten die Bilder dasselbe Objekt aus unterschiedlichen Blickwinkeln zeigen. Mit meshy-7.1 oder latest verwendet Meshy das erste Bild als Vorderansicht, die Reihenfolge der übrigen spielt keine Rolle.

  • Name
    ai_model
    Type
    string
    Standard latest
    Description

    Das KI-Modell, das das 3D-Modell erzeugt.

    Verfügbare Werte:

    • latest: Meshy 7.1
    • meshy-7.1
    • meshy-6
    • meshy-6-lite
    • meshy-7: veraltet, senden Sie stattdessen meshy-7.1
  • Name
    geometry_resolution
    Type
    string
    Standard standard
    Description

    Wie viel Geometriedetail erzeugt werden soll.

    Verfügbare Werte:

    • standard
    • 2k: führt den Ultra-Durchgang mit 2048³ aus. Erfordert meshy-7.1, latest oder das veraltete meshy-7.
  • Name
    ultra_mode
    Type
    boolean
    ⚠ veraltet
    Standard false
    Description

    Senden Sie stattdessen geometry_resolution. ultra_mode: true entspricht geometry_resolution: "2k".

  • Name
    should_texture
    Type
    boolean
    Standard true
    Description

    Ob Texturen erzeugt werden sollen. true liefert ein texturiertes Modell, false überspringt den Texturierungsschritt und liefert ein Netz ohne Texturen.

Gilt nur wenn should_texture = true
  • Name
    enable_pbr
    Type
    boolean
    Standard false
    Description

    Ob zusätzlich zur Grundfarbe auch Metallic-, Roughness- und Normal-Maps erzeugt werden sollen. Mit meshy-6 erzeugt Meshy zudem eine Emission-Map, außer bei texture_resolution: 8k. Die anderen Modelle erzeugen keine Emission-Map.

  • Name
    texture_resolution
    Type
    string
    Standard 2k
    Description

    Die Größe der Grundfarbtextur. Eine größere Größe erfasst mehr Oberflächendetails.

    Verfügbare Werte:

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

    4k und 8k erfordern meshy-6, meshy-7.1 oder latest. Bei 8k erzeugt Meshy keine Emission-Map.

  • Name
    hd_texture
    Type
    boolean
    ⚠ veraltet
    Standard false
    Description

    Senden Sie stattdessen texture_resolution. hd_texture: true entspricht texture_resolution: "4k". Wenn Sie beides senden, verwendet Meshy texture_resolution.

  • Name
    texture_prompt
    Type
    string
    Description

    Text, der die Textur steuert, bis zu 800 Zeichen. Längerer Text führt zu 400.

  • Name
    texture_image_url
    Type
    string
    Description

    Ein 2D-Bild, das die Textur steuert, als öffentliche URL oder als Data URI, zum Beispiel data:image/jpeg;base64,<ihre base64-codierten Bilddaten>. Das Bild muss eine .jpg-, .jpeg-, .png- oder .webp-Datei von höchstens 20 MB sein.

    Wenn Sie sowohl texture_image_url als auch texture_prompt senden, verwendet Meshy texture_prompt.

  • Name
    texture_image_urls
    Type
    string[]
    Description

    Ein bis vier Bilder des Objekts aus unterschiedlichen Ansichten, die die Textur steuern. Meshy verwendet das erste Bild als Vorderansicht. Die Reihenfolge der übrigen Ansichten (links, hinten, rechts) spielt keine Rolle.

    Jedes Bild folgt denselben Regeln wie texture_image_url. Es ist eine öffentliche URL oder eine Data URI im Format .jpg, .jpeg, .png oder .webp mit höchstens 20 MB.

    Diese Bilder steuern nur die Textur und sind unabhängig von image_urls. Die beiden Listen können unterschiedliche Bilder und unterschiedliche Anzahlen von Bildern enthalten.

    texture_image_urls erfordert meshy-7.1, latest oder das veraltete meshy-7. Sie können es nicht zusammen mit texture_image_url oder texture_prompt senden.

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

    Ob das Modell nach der Erzeugung neu vernetzt werden soll. Für das qualitativ hochwertigste 3D-Modell setzen Sie es auf false.

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

    Der Flächentyp des neu vernetzten Modells.

    Verfügbare Werte:

    • quad: ein überwiegend aus Vierecken bestehendes Netz
    • triangle: ein reduziertes Dreiecksnetz
  • Name
    target_polycount
    Type
    integer
    Standard 30000
    Description

    Die anzustrebende Anzahl an Flächen, von 100 bis 300000. Das Ergebnis kann je nach Geometrie des Modells vom Zielwert abweichen. Ein Wert außerhalb des Bereichs führt zu 400.

  • Name
    decimation_mode
    Type
    integer
    Description

    Adaptive Flächenanzahl, nach Stufe. Wenn Sie dies setzen, ignoriert Meshy target_polycount.

    Verfügbare Werte:

    • 1: ultra
    • 2: hoch
    • 3: mittel
    • 4: niedrig
  • Name
    save_pre_remeshed_model
    Type
    boolean
    Standard false
    Description

    Ob zusätzlich die GLB-Datei vor der Neuvernetzung gespeichert werden soll, zurückgegeben in model_urls.pre_remeshed_glb.

  • Name
    symmetry_mode
    Type
    string
    ⚠ veraltet
    Standard auto
    Description

    Lassen Sie es weg. Es hat keinen Einfluss auf die Ausgabe.

    Verfügbare Werte:

    • off: keine Symmetrie
    • auto: Symmetrie basierend auf der Eingabegeometrie
    • on: erzwungene Symmetrie
  • Name
    pose_mode
    Type
    string
    Standard ""
    Description

    Die Pose des erzeugten Modells.

    Verfügbare Werte:

    • a-pose: eine A-Pose
    • t-pose: eine T-Pose
    • "" (leere Zeichenfolge): keine bestimmte Pose
  • Name
    is_a_t_pose
    Type
    boolean
    ⚠ veraltet
    Standard false
    Description

    Senden Sie stattdessen pose_mode. Ob das Modell in einer A- oder T-Pose erzeugt werden soll.

  • Name
    image_enhancement
    Type
    boolean
    Standard true
    Description

    Ob die Eingabebilder vor der Erzeugung optimiert werden sollen. false behält das exakte Aussehen der Eingabebilder bei, ohne Stilbearbeitung. Wird nur mit meshy-6, meshy-7.1 oder latest unterstützt. Das Senden mit meshy-6-lite führt zu 400.

  • Name
    remove_lighting
    Type
    boolean
    Standard true
    Description

    Ob Glanzlichter und Schatten aus der Grundfarbtextur entfernt werden sollen. Das sauberere Ergebnis funktioniert besser unter Ihrer eigenen Beleuchtung. Nur meshy-6 verwendet dies. meshy-7, meshy-7.1 und latest akzeptieren es, ignorieren es aber. Bei texture_resolution: 8k entfernt Meshy die Beleuchtung immer. Das Senden mit meshy-6-lite führt zu 400.

  • Name
    moderation
    Type
    boolean
    Standard false
    Description

    Ob die Eingaben auf schädliche Inhalte geprüft werden sollen. Meshy prüft jedes Eingabebild, texture_image_url bzw. jedes Bild in texture_image_urls, sowie den Text in texture_prompt. Wenn Meshy schädliche Inhalte findet, liefert die Anfrage 400 und Meshy erstellt keine Aufgabe.

  • Name
    target_formats
    Type
    string[]
    Description

    Die zu erzeugenden 3D-Dateiformate. Meshy erzeugt und liefert nur die aufgeführten Formate, was die Aufgabe verkürzen kann.

    Verfügbare Werte:

    • glb
    • obj
    • fbx
    • stl
    • usdz
    • 3mf

    Wenn Sie es weglassen, erzeugt Meshy jedes Format außer 3mf. Meshy erzeugt 3mf nur, wenn Sie es angeben.

  • Name
    auto_size
    Type
    boolean
    Standard false
    Description

    Ob die reale Höhe des Objekts mittels KI-Bildverarbeitung geschätzt und das Modell darauf skaliert werden soll. Meshy legt den Ursprung unten an, sofern Sie nicht origin_at setzen.

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

    Wo der Ursprung des Modells platziert werden soll, bottom oder center.

  • Name
    alpha_thumbnail
    Type
    boolean
    Standard false
    Description

    Ob zusätzlich eine Vorschau mit transparentem Hintergrund (RGBA) gerendert werden soll, zurückgegeben in alpha_thumbnail_url, wenn Sie die Aufgabe abrufen. thumbnail_url ändert sich dadurch nicht.

  • Name
    multi_view_thumbnails
    Type
    boolean
    Standard false
    Description

    Ob zusätzlich Vorder-, Rechts-, Rück- und Linksansicht-Vorschauen gerendert werden sollen, zurückgegeben in thumbnail_urls, wenn Sie die Aufgabe abrufen. thumbnail_url ändert sich dadurch nicht und zeigt weiterhin die Vorderansicht. Dies verlängert die Aufgabe um etwa 5 Sekunden.

Rückgabewerte

Das Feld result der Antwort enthält die ID der neuen Multi-Bild-zu-3D-Aufgabe.

Fehlermodi

  • Name
    400 - Bad Request
    Description

    Die Anfrage kann nicht ausgeführt werden. Die Fehlermeldung gibt an, welches Problem gefunden wurde. Zum Beispiel:

    • Fehlender Parameter: Weder image_urls noch input_task_id wurde gesendet.
    • Ungültige Eingabeaufgabe: input_task_id ist keine SUCCEEDED-Text-zu-Bild- oder Bild-zu-Bild-Aufgabe oder keine Mehransicht-Aufgabe.
    • Ungültige Bildanzahl: image_urls oder texture_image_urls enthält nicht 1 bis 4 Bilder.
    • Ungültiges Bildformat: Ein Bild in image_urls liegt nicht in einem unterstützten Format vor.
    • Widersprüchliche Textureingaben: texture_image_urls wurde zusammen mit texture_image_url, mit texture_prompt oder mit should_texture: false gesendet.
    • Nicht unterstütztes Modell für Mehransicht-Textur: texture_image_urls wurde mit meshy-6 oder meshy-6-lite gesendet.
    • Nicht erreichbare URL: Meshy kann ein Bild in image_urls oder texture_image_urls nicht herunterladen.
    • Bild zu groß: Ein Bild in image_urls, texture_image_url oder texture_image_urls ist größer als 20 MB.
    • Nicht unterstützte Auflösung für Mehrbild-Eingabe: geometry_resolution ist "4k", was dieser Endpunkt nicht unterstützt. Verwenden Sie 2k oder standard.
    • Nicht unterstütztes Modell für Bildoptionen: image_enhancement oder remove_lighting wurde mit ai_model: "meshy-6-lite" gesendet.

    Korrigieren Sie die Anfrage, und senden Sie sie erneut. Siehe Fehler.

  • Name
    401 - Unauthorized
    Description

    Der API-Schlüssel fehlt oder ist ungültig. Überprüfen Sie den Authorization-Header.

  • Name
    402 - Payment Required
    Description

    Zum Beispiel:

    • Unzureichende Credits: Das Konto verfügt nicht über genügend Credits für diese Aufgabe, oder das Konto hat ein Credit-Limit erreicht. Überprüfen Sie Ihr Credit-Guthaben und versuchen Sie es erneut.
    • Kostenloser Plan: Das Erstellen einer Aufgabe erfordert einen kostenpflichtigen Plan. Aktualisieren Sie Ihren Plan in Ihren Abonnementeinstellungen, und versuchen Sie es erneut.
  • Name
    404 - Not Found
    Description

    input_task_id stimmt mit keiner Ihrer Aufgaben überein. Überprüfen Sie die Aufgaben-ID, und senden Sie die Anfrage erneut.

  • Name
    429 - Too Many Requests
    Description

    Sie haben Ihre Ratenbegrenzung überschritten. Warten Sie, und versuchen Sie es erneut. Siehe Ratenbegrenzungen.


GET/openapi/v1/multi-image-to-3d/:id

Eine Multi-Bild zu 3D-Aufgabe abrufen

Gibt eine Multi-Bild zu 3D-Aufgabe anhand ihrer ID zurück.

Request

GET
/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

Parameter

  • Name
    id
    Type
    path
    Description

    Die Aufgaben-ID aus der Erstellungsantwort.

Rückgabe

Das Multi-Bild zu 3D-Aufgabenobjekt.


DELETE/openapi/v1/multi-image-to-3d/:id

Multi-Image zu 3D Task löschen

Löscht einen Multi-Bild zu 3D Task dauerhaft, einschließlich seiner Modelle und Daten. Ein Löschvorgang kann nicht rückgängig gemacht werden.

Request

DELETE
/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/multi-image-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."
}

Pfadparameter

  • Name
    id
    Type
    path
    Description

    Die ID des zu löschenden Tasks.

Task-Status

Das Löschen eines PENDING-Tasks erstattet die Credits, die bei seiner Erstellung verwendet wurden.

Ein IN_PROGRESS-Task kann nicht gelöscht werden. Die Anfrage gibt 409 Conflict zurück, und der Task läuft weiter. Meshy erstattet keine Credits für einen Task, der bereits gestartet wurde. Das Löschen würde Sie also sowohl die Credits als auch das Ergebnis kosten. Warten Sie, bis der Status SUCCEEDED, FAILED oder CANCELED erreicht ist, und löschen Sie ihn dann.

Das Löschen eines Tasks mit einem endgültigen Status (SUCCEEDED, FAILED oder CANCELED) erstattet keine Credits.

Rückgabewerte

200 OK, wenn der Task gelöscht wurde, oder 409 Conflict, wenn der Task IN_PROGRESS ist.


GET/openapi/v1/multi-image-to-3d

Multi-Bild-zu-3D-Aufgaben auflisten

Gibt eine Liste Ihrer Multi-Bild-zu-3D-Aufgaben zurück.

Request

GET
/openapi/v1/multi-image-to-3d
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-image-to-3d",
    "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=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "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"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 30
  }
]

Parameter

  • Name
    page_num
    Type
    integer
    Standard 1
    Description

    Die zurückzugebende Seitenzahl, beginnend bei 1.

  • Name
    page_size
    Type
    integer
    Standard 10
    Description

    Die Anzahl der Aufgaben pro Seite, bis zu 100.

  • Name
    sort_by
    Type
    string
    Description

    Die Sortierreihenfolge.

    Verfügbare Werte:

    • +created_at: älteste zuerst
    • -created_at: neueste zuerst

Rückgabe

Eine paginierte Liste von Multi-Bild-zu-3D-Aufgabenobjekten.


GET/openapi/v1/multi-image-to-3d/:id/stream

Einen Multi-Bild-zu-3D-Task streamen

Streamt die Aktualisierungen eines Multi-Bild-zu-3D-Tasks als Server-Sent Events (SSE).

Request

GET
/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/multi-image-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",
  "type": "multi-image-to-3d",
  "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=***",
  "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=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
  "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
  "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
  "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
  "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

Parameter

  • Name
    id
    Type
    path
    Description

    Die Task-ID aus der Erstellungs-Antwort.

Rückgabe

Ein Stream von Multi-Bild-zu-3D-Task-Objekten als Server-Sent Events.

Jedes Ereignis enthält das vollständige Task-Objekt, in derselben Form, die der Get-Endpunkt zurückgibt. Solange der Task PENDING oder IN_PROGRESS ist, haben seine Ergebnisfelder noch keine Werte.


Das Multi-Bild-zu-3D-Task-Objekt

Ein Multi-Bild-zu-3D-Task-Objekt beschreibt eine Generierung eines 3D-Modells aus ein bis vier Bildern eines Objekts. Es enthält den Status, den progress und die Modelldateien, wenn der Task erfolgreich ist.

Eigenschaften

Example Multi-Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

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

    Die Task-ID. Behandeln Sie sie als eine undurchsichtige Zeichenfolge und verlassen Sie sich nicht auf ihr Format.

  • Name
    type
    Type
    string
    Description

    Der Task-Typ, immer multi-image-to-3d.

  • Name
    model_urls
    Type
    object
    Description

    Download-URLs für das generierte 3D-Modell, eine pro Dateiformat. Ein Format, das der Task nicht generiert hat, hat keinen Schlüssel, statt einer leeren Zeichenfolge.

    • Name
      glb
      Type
      string
      Description

      Die GLB-Datei.

    • Name
      fbx
      Type
      string
      Description

      Die FBX-Datei.

    • Name
      obj
      Type
      string
      Description

      Die OBJ-Datei.

    • Name
      usdz
      Type
      string
      Description

      Die USDZ-Datei.

    • Name
      mtl
      Type
      string
      Description

      Die MTL-Datei, die zusammen mit der OBJ-Datei zurückgegeben wird, wenn das Modell Texturen hat.

    • Name
      stl
      Type
      string
      Description

      Die STL-Datei.

    • Name
      3mf
      Type
      string
      Description

      Die 3MF-Datei. Nur vorhanden, wenn target_formats 3mf enthält.

    • Name
      pre_remeshed_glb
      Type
      string
      Description

      Die GLB-Datei von vor der Neuvernetzung. Nur vorhanden, wenn Sie den Task sowohl mit should_remesh: true als auch mit save_pre_remeshed_model: true erstellt haben.

  • Name
    thumbnail_url
    Type
    string
    Description

    Download-URL für ein Vorschaubild des Modells. Es ist identisch mit thumbnail_urls.front, wenn dieses Feld vorhanden ist.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Download-URL für eine Version von thumbnail_url mit transparentem Hintergrund (RGBA). Nur vorhanden, wenn Sie den Task mit alpha_thumbnail: true erstellt haben und Meshy die transparente Vorschau gerendert hat.

  • Name
    thumbnail_urls
    Type
    object
    Description

    Download-URLs für Vorschauen des 3D-Modells aus vier Richtungen. Jede ist eine signierte URL zu einem 512×512-PNG, gerendert mit denselben Materialien und derselben Beleuchtung wie thumbnail_url. Sie können diese verwenden, um das Modell aus mehreren Blickwinkeln zu betrachten, ohne die GLB-Datei herunterzuladen.

    Nur vorhanden, wenn Sie den Task mit multi_view_thumbnails: true erstellt haben und der Task SUCCEEDED erreicht hat. Ein Task, der ohne multi_view_thumbnails: true erstellt wurde, hat dieses Feld nicht.

    • Name
      front
      Type
      string
      Description

      Die Vorderansicht, bei 0° um die vertikale Achse. Sie entspricht thumbnail_url.

    • Name
      right
      Type
      string
      Description

      Die rechte Ansicht, bei 90°.

    • Name
      back
      Type
      string
      Description

      Die Rückansicht, bei 180°.

    • Name
      left
      Type
      string
      Description

      Die linke Ansicht, bei 270°.

  • Name
    texture_prompt
    Type
    string
    Description

    Der Text-prompt, der die Textur geleitet hat.

  • Name
    texture_image_urls
    Type
    string[]
    Description

    Download-URLs für die Textur-Referenzbilder, mit denen Sie den Task erstellt haben, in der Reihenfolge, in der Sie sie gesendet haben. Nur vorhanden, wenn Sie den Task mit texture_image_urls erstellt haben.

  • Name
    ultra_mode
    Type
    boolean
    ⚠ veraltet
    Description

    Lesen Sie stattdessen geometry_resolution.

  • Name
    geometry_resolution
    Type
    string
    Description

    Die Ultra-Stufe, mit der der Task ausgeführt wurde, nämlich 2k. Ein standard-Task hat dieses Feld nicht.

  • Name
    progress
    Type
    integer
    Description

    Wie viel des Tasks erledigt ist, als Prozentsatz. Es ist 0, bis der Task startet, und 100, wenn er erfolgreich ist.

  • Name
    started_at
    Type
    timestamp
    Description

    Zeitpunkt, zu dem der Task gestartet wurde, in Unix-Millisekunden. Es ist 0, bis der Task startet.

  • Name
    created_at
    Type
    timestamp
    Description

    Zeitpunkt, zu dem der Task erstellt wurde, in Unix-Millisekunden.

  • Name
    expires_at
    Type
    timestamp
    Description

    Zeitpunkt, zu dem die Ergebnisse des Tasks ablaufen, in Unix-Millisekunden.

  • Name
    finished_at
    Type
    timestamp
    Description

    Zeitpunkt, zu dem der Task beendet wurde, in Unix-Millisekunden. Es ist 0, bis der Task beendet ist.

  • Name
    status
    Type
    string
    Description

    Der Task-Status, einer von PENDING, IN_PROGRESS, SUCCEEDED, FAILED oder CANCELED.

  • Name
    texture_urls
    Type
    array
    Description

    Download-URLs für die vom Task generierten Texturkarten, als Array von Objekten. Es enthält normalerweise ein Objekt. Jedes Objekt hat diese Felder:

    • Name
      base_color
      Type
      string
      Description

      Die Basisfarbkarte.

    • Name
      metallic
      Type
      string
      Description

      Die Metallic-Karte. Nicht enthalten, wenn Sie den Task mit enable_pbr: false erstellt haben.

    • Name
      normal
      Type
      string
      Description

      Die Normal Map. Nicht enthalten, wenn Sie den Task mit enable_pbr: false erstellt haben.

    • Name
      roughness
      Type
      string
      Description

      Die Roughness-Karte. Nicht enthalten, wenn Sie den Task mit enable_pbr: false erstellt haben.

    • Name
      emission
      Type
      string
      Description

      Die Emission-Karte. Nur enthalten, wenn Sie den Task mit ai_model: meshy-6 und enable_pbr: true erstellt haben, bei texture_resolution 2k oder 4k.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Die Anzahl der Tasks, die in der Warteschlange vor diesem liegen. Der Wert ist nur aussagekräftig, solange der Task PENDING ist.

  • Name
    task_error
    Type
    object
    Description

    Die Fehlerdetails, wenn der Task fehlschlägt. Siehe Fehler.

  • Name
    consumed_credits
    Type
    integer
    Description

    Die Anzahl der Credits, die der Task verbraucht hat. Vorhanden, wenn der Status PENDING, IN_PROGRESS oder SUCCEEDED ist. Er ist 0 für einen FAILED-Task, da Meshy die Credits erstattet, wenn ein Task fehlschlägt.