Creative Lab Brick-Figure-API

Verwandeln Sie ein Foto in zwei Schritten in eine Sammelfigur im Ziegelstein-Stil als 3D-Minifigur. Eine Prototyp-Aufgabe erzeugt aus dem Foto ein Konzeptbild. Eine Build-Aufgabe verwandelt dieses Bild in ein texturiertes 3D-Modell und übernimmt die ID der Prototyp-Aufgabe als input_task_id.

POST /openapi/creative-lab/brick-figure/v1/prototype
POST /openapi/creative-lab/brick-figure/v1/build

POST/openapi/creative-lab/brick-figure/v1/prototype

Eine Brick Figure Prototyp-Aufgabe erstellen

Erzeugt ein Konzeptbild im Brick-Stil aus einem Foto. Um das 3D-Modell zu erstellen, übergeben Sie die ID dieser Aufgabe als input_task_id an den Build-Endpunkt. Die Felder der Aufgabe finden Sie unter Das Brick-Figure-Prototyp-Aufgabenobjekt.

Request

POST

/openapi/creative-lab/brick-figure/v1/prototype

# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \
  -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>"
  }'

Response

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

Parameter

Name
image_url
Type
string
Erforderlich
Description
Das Foto, das in eine Brick-Minifigur umgewandelt werden soll, als öffentliche URL oder Data URI (data:image/jpeg;base64,<Ihre base64-kodierten Bilddaten>).
Das Bild muss eine JPG-, JPEG-, PNG- oder WebP-Datei mit höchstens 20 MB sein.
Name
name
Type
string
Description
Ein Name für die Aufgabe, bis zu 100 Zeichen. Er wird im name-Feld der Aufgabe zurückgegeben. Ein längerer Name führt zu 400.
Name
remove_background
Type
boolean
Standard false
Description
Ob der Hintergrund aus dem Prototypbild entfernt werden soll. true liefert ein transparentes RGBA-PNG, sodass Sie das Motiv vor einem beliebigen Hintergrund platzieren können. Auch der Build startet dann von dem Bild ohne Hintergrund. Falls Meshy den Hintergrund nicht entfernen kann, wird das Bild mit Hintergrund zurückgegeben, und die Aufgabe gilt trotzdem als erfolgreich.

Rückgabewerte

Das Feld result enthält die ID der neuen Prototyp-Aufgabe. Rufen Sie die Aufgabe ab oder streamen Sie sie, bis status den Wert SUCCEEDED hat. Übergeben Sie die ID dann als input_task_id an den Build-Endpunkt.

Fehlerfälle

Name
400 - Bad Request
Description
Die Anfrage kann nicht ausgeführt werden. Zum Beispiel:
- image_url fehlt.
- Das Bild ist keine JPG-, JPEG-, PNG- oder WebP-Datei.
- Das Bild ist zu klein, größer als 20 MB oder überschreitet die maximale Pixelanzahl.
- Meshy kann das Bild nicht herunterladen, zum Beispiel weil die URL 404 zurückgibt oder ein Timeout auftritt.
- Die Data URI ist kein gültiges Base64.
- Das Bild wurde als NSFW markiert.
Die Fehlermeldung gibt an, welches Problem gefunden wurde. Beheben Sie die Anfrage und senden Sie sie erneut.
Name
401 - Unauthorized
Description
Der API-Schlüssel fehlt oder ist ungültig. Überprüfen Sie den Authorization-Header.
Name
402 - Payment Required
Description
Einer der folgenden Punkte trifft zu:
- Das Konto verfügt nicht über genügend Credits.
- Der API-Schlüssel, der Arbeitsbereich oder das Mitglied hat sein Credit-Limit erreicht.
- Das Konto nutzt den kostenlosen Plan.
Überprüfen Sie Ihre Credits und Ihren Plan, und versuchen Sie es dann erneut.
Name
403 - Forbidden
Description
Ihr Team hat IP Filtering aktiviert, und Meshy hat das Bild wegen geistigen Eigentums Dritter markiert. Senden Sie ein Bild, für das Sie die Nutzungsrechte besitzen.
Name
429 - Too Many Requests
Description
Eine der folgenden Grenzen wurde erreicht:
- Sie haben mehr Anfragen gesendet, als Ihre Ratenbegrenzung erlaubt. Warten Sie einige Sekunden und versuchen Sie es dann erneut. Siehe Ratenbegrenzungen.
- Zu viele Ihrer Aufgaben sind in der Warteschlange oder werden gerade ausgeführt. Warten Sie, bis einige abgeschlossen sind, und versuchen Sie es dann erneut.
- Bei einem unbegrenzten Plan ohne verbleibende Credits haben Sie die Anzahl der Aufgaben erreicht, die ohne Credits ausgeführt werden können. Warten Sie, bis eine Aufgabe abgeschlossen ist, oder fügen Sie Credits hinzu.
Name
500 - Internal Server Error
Description
Bei Meshy ist ein Serverfehler aufgetreten, zum Beispiel weil die Prüfung auf geistiges Eigentum für das Bild nicht ausgeführt werden konnte. Meshy erstellt die Aufgabe nicht und erstattet alle dafür berechneten Credits. Versuchen Sie die Anfrage erneut.

