Multi-Bild zu 3D API

Die Multi-Bild zu 3D API ist eine Funktion, die es Ihnen ermöglicht, die Multi-Bild zu 3D-Fähigkeiten von Meshy in Ihre eigene Anwendung zu integrieren. In diesem Abschnitt finden Sie alle Informationen, die Sie benötigen, um mit dieser API zu beginnen.

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

Erstellen einer Multi-Bild-zu-3D-Aufgabe

Dieser Endpunkt ermöglicht es Ihnen, eine neue Multi-Bild-zu-3D-Aufgabe zu erstellen. Weitere Informationen dazu, welche Eigenschaften im Multi-Bild-zu-3D-Aufgabenobjekt enthalten sind, finden Sie unter Das Multi-Bild-zu-3D-Aufgabenobjekt.

Parameter

Nur eines der beiden Felder input_task_id oder image_urls ist erforderlich. Wenn beide angegeben werden, hat input_task_id Priorität.

Name
input_task_id
Type
string
Erforderlich
Description
Die ID einer abgeschlossenen Bildgenerierungsaufgabe, deren Ausgabe (1–4 Bilder) als Eingabe verwendet werden soll. Diese Aufgabe muss eine der folgenden sein: Text zu Bild, Bild zu Bild, Text zu Bild Mehransicht oder Bild zu Bild Mehransicht. Zudem muss sie über die API ausgeführt worden sein und den Status SUCCEEDED haben.

Name
image_urls
Type
array
Erforderlich
Description
Geben Sie 1 bis 4 Bilder an, die Meshy zur Modellerstellung verwenden soll. Aktuell werden die Formate .jpg, .jpeg und .png unterstützt. Für beste Ergebnisse sollten alle Bilder dasselbe Objekt aus verschiedenen Blickwinkeln zeigen.
Es gibt zwei Möglichkeiten, jedes Bild anzugeben:
- Öffentlich zugängliche URL: Eine URL, die aus dem öffentlichen Internet erreichbar ist.
- Data URI: Ein base64-codierter Data URI des Bildes. Beispiel für einen Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Bei meshy-7 (oder latest) wird das erste Bild als primäre (Vorder-)Ansicht verwendet. Die Reihenfolge der übrigen Bilder spielt keine Rolle.

Name
ai_model
Type
string
Standard latest
Description
ID des zu verwendenden Modells. Verfügbare Werte: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
ultra_mode
Type
boolean
Standard false
Description
Aktiviert die Ultra-Generierung für Geometrie mit höherer Detailtreue und feineren Oberflächendetails.
Wird nur unterstützt, wenn ai_model auf meshy-7 (oder latest) gesetzt ist.
Name
should_texture
Type
boolean
Standard true
Description
Legt fest, ob Texturen generiert werden. Wenn dieser Wert auf false gesetzt wird, wird die Texturierungsphase übersprungen und ein Netz ohne Texturen erzeugt.

Gilt nur wenn should_texture = true

Name
enable_pbr
Type
boolean
Standard false
Description
Generiert zusätzlich zur Grundfarbe PBR-Texturen (Metallic, Roughness, Normal). Eine Emissionskarte wird ebenfalls einbezogen, wenn ai_model meshy-6 ist, außer bei texture_resolution: 8k. meshy-7 und latest erzeugen keine Emissionskarte.
Name
texture_resolution
Type
string
Standard 2k
Description
Auflösung der Grundfarbtextur. Entweder 2k (2048×2048), 4k (4096×4096) oder 8k (8192×8192). Höhere Auflösungen erfassen mehr Oberflächendetails.
4k und 8k erfordern ai_model meshy-6, meshy-7 oder latest. Bei 8k wird keine Emissionskarte erzeugt.
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 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. Aktuell werden die Formate .jpg, .jpeg und .png unterstützt.
Es gibt zwei Möglichkeiten, das Bild anzugeben:
- Öffentlich zugängliche URL: Eine URL, die aus dem öffentlichen Internet erreichbar ist
- Data URI: Ein base64-codierter Data URI des Bildes. Beispiel für einen Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Die Bildtexturierung funktioniert möglicherweise nicht optimal, wenn erhebliche geometrische Unterschiede zwischen dem ursprünglichen Asset und dem hochgeladenen Bild bestehen. Nur eines der beiden Felder texture_image_url oder texture_prompt kann zur Steuerung des Texturierungsprozesses verwendet werden. Wenn beide Parameter angegeben werden, wird standardmäßig texture_prompt zur Texturierung des Modells verwendet.
Name
texture_image_urls
Type
string[]
Description
Geben Sie 1 bis 4 Bilder an, die dasselbe Objekt aus verschiedenen Ansichten zeigen, um die Texturierung zu steuern. Das erste Bild ist die primäre (Vorder-)Ansicht; die Reihenfolge der übrigen Ansichten (links, hinten, rechts) spielt keine Rolle.
Jedes Element akzeptiert die gleichen Formate wie texture_image_url (eine öffentlich zugängliche URL oder ein base64-Data-URI, .jpg/.jpeg/.png).
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.
Erfordert ai_model meshy-7 oder latest. Kann nicht mit texture_image_url oder texture_prompt kombiniert werden.

