Image-zu-3D-API

Die Image-zu-3D-API ist eine Funktion, mit der du Meshys Image-zu-3D-Funktionen in deine eigene Anwendung integrieren kannst. In diesem Abschnitt findest du alle Informationen, die du benötigst, um mit dieser API loszulegen.

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

Image-to-3D-Aufgabe erstellen

Dieser endpoint ermöglicht es Ihnen, eine neue Image-to-3D-Aufgabe zu erstellen. Siehe Das Image-to-3D-Aufgabenobjekt, um zu sehen, welche Eigenschaften im Image-to-3D-Aufgabenobjekt enthalten sind.

Parameter

Nur eines von input_task_id oder image_url ist erforderlich. Wenn beide angegeben werden, hat input_task_id Vorrang.

Name
input_task_id
Type
string
Erforderlich
Description
Die ID einer abgeschlossenen Bildgenerierungsaufgabe, deren Ausgabe als Eingabebild verwendet werden soll. Diese Aufgabe muss eine der folgenden Aufgaben sein: Text to Image oder Image to Image. Außerdem muss sie über die API ausgeführt worden sein, den Status SUCCEEDED haben und genau ein Bild erzeugen.

Name
image_url
Type
string
Erforderlich
Description
Stellen Sie ein Bild bereit, das Meshy für die Modellerstellung verwenden soll. Wir unterstützen derzeit die Formate .jpg, .jpeg und .png.
Es gibt zwei Möglichkeiten, das Bild bereitzustellen:
- Öffentlich zugängliche URL: Eine URL, die über das öffentliche Internet zugänglich ist.
- Data URI: Eine base64-kodierte Data URI des Bildes. Beispiel für eine Data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
Standard standard
Description
Geben Sie den Typ der 3D-Mesh-Generierung an.
Verfügbare Werte:
- standard: Reguläre 3D-Mesh-Generierung mit hohem Detailgrad.
- lowpoly: Generiert ein Low-Poly-Mesh, das für sauberere Polygone optimiert ist.
Wenn lowpoly ausgewählt ist, werden ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model ignoriert.
Name
ai_model
Type
string
Standard latest
Description
ID des zu verwendenden Modells. Verfügbare Werte: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
Standard true
Description
Legt fest, ob Texturen generiert werden. Wenn dieser Wert auf false gesetzt wird, wird die Texturphase übersprungen und ein Mesh ohne Texturen bereitgestellt.

Gilt nur wenn should_texture = true

Name
enable_pbr
Type
boolean
Standard false
Description
Generiert zusätzlich zur Grundfarbe PBR-Maps (Metallic, Roughness, Normal). Eine Emission-Map ist ebenfalls enthalten, wenn ai_model meshy-6 oder latest ist.
Name
hd_texture
Type
boolean
Standard false
Description
Generiert die Grundfarben-Textur mit 4K-Auflösung (4096×4096) für mehr Detail.
Wird nur unterstützt, wenn ai_model meshy-6 oder latest ist. PBR-Maps werden immer mit 2K generiert.
Name
texture_prompt
Type
string
Description
Stellen Sie einen Text-Prompt bereit, um den Texturierungsprozess zu steuern. Maximal 600 Zeichen.
Name
texture_image_url
Type
string
Description
Stellen Sie ein 2D-Bild bereit, um den Texturierungsprozess zu steuern. Wir unterstützen derzeit die Formate .jpg, .jpeg und .png.
Es gibt zwei Möglichkeiten, das Bild bereitzustellen:
- Öffentlich zugängliche URL: Eine URL, die über das öffentliche Internet zugänglich ist
- Data URI: Eine base64-kodierte Data URI des Bildes. Beispiel für eine Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Bildbasierte Texturierung funktioniert möglicherweise nicht optimal, wenn es erhebliche Geometrieunterschiede zwischen dem ursprünglichen Asset und dem hochgeladenen Bild gibt. Nur eines von texture_image_url oder texture_prompt darf verwendet werden, um den Texturierungsprozess zu steuern. Wenn beide Parameter angegeben werden, wird standardmäßig texture_prompt verwendet, um das Modell zu texturieren. Texturierung per Text oder Bild kostet 10 Credits pro Aufgabe.