POST/openapi/creative-lab/brick-figure/v1/build

Erstellen einer Brick Figure Build-Aufgabe

Generiert die texturierte 3D-Minifigur aus einer erfolgreichen Prototyp-Aufgabe. Die zugehörigen Felder finden Sie unter Das Brick Figure Build-Aufgabenobjekt.

Request

POST

/openapi/creative-lab/brick-figure/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Parameter

Name
input_task_id
Type
string
Erforderlich
Description
Die ID der zu erstellenden Prototyp-Aufgabe. Sie muss eine Aufgabe sein, die Ihr Konto mit POST /openapi/creative-lab/brick-figure/v1/prototype erstellt hat, mit dem Status SUCCEEDED.
Eine ID, die nicht zu einer Ihrer Brick Figure Prototyp-Aufgaben aus der API gehört, gibt 404 zurück, einschließlich eines in der Web-App erstellten Prototyps.
Name
name
Type
string
Description
Ein Name für die Aufgabe, bis zu 100 Zeichen. Er wird im name-Feld der Aufgabe zurückgegeben. Ein längerer Name gibt 400 zurück.

Rückgabewerte

Das Feld result enthält die ID der neuen Build-Aufgabe. Rufen Sie die Aufgabe ab oder streamen Sie sie, bis status den Wert SUCCEEDED hat. Laden Sie dann das texturierte GLB aus model_urls.glb herunter. Für ein OBJ laden Sie stattdessen model_urls.obj zusammen mit der zugehörigen Materialdatei aus model_urls.mtl herunter.

Fehlermodi

Name
400 - Bad Request
Description
Die Anfrage kann nicht ausgeführt werden. Zum Beispiel:
- input_task_id fehlt oder ist keine gültige Aufgaben-ID.
- Der Status der Prototyp-Aufgabe ist nicht SUCCEEDED. Wenn sie noch läuft, warten Sie und versuchen Sie es erneut. Wenn sie fehlgeschlagen oder abgebrochen wurde, erstellen Sie eine neue Prototyp-Aufgabe.
- Die Prototyp-Aufgabe war erfolgreich, hat aber kein Bild. Erstellen Sie eine neue Prototyp-Aufgabe.
Die Fehlermeldung gibt an, welches Problem gefunden wurde.
Name
401 - Unauthorized
Description
Der API-Schlüssel fehlt oder ist ungültig. Überprüfen Sie den Authorization-Header.
Name
402 - Payment Required
Description
Einer der folgenden Punkte trifft zu:
- Das Konto verfügt nicht über genügend Credits.
- Der API-Schlüssel, der Arbeitsbereich oder das Mitglied hat sein Credit-Limit erreicht.
- Das Konto nutzt den kostenlosen Plan.
Überprüfen Sie Ihre Credits und Ihren Plan und versuchen Sie es dann erneut.
Name
404 - Not Found
Description
input_task_id entspricht keiner Brick Figure Prototyp-Aufgabe, die Ihr Konto mit der API erstellt hat. Ein in der Web-App erstellter Prototyp gibt ebenfalls 404 zurück. Senden Sie die result-ID aus einer Antwort auf das Erstellen eines Prototyps.
Name
429 - Too Many Requests
Description
Eines dieser Limits wurde erreicht:
- Sie haben mehr Anfragen gesendet, als Ihre Ratenbegrenzung erlaubt. Warten Sie einige Sekunden und versuchen Sie es erneut. Siehe Ratenbegrenzungen.
- Zu viele Ihrer Aufgaben sind in der Warteschlange oder laufen bereits. Warten Sie, bis einige abgeschlossen sind, und versuchen Sie es erneut.
- Bei einem unbegrenzten Plan ohne verbleibende Credits haben Sie die Anzahl der Aufgaben erreicht, die ohne Credits ausgeführt werden können. Warten Sie, bis eine Aufgabe abgeschlossen ist, oder fügen Sie Credits hinzu.

GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

Einen Brick-Figure-Task abrufen