Name
should_remesh
Type
boolean
Standard false (meshy-6), true (others)
Description
Legt fest, 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
Geben Sie die topology des generierten Modells an.
Verfügbare Werte:
- quad: Erzeugt ein überwiegend aus Quads bestehendes Netz.
- triangle: Erzeugt ein reduziertes Dreiecksnetz.
Name
target_polycount
Type
integer
Standard 30,000
Description
Geben Sie die Ziel-Polygonanzahl im generierten Modell an. Die tatsächliche Anzahl der Polygone kann je nach Komplexität der Geometrie vom Zielwert abweichen.
Der gültige Wertebereich variiert je nach Nutzerstufe:
- 100 bis 300.000 (einschließlich)
Name
decimation_mode
Type
integer
Description
Aktiviert die adaptive Reduzierung durch Festlegen eines Polygonanzahl-Levels. Wenn dieser Wert gesetzt ist, wird target_polycount ignoriert.
Verfügbare Werte:
- 1: Adaptiv — sehr hohe Polygonanzahl.
- 2: Adaptiv — hohe Polygonanzahl.
- 3: Adaptiv — mittlere Polygonanzahl.
- 4: Adaptiv — niedrige Polygonanzahl.
Name
save_pre_remeshed_model
Type
boolean
Standard false
Description
Wenn dieser Wert auf true gesetzt ist, speichert Meshy zusätzlich eine weitere GLB-Datei, bevor die Neuvernetzungsphase abgeschlossen ist.

Name
symmetry_mode
Type
string
⚠ veraltet
Standard auto
Description
Veraltet. Dieser Parameter hat keine Auswirkung mehr auf die Ausgabe.
Das Feld symmetry_mode steuert das Symmetrieverhalten während des Modellgenerierungsprozesses.
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
Geben Sie 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 bestimmte Pose angewendet.
Name
is_a_t_pose
Type
boolean
⚠ veraltet
Standard false
Description
Verwenden Sie stattdessen pose_mode. Legt fest, ob das Modell in einer A/T-Pose generiert wird.
Name
image_enhancement
Type
boolean
Standard true
Description
Optimiert die Eingabebilder für bessere Ergebnisse. Setzen Sie diesen Wert auf false, um das exakte Erscheinungsbild der Eingabebilder ohne jegliche Stilverarbeitung zu erhalten.
Wird nur unterstützt, wenn ai_model meshy-6, meshy-7 oder latest ist.
Name
remove_lighting
Type
boolean
Standard true
Description
Entfernt Glanzlichter und Schatten aus der Grundfarbtextur, was ein saubereres Ergebnis liefert, das unter benutzerdefinierten Beleuchtungssetups besser funktioniert.
Wird nur unterstützt, wenn ai_model meshy-6, meshy-7 oder latest ist.
Name
moderation
Type
boolean
Standard false
Description
Wenn dieser Wert auf true gesetzt ist, wird der Eingabeinhalt automatisch auf potenziell schädliche Inhalte überprüft. Wird schädlicher Inhalt erkannt, wird die Aufgabe nicht zur Generierung fortgesetzt.
Jedes Bild aus image_urls und der Text aus texture_prompt werden überprüft.
Name
target_formats
Type
string[]
Description
Legt fest, welche 3D-Dateiformate in die Ausgabe einbezogen werden sollen. Es werden nur die angeforderten Formate generiert und zurückgegeben, was die Bearbeitungszeit der Aufgabe verkürzen kann.
Verfügbare Werte: glb, obj, fbx, stl, usdz, 3mf
Wenn dieser Parameter ausgelassen wird, werden alle Formate außer 3mf generiert. 3mf wird nur einbezogen, wenn es explizit angegeben wird.
Name
auto_size
Type
boolean
Standard false
Description
Wenn dieser Wert auf true gesetzt ist, verwendet der Dienst KI-basierte Bildanalyse, 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.
Name
alpha_thumbnail
Type
boolean
Standard false
Description
Wenn dieser Wert auf true gesetzt ist, 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 vorhandene Feld thumbnail_url bleibt unverändert.
Name
multi_view_thumbnails
Type
boolean
Standard false
Description
Wenn dieser Wert auf true gesetzt ist, rendert die Aufgabe zusätzlich vier Ansichten aus den Hauptrichtungen (vorne, rechts, hinten, links) und gibt diese unter thumbnail_urls in der GET-Antwort zurück. Das vorhandene Feld thumbnail_url bleibt unverändert und verweist weiterhin auf die Vorderansicht, sodass bestehende Clients nicht beeinträchtigt werden.
Erhöht die Aufgabenlatenz um etwa 3 Sekunden.

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 Multi-Bild-zu-3D-Aufgabe.