Name
should_remesh
Type
boolean
Standard false (meshy-6), true (others)
Description
Steuert, ob die Remesh-Phase aktiviert wird. Wenn auf false gesetzt, gibt die API das Dreiecks-Mesh mit der höchsten Präzision zurück.

Gilt nur wenn should_remesh = true

Name
topology
Type
string
Standard triangle
Description
Geben Sie die Topologie des generierten Modells an.
Verfügbare Werte:
- quad: Generiert ein überwiegend aus Quads bestehendes Mesh.
- triangle: Generiert ein dezimiertes Dreiecks-Mesh.
Name
target_polycount
Type
integer
Standard 30,000
Description
Geben Sie die Zielanzahl der Polygone 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 Benutzerstufe:
- 100 bis 300.000 (einschließlich)
Name
decimation_mode
Type
integer
Description
Aktivieren Sie adaptive Dezimierung, indem Sie ein Polycount-Level festlegen. Wenn gesetzt, wird target_polycount ignoriert.
Verfügbare Werte:
- 1: Adaptiv — ultrahoher Polycount.
- 2: Adaptiv — hoher Polycount.
- 3: Adaptiv — mittlerer Polycount.
- 4: Adaptiv — niedriger Polycount.
Name
save_pre_remeshed_model
Type
boolean
Standard false
Description
Wenn auf true gesetzt, speichert Meshy zusätzlich eine weitere GLB-Datei, bevor die Remesh-Phase abgeschlossen ist.

Name
symmetry_mode
Type
string
⚠ veraltet
Standard auto
Description
Veraltet. Dieser Parameter wirkt sich nicht mehr auf die Ausgabe aus.
Das Feld symmetry_mode steuert das Symmetrieverhalten während des Modellerstellungsprozesses.
Die gültigen Werte sind:
- off: Deaktiviert Symmetrie.
- auto: Bestimmt und wendet Symmetrie automatisch auf Grundlage der Eingabegeometrie an.
- on: Erzwingt Symmetrie während der Generierung.
Name
pose_mode
Type
string
Standard ""
Description
Geben Sie den Posenmodus 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.
- "" (leerer String): Keine spezifische Pose angewendet.
Name
is_a_t_pose
Type
boolean
⚠ veraltet
Standard false
Description
Verwenden Sie stattdessen pose_mode. Gibt an, ob das Modell in einer A-/T-Pose generiert werden soll.
Name
image_enhancement
Type
boolean
Standard true
Description
Optimiert das Eingabebild für bessere Ergebnisse. Setzen Sie den Wert auf false, um das exakte Erscheinungsbild des Eingabebildes ohne jegliche Stilbearbeitung beizubehalten.
Wird nur unterstützt, wenn ai_model meshy-6 oder latest ist.
Name
remove_lighting
Type
boolean
Standard true
Description
Entfernt Highlights und Schatten aus der Grundfarben-Textur und erzeugt ein saubereres Ergebnis, das unter benutzerdefinierten Beleuchtungs-Setups besser funktioniert.
Wird nur unterstützt, wenn ai_model meshy-6 oder latest ist.
Name
moderation
Type
boolean
Standard false
Description
Wenn auf true gesetzt, werden die Eingabeinhalte automatisch auf potenziell schädliche Inhalte geprüft. Wenn schädliche Inhalte erkannt werden, wird die Aufgabe nicht mit der Generierung fortfahren.
Die Inhalte aus den Eingaben image_url, texture_image_url und texture_prompt werden geprü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. Wenn weggelassen, werden alle unterstützten Formate eingeschlossen.
Verfügbare Werte: glb, obj, fbx, stl, usdz, 3mf
Wenn weggelassen, werden alle Formate außer 3mf generiert. 3mf wird nur eingeschlossen, wenn es ausdrücklich angegeben wird.
Name
auto_size
Type
boolean
Standard false
Description
Wenn auf true gesetzt, verwendet der Dienst KI-Vision, um die reale Höhe des Objekts automatisch zu schätzen und die Größe des Modells entsprechend anzupassen. Der Ursprung wird standardmäßig auf bottom gesetzt, sofern origin_at nicht ausdrücklich festgelegt ist.
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 in der GET-Antwort als alpha_thumbnail_url zurück. Das bestehende Feld thumbnail_url bleibt unverändert.
Name
multi_view_thumbnails
Type
boolean
Standard false
Description
Wenn auf true gesetzt, rendert die Aufgabe zusätzlich vier Vorschaubilder aus Kardinalansichten (vorne, rechts, hinten, links) und gibt sie in der GET-Antwort unter thumbnail_urls zurück. Das bestehende Feld thumbnail_url bleibt unverändert und verweist weiterhin auf die Vorderansicht, sodass bestehende Clients nicht betroffen sind.
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ückgabe

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