Gibt einen Prototype- oder Build-Task zurück. Der Pfad muss zur Stage des Tasks passen. Ein Build-Task, der über /prototype/:id angefragt wird, liefert 404, und ebenso liefert ein Prototype-Task, der über /build/:id angefragt wird, 404.

Die Felder finden Sie unter Das Brick-Figure-Prototype-Task-Objekt und Das Brick-Figure-Build-Task-Objekt.

Request

GET

/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

Parameter

Name
id
Type
path
Description
Die Task-ID aus der Create-Antwort.

Rückgabewerte

Das Prototype-Task-Objekt oder das Build-Task-Objekt, passend zur Stage im Pfad.

Fehlerfälle

Name
400 - Bad Request
Description
id ist keine gültige Task-ID. Senden Sie die result-ID aus der Create-Antwort.
Name
403 - Forbidden
Description
Ihr Team hat IP Filtering aktiviert, und Meshy hat das Bild des Tasks wegen geistigen Eigentums eines Dritten markiert. Teams im Enterprise-Plan erhalten diesen Fehler nicht. Erstellen Sie einen Prototype-Task aus einem Bild, an dem Sie die Nutzungsrechte besitzen.
Name
404 - Not Found
Description
Es gehört kein Brick-Figure-Task mit dieser ID zu Ihrem Konto, oder die Stage des Tasks passt nicht zum Pfad. Überprüfen Sie die ID und verwenden Sie /prototype oder /build passend zum Task.
Name
500 - Internal Server Error
Description
Meshy konnte die Prüfung auf geistiges Eigentum nicht durchführen. Wiederholen Sie die Anfrage.

DELETE/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

Einen Brick-Figure-Task löschen

Bricht einen Brick-Figure-Task ab. Das Abbrechen eines PENDING-Tasks erstattet dessen Credits zurück. Ein IN_PROGRESS-Task wird ohne Rückerstattung abgebrochen, da bereits ein Worker mit der Bearbeitung begonnen hat. Ein Task mit einem endgültigen Status (SUCCEEDED, FAILED oder CANCELED) kann nicht abgebrochen werden.

Der Pfad muss zur Stufe des Tasks passen. Zum Beispiel gibt DELETE auf /prototype/:id mit der ID eines Build-Tasks 404 zurück.

Request

DELETE

/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

Pfadparameter

Name
id
Type
path
Description
Die ID des abzubrechenden Tasks.

Rückgabe

204 No Content mit leerem Body.

Fehlerfälle

Name
400 - Bad Request
Description
Einer der folgenden Fälle trifft zu:
- id ist keine gültige Task-ID. Senden Sie die result-ID aus der Erstellungsantwort.
- Der Task hat bereits einen endgültigen Status (SUCCEEDED, FAILED oder CANCELED) und kann daher nicht abgebrochen werden.
Name
404 - Not Found
Description
Es gehört kein Brick-Figure-Task mit dieser ID zu Ihrem Konto, oder die Stufe des Tasks stimmt nicht mit dem Pfad überein. Überprüfen Sie die ID und verwenden Sie /prototype oder /build, um den Task zuzuordnen.

GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id/stream

Einen Brick-Figure-Task streamen

Streamt die Updates eines Brick-Figure-Tasks als Server-Sent Events (SSE). Der Pfad muss zur Stufe des Tasks passen. Ist dies nicht der Fall, zum Beispiel die ID eines Build-Tasks unter /prototype/:id/stream, sendet der Stream ein einzelnes error-Event mit status_code: 404 und schließt sich.

Request

GET

/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

Parameter

Name
id
Type
path
Description
Die Task-ID aus der Erstellungsantwort.

Rückgabe

Ein Stream von Prototype- oder Build-Task-Objekten. Jedes Event enthält das vollständige Task-Objekt, so wie es Einen Brick-Figure-Task abrufen zurückgibt. Solange der Task PENDING oder IN_PROGRESS ist, sind seine Ausgabefelder noch leer (null, [] oder {}), und finished_at ist null.

Wenn IP Filtering das Ergebnis des Tasks blockiert, sendet der Stream an dessen Stelle ein einzelnes error-Event mit dem status_code, den eine Get-Anfrage zurückgeben würde.

GET/openapi/creative-lab/brick-figure/v1/(prototype|build)

Brick-Figur-Aufgaben auflisten

Gibt Ihre Brick-Figur-Aufgaben einer Stufe zurück, jeweils eine Seite auf einmal. Der Pfad bestimmt die Stufe. /prototype gibt nur Prototyp-Aufgaben zurück, und /build gibt nur Build-Aufgaben zurück.