Fehlermodi

Name
400 - Bad Request
Description
Die Anfrage war ungültig. Häufige Ursachen:
- Fehlender Parameter: Entweder image_urls oder input_task_id muss angegeben werden.
- Ungültige Eingabeaufgabe: input_task_id muss auf eine Aufgabe des Typs Text zu Bild, Bild zu Bild oder eine Mehransicht-Variante mit Status SUCCEEDED verweisen.
- Ungültige Bildanzahl: image_urls muss zwischen 1 und 4 Bilder enthalten, texture_image_urls zwischen 1 und 4.
- Ungültiges Bildformat: Ein oder mehrere Bilder in image_urls haben ein nicht unterstütztes Format.
- Widersprüchliche Textureingaben: texture_image_urls kann nicht mit texture_image_url oder texture_prompt kombiniert werden und erfordert should_texture: true.
- Nicht unterstütztes Modell für Mehransicht-Textur: texture_image_urls erfordert ai_model meshy-7 oder latest.
- Nicht erreichbare URL: Ein oder mehrere Elemente aus image_urls oder texture_image_urls konnten nicht herunterladen werden.
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/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 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>"
    ],
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

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

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

Abrufen einer Multi-Bild zu 3D-Aufgabe

Dieser Endpunkt ermöglicht es Ihnen, eine Multi-Bild zu 3D-Aufgabe abzurufen, wenn eine gültige Aufgaben-id angegeben wird. Siehe Das Multi-Bild zu 3D-Aufgabenobjekt, um zu sehen, welche Eigenschaften im Multi-Bild zu 3D-Aufgabenobjekt enthalten sind.

Parameter

Name
id
Type
path
Description
Eindeutiger Bezeichner für die abzurufende Multi-Bild zu 3D-Aufgabe.

Rückgabe

Die Antwort enthält das Multi-Bild zu 3D-Aufgabenobjekt. Überprüfen Sie den Abschnitt Das Multi-Bild zu 3D-Aufgabenobjekt für Details.

Anfrage

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

Antwort

{
  "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",
      "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": 30
}

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

Löschen einer Multi-Bild zu 3D Aufgabe

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

Pfadparameter

Name
id
Type
path
Description
Die ID der zu löschenden Multi-Bild zu 3D Aufgabe.

Rückgaben

Gibt 200 OK bei Erfolg zurück.

Anfrage

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

Antwort

// Returns 200 Ok on success.

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

Liste der Multi-Bild zu 3D Aufgaben

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

Parameter

Optionale Attribute

Name
page_num
Type
integer
Description
Seitennummer für die Paginierung. Beginnt und standardmäßig auf 1.
Name
page_size
Type
integer
Description
Begrenzung der Seitengröße. Standardmäßig 10 Einträge. 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ückgaben