Fehlermodi

Name
400 - Bad Request
Description
Die Anfrage war nicht akzeptabel. Häufige Ursachen:
- Fehlender Parameter: Entweder image_url oder input_task_id muss bereitgestellt werden.
- Ungültige Eingabeaufgabe: Die input_task_id muss auf eine Text-to-Image- oder Image-to-Image-Aufgabe mit dem Status SUCCEEDED verweisen, die genau ein Bild erzeugt.
- Ungültiges Bildformat: Die bereitgestellte image_url hat kein unterstütztes Format (.jpg, .jpeg, .png).
- Nicht erreichbare URL: Die image_url konnte nicht heruntergeladen werden (404 oder Timeout).
- Ungültige Data URI: Der base64-String ist fehlerhaft.
- Ungültige Parameterkombination: enable_pbr wird nur unterstützt, wenn should_texture true ist.
Name
401 - Unauthorized
Description
Authentifizierung fehlgeschlagen. Bitte überprüfen Sie Ihre API key.
Name
402 - Payment Required
Description
Nicht genügend Credits, um diese Aufgabe auszuführen.
Name
429 - Too Many Requests
Description
Sie haben Ihr Rate Limit überschritten.

Request

POST

/openapi/v1/image-to-3d

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

# With remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

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

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

Eine Bild-zu-3D-Aufgabe abrufen

Dieser endpoint ermöglicht es Ihnen, eine Bild-zu-3D-Aufgabe anhand einer gültigen Aufgaben-id abzurufen. Siehe Das Bild-zu-3D-Aufgabenobjekt, um zu sehen, welche Eigenschaften im Bild-zu-3D-Aufgabenobjekt enthalten sind.

Parameter

Name
id
Type
path
Description
Eindeutige Kennung der abzurufenden Bild-zu-3D-Aufgabe.

Rückgabe

Die Antwort enthält das Bild-zu-3D-Aufgabenobjekt. Weitere Details finden Sie im Abschnitt Das Bild-zu-3D-Aufgabenobjekt.

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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/image-to-3d/:id

Eine Bild-zu-3D-Aufgabe löschen

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

Pfadparameter

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

Rückgabe

Gibt bei Erfolg 200 OK zurück.

Request

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

// Returns 200 Ok on success.

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

Bild-zu-3D-Aufgaben auflisten

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

Parameter

Optionale Attribute

Name
page_num
Type
integer
Description
Seitennummer für die Paginierung. Beginnt bei 1 und ist standardmäßig 1.
Name
page_size
Type
integer
Description
Begrenzung der Seitengröße. Standardmäßig 10 Elemente. Maximal zulässig sind 50 Elemente.
Name
sort_by
Type
string
Description
Feld, nach dem sortiert werden soll. Verfügbare Werte:
- +created_at: Nach Erstellungszeit in aufsteigender Reihenfolge sortieren.
- -created_at: Nach Erstellungszeit in absteigender Reihenfolge sortieren.

Rückgabewerte

Gibt eine paginierte Liste der Bild-zu-3D-Aufgabenobjekte zurück.

Request

GET

/openapi/v1/image-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "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/image-to-3d/:id/stream

Eine Image-to-3D-Aufgabe streamen

Dieser endpoint streamt Echtzeit-Updates für eine Image-to-3D-Aufgabe mithilfe von Server-Sent Events (SSE).

Parameter

Name
id
Type
path
Description
Eindeutiger Bezeichner der zu streamenden Image-to-3D-Aufgabe.

Rückgabe

Gibt einen Stream von den Image-to-3D-Aufgabenobjekten als Server-Sent Events zurück.

Für Aufgaben mit PENDING oder IN_PROGRESS enthält der Antwort-Stream nur die notwendigen Felder progress und status.

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/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.
// 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": "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 Image to 3D Task Object