Request

GET

/openapi/creative-lab/brick-figure/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-brick-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Pfadparameter

Name
stage
Type
path
Erforderlich
Description
Die aufzulistende Stufe, prototype oder build.

Abfrageparameter

Name
page_num
Type
integer
Standard 1
Description
Die zurückzugebende Seite, von 1 bis 255. 0 gibt die erste Seite zurück. Ein Wert außerhalb von 0 bis 255 gibt 400 zurück.
Name
page_size
Type
integer
Standard 10
Description
Anzahl der Aufgaben pro Seite, bis zu 100. Ein Wert von 101 bis 255 gibt 100 Aufgaben zurück, und 0 verwendet den Standardwert. Ein Wert außerhalb von 0 bis 255 gibt 400 zurück.
Name
sort_by
Type
string
Standard -created_at
Description
Die Sortierreihenfolge.
Verfügbare Werte:
- -created_at: neueste zuerst
- +created_at: älteste zuerst

Rückgabe

Ein Array aus Prototyp-Aufgabenobjekten oder Build-Aufgabenobjekten, entsprechend der im Pfad angegebenen Stufe.

Das Brick-Figure-Prototyp-Aufgabenobjekt

Eine Prototyp-Aufgabe erzeugt aus einem Foto ein Konzeptbild im Brick-Stil. Um das Bild in ein 3D-Modell umzuwandeln, übergeben Sie die ID der Aufgabe als input_task_id an den Build-Endpunkt.

Eigenschaften

Example Brick Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
Die Aufgaben-ID. Verlassen Sie sich nicht auf ihr Format.
Name
type
Type
string
Description
Der Aufgabentyp, immer creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Der name, den Sie beim Erstellen der Aufgabe gesendet haben, oder "", falls Sie keinen gesendet haben.
Name
status
Type
string
Description
Der Status der Aufgabe.
Verfügbare Werte:
- PENDING: wartet in der Warteschlange
- IN_PROGRESS: Ergebnis wird generiert
- SUCCEEDED: final, mit Ergebnis
- FAILED: final, mit dem Grund in task_error
- CANCELED: final, ohne Ergebnis
Name
progress
Type
integer
Description
Prozentsatz der erledigten Arbeit, von 0 bis 100. Er ist 0, bis die Aufgabe beginnt, und 100, wenn sie erfolgreich ist.
Name
created_at
Type
timestamp
Description
Zeitpunkt, zu dem die Aufgabe erstellt wurde, in Unix-Millisekunden.
Name
started_at
Type
timestamp
Description
Zeitpunkt, zu dem ein Worker die Aufgabe gestartet hat, in Unix-Millisekunden. Bis dahin null.
Name
finished_at
Type
timestamp
Description
Zeitpunkt, zu dem die Aufgabe einen endgültigen Status erreicht hat, in Unix-Millisekunden. Bis dahin null.
Name
expires_at
Type
timestamp
Description
Zeitpunkt, zu dem das Ergebnis der Aufgabe abläuft, in Unix-Millisekunden. Das ist 3 Tage nach finished_at, oder 3 Tage nach created_at, solange die Aufgabe noch nicht abgeschlossen ist. Bei Enterprise-Konten, die API-Ergebnisse unbegrenzt aufbewahren, liegt dieser Zeitpunkt etwa 100 Jahre später. Siehe Aufbewahrung von Assets.
Name
preceding_tasks
Type
integer
Description
Die Position der Aufgabe in der Warteschlange, solange sie PENDING ist. 1 bedeutet, dass sie als Nächstes startet. 0, nachdem die Aufgabe die Warteschlange verlassen hat, und bei Listenergebnissen immer 0.
Name
task_error
Type
object
Description
Warum die Aufgabe fehlgeschlagen ist. null, sofern status nicht FAILED ist. Siehe Fehler.
Name
consumed_credits
Type
integer
Description
Anzahl der für die Aufgabe berechneten Credits, nach einer eventuellen Rückerstattung. Eine Anfrage, die einen Fehler zurückgibt, wird nicht berechnet. Eine fehlgeschlagene Aufgabe ist 0, da Meshy sie erstattet. Das Abbrechen erstattet eine Aufgabe nur, solange sie PENDING ist. Wenn Meshy die Belastung nicht lesen kann, lässt eine Get- oder Stream-Antwort das Feld weg, und eine Listenanfrage gibt 500 zurück. Wiederholen Sie in diesem Fall die Anfrage.
Name
image_urls
Type
array of strings
Description
Download-URLs für das Konzeptbild. Das Array enthält eine URL, nachdem die Aufgabe erfolgreich war, und ist bis dahin leer.