Gibt eine paginierte Liste von Die Multi-Bild zu 3D Aufgaben Objekte zurück.

Anfrage

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

Antwort

[
  {
    "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",
        "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": 30
  }
]

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

Streamen einer Multi-Bild zu 3D Aufgabe

Dieser Endpunkt streamt Echtzeit-Updates für eine Multi-Bild zu 3D Aufgabe unter Verwendung von Server-Sent Events (SSE).

Parameter

Name
id
Type
path
Description
Eindeutiger Bezeichner für die Multi-Bild zu 3D Aufgabe, die gestreamt werden soll.

Rückgaben

Gibt einen Stream von Die Multi-Bild zu 3D Aufgabenobjekte als Server-Sent Events zurück.

Für PENDING oder IN_PROGRESS Aufgaben enthält der Antwortstream nur die notwendigen progress und status Felder.

Anfrage

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

Antwortstream

// 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",
  "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",
      "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": 30
}

Das Multi-Bild zu 3D Task-Objekt

Das Multi-Bild zu 3D Task-Objekt ist eine Arbeitseinheit, die Meshy verfolgt, um ein 3D-Modell aus mehreren Bildern (zwischen 1 und 4 einschließlich) zu generieren. Die Bilder sollten dasselbe Objekt zeigen, idealerweise aus verschiedenen Ansichten oder Blickwinkeln. Das Objekt verfügt über folgende Eigenschaften:

Eigenschaften

Name
id
Type
string
Description
Eindeutiger Bezeichner für den Task. 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 des Multi-Bild zu 3D Tasks. Der Wert ist multi-image-to-3d.
Name
model_urls
Type
object
Description
Herunterladbare URL zur texturierten 3D-Modelldatei, die von Meshy generiert wurde. Die Eigenschaft für ein Format wird weggelassen, wenn das Format nicht generiert wurde, anstatt einen leeren String zurückzugeben.
- Name
  glb
  Type
  string
  Description
  Herunterladbare URL zur GLB-Datei.
- Name
  fbx
  Type
  string
  Description
  Herunterladbare URL zur FBX-Datei.
- Name
  obj
  Type
  string
  Description
  Herunterladbare URL zur OBJ-Datei.
- Name
  usdz
  Type
  string
  Description
  Herunterladbare URL zur USDZ-Datei.
- Name
  mtl
  Type
  string
  Description
  Herunterladbare URL zur MTL-Datei, die zusammen mit OBJ-Exporten zurückgegeben wird, wenn Texturen vorhanden sind.
- 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
  pre_remeshed_glb
  Type
  string
  Description
  Herunterladbare URL zur ursprünglichen GLB-Ausgabe vor dem Remeshing.
  Nur verfügbar, wenn der Task sowohl mit should_remesh: true als auch mit save_pre_remeshed_model: true erstellt wurde.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zum Miniaturbild der Modelldatei. Entspricht thumbnail_urls.front, sofern vorhanden, und wird aus Gründen der Abwärtskompatibilität beibehalten.
Name
alpha_thumbnail_url
Type
string
Description
Herunterladbare URL zu einer Version von thumbnail_url mit transparentem Hintergrund (RGBA). Nur vorhanden, wenn der Task mit alpha_thumbnail: true erstellt wurde und die transparente Vorschau erfolgreich gerendert wurde; andernfalls wird dieses Feld weggelassen.
Name
thumbnail_urls
Type
object
Description
Herunterladbare URLs für vier Miniaturansichten des generierten 3D-Modells aus den vier Haupthimmelsrichtungen. Jeder Wert ist eine signierte URL zu einem 512×512-PNG, das mit denselben Materialien und derselben Beleuchtung wie thumbnail_url gerendert wurde. Nützlich, um das Modell in Batch-Pipelines aus mehreren Blickwinkeln zu betrachten, ohne die GLB-Datei herunterzuladen.
Nur vorhanden, wenn der Task mit multi_view_thumbnails: true erstellt wurde und den Status SUCCEEDED erreicht hat. Ältere Tasks und Tasks, die ohne diese Opt-in-Option erstellt wurden, enthalten dieses Feld nicht.
- Name
  front
  Type
  string
  Description
  Frontansicht, 0° Drehung um die vertikale Achse (entspricht thumbnail_url).