Das Image to 3D Task-Objekt ist eine Arbeitseinheit, die Meshy verfolgt, um aus einer Bild-Eingabe ein 3D-Modell zu generieren. Das Objekt hat die folgenden Eigenschaften:

Eigenschaften

Name
id
Type
string
Description
Eindeutige Kennung für die Aufgabe. Obwohl wir als Implementierungsdetail eine k-sortierbare UUID für Aufgaben-IDs verwenden, solltest du keine Annahmen über das Format der ID treffen.
Name
type
Type
string
Description
Typ der Bild-zu-3D-Aufgabe. Der Wert ist image-to-3d.
Name
model_urls
Type
object
Description
Herunterladbare URL zur von Meshy generierten texturierten 3D-Modelldatei. 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
  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 Textur-Maps 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 die Aufgabe sowohl mit should_remesh: true als auch mit save_pre_remeshed_model: true erstellt wurde.
Name
thumbnail_url
Type
string
Description
Herunterladbare URL zum Vorschaubild der Modelldatei. Entspricht thumbnail_urls.front, wenn 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 die Aufgabe mit alpha_thumbnail: true erstellt wurde und die transparente Vorschau erfolgreich gerendert wurde; andernfalls wird dieses Feld ausgelassen.
Name
thumbnail_urls
Type
object
Description
Herunterladbare URLs für vier Vorschaubilder des generierten 3D-Modells aus den Hauptrichtungen. 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 vorzuschauen, ohne die GLB herunterzuladen.
Nur vorhanden, wenn die Aufgabe mit multi_view_thumbnails: true erstellt wurde und SUCCEEDED erreicht hat. Ältere Aufgaben und Aufgaben, die ohne Opt-in erstellt wurden, enthalten dieses Feld nicht.
- Name
  front
  Type
  string
  Description
  Vorderansicht, 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_url
Type
string
Description
Herunterladbare URL zum Textur-Map-Bild, das zur Steuerung des Texturierungsprozesses verwendet wurde.
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 zu 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.
Ein Zeitstempel stellt die Anzahl der Millisekunden dar, die seit dem 1. Januar 1970 UTC vergangen sind, gemäß dem RFC 3339-Standard. 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 die Aufgabe erstellt wurde, in Millisekunden.
Name
expires_at
Type
timestamp
Description
Zeitstempel, wann das Aufgabenergebnis abläuft, in Millisekunden.
Name
finished_at
Type
timestamp
Description
Zeitstempel, wann die Aufgabe abgeschlossen wurde, in Millisekunden. Wenn die Aufgabe noch nicht abgeschlossen ist, ist diese Eigenschaft 0.
Name
status
Type
string
Description
Status der Aufgabe. Mögliche Werte sind einer von PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Ein Array von Textur-Map-URL-Objekten, die aus der Aufgabe generiert werden. Normalerweise enthält dies nur ein Textur-Map-URL-Objekt. Jede Textur-Map-URL hat die folgenden Eigenschaften:
- Name
  base_color
  Type
  string
  Description
  Herunterladbare URL zum Base-Color-Map-Bild.
- Name
  metallic
  Type
  string
  Description
  Herunterladbare URL zum Metallic-Map-Bild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wird, wird diese Eigenschaft ausgelassen.
- Name
  normal
  Type
  string
  Description
  Herunterladbare URL zum Normal-Map-Bild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wird, wird diese Eigenschaft ausgelassen.
- Name
  roughness
  Type
  string
  Description
  Herunterladbare URL zum Roughness-Map-Bild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wird, wird diese Eigenschaft ausgelassen.
- Name
  emission
  Type
  string
  Description
  Herunterladbare URL zum Emission-Map-Bild.
  Wenn die Aufgabe mit enable_pbr: false erstellt wird oder ai_model meshy-5 ist, wird diese Eigenschaft ausgelassen.
Name
preceding_tasks
Type
integer
Description
Die Anzahl der vorangehenden Aufgaben.
Der Wert dieses Feldes ist nur dann aussagekräftig, wenn der Aufgabenstatus PENDING ist.
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 0 für FAILED-Aufgaben zurück (Credits werden bei einem Fehler erstattet).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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": "",
  "texture_image_url": "",
  "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
}