Das Brick-Figure-Build-Task-Objekt

Ein Build-Task erzeugt eine texturierte 3D-Minifigur aus einem erfolgreich abgeschlossenen Prototype-Task. Die Felder model_urls, thumbnail_url und texture_urls haben dasselbe Format wie im Bild-zu-3D-Task-Objekt.

Eigenschaften

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

Name
id
Type
string
Description
Die Task-ID. Verlassen Sie sich nicht auf deren Format.
Name
type
Type
string
Description
Der Task-Typ, immer creative-lab-brick-figure-build.
Name
name
Type
string
Description
Der name, den Sie beim Erstellen des Tasks gesendet haben, oder "", wenn Sie keinen gesendet haben.
Name
status
Type
string
Description
Der Status des Tasks.
Verfügbare Werte:
- PENDING: wartet in der Warteschlange
- IN_PROGRESS: generiert das Ergebnis
- SUCCEEDED: final, mit dem Ergebnis
- FAILED: final, mit dem Grund in task_error
- CANCELED: final, ohne Ergebnis
Name
progress
Type
integer
Description
Prozentsatz der erledigten Arbeit, von 0 bis 100. Der Wert ist 0, bis der Task startet, und 100, wenn er erfolgreich ist.
Name
created_at
Type
timestamp
Description
Zeitpunkt, zu dem der Task erstellt wurde, in Unix-Millisekunden.
Name
started_at
Type
timestamp
Description
Zeitpunkt, zu dem ein Worker den Task gestartet hat, in Unix-Millisekunden. Bis dahin null.
Name
finished_at
Type
timestamp
Description
Zeitpunkt, zu dem der Task einen finalen Status erreicht hat, in Unix-Millisekunden. Bis dahin null.
Name
expires_at
Type
timestamp
Description
Zeitpunkt, zu dem das Ergebnis des Tasks abläuft, in Unix-Millisekunden. Das sind 3 Tage nach finished_at, oder bis der Task abgeschlossen ist, 3 Tage nach created_at. Bei Enterprise-Konten, die API-Ergebnisse unbegrenzt aufbewahren, liegt dieser Zeitpunkt etwa 100 Jahre später. Siehe Aufbewahrung von Assets.
Name
preceding_tasks
Type
integer
Description
Die Position des Tasks in der Warteschlange, solange er PENDING ist. 1 bedeutet, dass er als Nächstes startet. 0, nachdem der Task die Warteschlange verlassen hat, und in Listenergebnissen immer 0.
Name
task_error
Type
object
Description
Warum der Task fehlgeschlagen ist. null, sofern status nicht FAILED ist. Siehe Fehler.
Name
consumed_credits
Type
integer
Description
Anzahl der für den Task berechneten Credits, nach einer eventuellen Rückerstattung. Eine Anfrage, die einen Fehler zurückgibt, wird nicht berechnet. Ein fehlgeschlagener Task hat den Wert 0, da Meshy ihn erstattet. Das Abbrechen erstattet einen Task nur, solange er PENDING ist. Wenn Meshy die Belastung nicht auslesen kann, lässt eine Get- oder Stream-Antwort das Feld weg, und eine List-Anfrage gibt 500 zurück. Wiederholen Sie in diesem Fall die Anfrage.
Name
prompt
Type
string
Description
Für einen Brick-Figure-Build-Task immer "".
Name
negative_prompt
Type
string
Description
Für einen Brick-Figure-Build-Task immer "", wie prompt.
Name
texture_prompt
Type
string
Description
Für einen Brick-Figure-Build-Task immer "", wie prompt.
Name
texture_image_url
Type
string
Description
Für einen Brick-Figure-Build-Task immer "", wie prompt.
Name
model_urls
Type
object
Description
Download-URLs für das 3D-Modell, als texturierte GLB-Datei und als OBJ-Datei mit zugehöriger MTL-Datei.
- Name
  glb
  Type
  string
  Description
  Download-URL für die texturierte GLB-Datei.
- Name
  obj
  Type
  string
  Description
  Download-URL für die OBJ-Datei, mit Geometrie und UVs.
- Name
  mtl
  Type
  string
  Description
  Download-URL für die MTL-Materialdatei, die zu obj gehört. Verwenden Sie sie zusammen mit obj und der Textur in texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Download-URL für ein Vorschaubild des Modells.
Name
texture_urls
Type
array
Description
Die Texturen, als Array mit einem Objekt, das die Basisfarbkarte enthält.
- Name
  base_color
  Type
  string
  Description
  Download-URL für die Basisfarbkarte.