- Name
  right
  Type
  string
  Description
  Rechte Ansicht, 90° Drehung.
- Name
  back
  Type
  string
  Description
  Rückansicht, 180° Drehung.
- Name
  left
  Type
  string
  Description
  Linke Ansicht, 270° Drehung.
Name
texture_prompt
Type
string
Description
Der Text-Prompt, der zur Steuerung des Texturierungsprozesses verwendet wurde.
Name
texture_image_urls
Type
string[]
Description
Herunterladbare URLs zu den Textur-Referenzbildern, die zur Erstellung des Tasks verwendet wurden, in der Reihenfolge, in der sie angegeben wurden. Nur vorhanden, wenn der Task mit texture_image_urls erstellt wurde.
Name
ultra_mode
Type
boolean
Description
Gibt den Wert von ultra_mode wieder, mit dem der Task erstellt wurde. Nur vorhanden bei meshy-7-Tasks (oder latest), die ultra_mode explizit gesetzt haben; andernfalls weggelassen.
Name
progress
Type
integer
Description
Fortschritt des Tasks. Wenn der Task noch nicht gestartet wurde, ist diese Eigenschaft 0. Sobald der Task erfolgreich war, wird dieser Wert 100.
Name
started_at
Type
timestamp
Description
Zeitstempel, wann der Task gestartet wurde, in Millisekunden. Wenn der Task noch nicht gestartet wurde, ist diese Eigenschaft 0.
Ein Zeitstempel repräsentiert die Anzahl der Millisekunden, die seit dem 1. Januar 1970 UTC vergangen sind, gemäß dem Standard RFC 3339. Beispielsweise wird Freitag, 1. September 2023, 12:00:00 Uhr GMT als 1693569600000 dargestellt. Dies gilt für alle Zeitstempel in der Meshy API.
Name
created_at
Type
timestamp
Description
Zeitstempel, wann der Task erstellt wurde, in Millisekunden.
Name
expires_at
Type
timestamp
Description
Zeitstempel, wann das Ergebnis des Tasks abläuft, in Millisekunden.
Name
finished_at
Type
timestamp
Description
Zeitstempel, wann der Task abgeschlossen wurde, in Millisekunden. Wenn der Task noch nicht abgeschlossen ist, ist diese Eigenschaft 0.
Name
status
Type
string
Description
Status des Tasks. Mögliche Werte sind PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Ein Array von Textur-URL-Objekten, die aus dem Task generiert werden. Normalerweise enthält dies nur ein Textur-URL-Objekt. Jede Textur-URL hat die folgenden Eigenschaften:
- Name
  base_color
  Type
  string
  Description
  Herunterladbare URL zum Basisfarben-Map-Bild.
- Name
  metallic
  Type
  string
  Description
  Herunterladbare URL zum Metallic-Map-Bild.
  Wenn der Task mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
- Name
  normal
  Type
  string
  Description
  Herunterladbare URL zum Normal Map-Bild.
  Wenn der Task mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
- Name
  roughness
  Type
  string
  Description
  Herunterladbare URL zum Roughness-Map-Bild.
  Wenn der Task mit enable_pbr: false erstellt wurde, wird diese Eigenschaft weggelassen.
- Name
  emission
  Type
  string
  Description
  Herunterladbare URL zum Emission-Map-Bild.
  Wenn der Task mit enable_pbr: false erstellt wurde, oder wenn ai_model den Wert meshy-5 hat, wird diese Eigenschaft weggelassen.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorangehenden Tasks.
Der Wert dieses Felds ist nur dann aussagekräftig, wenn der Task-Status PENDING ist.
Name
task_error
Type
object
Description
Fehlerdetails für fehlgeschlagene Tasks. Siehe Fehler für die vollständige Referenz des task_error-Objekts.
Name
consumed_credits
Type
integer
Description
Die Anzahl der von diesem Task verbrauchten Credits. Vorhanden, wenn der Task-Status PENDING, IN_PROGRESS oder SUCCEEDED ist. Gibt 0 für FAILED-Tasks zurück (Credits werden bei einem Fehlschlag zurückerstattet).

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",
      "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": 30,
}