Creative Lab Figure API

Verwandeln Sie ein Foto in zwei Schritten in eine sammelbare 3D-Figur im Chibi-Stil. Ein Prototyp-Task erzeugt aus dem Foto ein Konzeptbild. Ein Build-Task verwandelt dieses Bild in ein texturiertes 3D-Modell und übernimmt die ID des Prototyp-Tasks als input_task_id.

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

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

Erstelle eine Figure-Prototyp-Aufgabe

Generiert ein Konzeptbild im Chibi-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 Figure-Prototyp-Aufgabenobjekt.

Request

POST

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

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

Prototyp-Beispiel

Beginnen Sie mit einem Quellporträt und generieren Sie dann das Prototyp-Bild, das für die Build-Stufe verwendet wird.

Quellporträt, das als Eingabe für Creative Lab Figure verwendet wird — Prototyp-Eingabe

Aus dem Quellfoto generiertes Prototyp-Bild einer Chibi-Figur — Prototyp-Ausgabe

Parameter

Name
image_url
Type
string
Erforderlich
Description
Das Foto, das in eine Chibi-Figur umgewandelt werden soll, als öffentliche URL oder als Data URI (data:image/jpeg;base64,<Ihre base64-codierten Bilddaten>).
Das Bild muss eine JPG-, JPEG-, PNG- oder WebP-Datei mit maximal 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 gibt 400 zurück.
Name
remove_background
Type
boolean
Standard false
Description
Ob der Hintergrund aus dem Prototyp-Bild entfernt werden soll. true gibt ein transparentes RGBA-PNG zurück, sodass Sie das Motiv auf beliebigem 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 auf SUCCEEDED steht. Übergeben Sie dann die ID 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, über 20 MB groß oder überschreitet die maximale Pixelanzahl.
- Meshy kann das Bild nicht herunterladen, zum Beispiel weil die URL 404 zurückgibt oder eine Zeitüberschreitung auftritt.
- Der Data URI ist kein gültiges base64.
- Das Bild wurde als NSFW markiert.
Die Fehlermeldung gibt an, welches Problem gefunden wurde. Korrigieren 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 befindet sich im kostenlosen Plan.
Überprüfen Sie Ihre Credits und Ihren Plan, und versuchen Sie es erneut.
Name
403 - Forbidden
Description
Ihr Team hat IP Filtering aktiviert, und Meshy hat das Bild wegen Rechten Dritter an geistigem Eigentum markiert. Senden Sie ein Bild, das Sie verwenden dürfen.
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 Rate limits.
- Zu viele Ihrer Aufgaben sind in der Warteschlange oder werden gerade ausgeführt. Warten Sie, bis einige abgeschlossen sind, und versuchen Sie es erneut.
- Bei einem unbegrenzten Plan ohne verbleibende Credits haben Sie die Anzahl der ohne Credits ausführbaren Aufgaben erreicht. 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 berechneten Credits zurück. Versuchen Sie die Anfrage erneut.

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

Erstellen einer Figure-Build-Aufgabe

Erzeugt die texturierte 3D-Figur aus einer erfolgreich abgeschlossenen Prototyp-Aufgabe. Die Felder dazu finden Sie unter Das Figure-Build-Task-Objekt.

Request

POST

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

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/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"
}

Build-Beispiel

Die Build-Aufgabe verwandelt das ausgewählte Prototyp-Bild in ein herunterladbares, texturiertes 3D-Modell.

Vorschau des Creative Lab Figure-Build-Modells — Vorschau des Build-Modells

Parameter

Name
input_task_id
Type
string
Erforderlich
Description
Die ID der zu erstellenden Prototyp-Aufgabe. Sie muss zu einer Aufgabe gehören, die Ihr Konto mit POST /openapi/creative-lab/figure/v1/prototype erstellt hat und den Status SUCCEEDED aufweist.
Eine ID, die keiner Ihrer Figure-Prototyp-Aufgaben aus der API entspricht, liefert 404, auch wenn der Prototyp in der Web-App erstellt wurde.
Name
name
Type
string
Description
Ein Name für die Aufgabe mit bis zu 100 Zeichen. Er wird im Feld name der Aufgabe zurückgegeben. Ein längerer Name liefert 400.

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 die texturierte GLB-Datei über model_urls.glb herunter. Für ein OBJ laden Sie stattdessen model_urls.obj zusammen mit der zugehörigen Materialdatei über 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 Task-ID.
- Der Status der Prototyp-Aufgabe ist nicht SUCCEEDED. Falls sie noch läuft, warten Sie und versuchen Sie es erneut. Falls 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 Header Authorization.
Name
402 - Payment Required
Description
Einer der folgenden Fälle trifft zu:
- Das Konto verfügt nicht über genügend Credits.
- Der API-Schlüssel, der Arbeitsbereich oder das Mitglied hat das Credit-Limit erreicht.
- Das Konto nutzt den kostenlosen Plan.
Überprüfen Sie Ihre Credits und Ihren Plan, und versuchen Sie es erneut.
Name
404 - Not Found
Description
input_task_id stimmt mit keiner Figure-Prototyp-Aufgabe überein, die Ihr Konto über die API erstellt hat. Auch ein in der Web-App erstellter Prototyp liefert 404. Senden Sie die result-ID aus einer Antwort auf die Erstellung 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 befinden sich in der Warteschlange oder laufen gerade. Warten Sie, bis einige abgeschlossen sind, und versuchen Sie es erneut.
- Bei einem unlimitierten 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/figure/v1/(prototype|build)/:id

Einen Figure-Task abrufen

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

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

Request

GET

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

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

# Build
curl https://api.meshy.ai/openapi/creative-lab/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-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-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 Erstellungsantwort.

Rückgabewerte

Das Prototyp-Task-Objekt oder das Build-Task-Objekt, passend zur Stufe im Pfad.

Fehlerfälle

Name
400 - Bad Request
Description
id ist keine gültige Task-ID. Senden Sie die result-ID aus der Erstellungsantwort.
Name
403 - Forbidden
Description
Bei Ihrem Team ist die IP-Filterung aktiviert, und Meshy hat das Bild des Tasks wegen geistigen Eigentums Dritter markiert. Teams im Enterprise-Plan erhalten diesen Fehler nicht. Erstellen Sie einen Prototyp-Task aus einem Bild, an dem Sie die Nutzungsrechte besitzen.
Name
404 - Not Found
Description
Es gehört kein 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 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/figure/v1/(prototype|build)/:id

Einen Figur-Task löschen

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

Der Pfad muss der Stufe des Tasks entsprechen. Zum Beispiel liefert DELETE auf /prototype/:id mit der ID eines Build-Tasks 404.

Request

DELETE

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

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/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ückgabewerte

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 Antwort der Erstellung.
- Der Task hat bereits einen finalen Status (SUCCEEDED, FAILED oder CANCELED) und kann daher nicht abgebrochen werden.
Name
404 - Not Found
Description
Es gehört kein Figur-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 sie dem Task zuzuordnen.

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

Einen Figure-Task streamen

Streamt die Updates eines Figure-Tasks als Server-Sent Events (SSE). Der Pfad muss zur Stufe des Tasks passen. Andernfalls, zum Beispiel wenn die ID eines Build-Tasks an /prototype/:id/stream gesendet wird, sendet der Stream ein error-Event mit status_code: 404 und wird geschlossen.

Request

GET

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

curl -N https://api.meshy.ai/openapi/creative-lab/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-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 Prototyp- oder Build-Task-Objekten. Jedes Event enthält das vollständige Task-Objekt, so wie es Einen 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 das IP-Filtering das Ergebnis des Tasks blockiert, sendet der Stream stattdessen ein error-Event mit dem status_code, den eine Get-Anfrage zurückgeben würde.

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

Figur-Tasks auflisten

Gibt Ihre Figur-Tasks einer Stage zurück, jeweils eine Seite auf einmal. Der Pfad legt die Stage fest. /prototype gibt nur Prototype-Tasks zurück, und /build gibt nur Build-Tasks zurück.

Request

GET

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

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

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/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-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 Stage, 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 Tasks pro Seite, bis zu 100. Ein Wert von 101 bis 255 gibt 100 Tasks 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 von Prototype-Task-Objekten oder Build-Task-Objekten, passend zur Stage im Pfad.

Das Figur-Prototyp-Task-Objekt

Ein Prototyp-Task erzeugt aus einem Foto ein Konzeptbild im Chibi-Stil. Um das Bild in ein 3D-Modell umzuwandeln, übergeben Sie die ID des Tasks als input_task_id an den Build-Endpunkt.

Properties

Example Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-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 Task-ID. Verlassen Sie sich nicht auf ihr Format.
Name
type
Type
string
Description
Der Task-Typ, immer creative-lab-figure-prototype.
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: das Ergebnis wird generiert
- 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. Er ist 0, bis der Task beginnt, 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 ist 3 Tage nach finished_at, oder 3 Tage nach created_at, solange der Task noch nicht abgeschlossen ist. Bei Enterprise-Konten, die API-Ergebnisse unbegrenzt aufbewahren, liegt er 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 beginnt. 0, nachdem der Task die Warteschlange verlassen hat, und bei Listenergebnissen immer 0.
Name
task_error
Type
object
Description
Warum der Task fehlgeschlagen ist. null, außer wenn status gleich 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. Ein Abbruch erstattet einen Task nur, solange er PENDING ist. Wenn Meshy die Belastung nicht auslesen kann, lässt eine Get- oder Stream-Antwort dieses Feld weg, und eine List-Anfrage gibt 500 zurück. Wiederholen Sie die Anfrage in diesem Fall.
Name
image_urls
Type
array of strings
Description
Download-URLs für das Konzeptbild. Das Array enthält eine URL, nachdem der Task erfolgreich war, und ist bis dahin leer.

Das Figure-Build-Task-Objekt

Ein Build-Task erzeugt eine texturierte 3D-Figur 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 Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-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-figure-build.
Name
name
Type
string
Description
Der name, den Sie beim Erstellen des Tasks gesendet haben, oder "", falls Sie keinen gesendet haben.
Name
status
Type
string
Description
Der Status des Tasks.
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 der Task beginnt, und 100, wenn er erfolgreich ist.
Name
created_at
Type
timestamp
Description
Zeitpunkt der Erstellung des Tasks, 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 ist 3 Tage nach finished_at, oder 3 Tage nach created_at, solange der Task noch nicht abgeschlossen ist. Für 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 immer 0 in Listenergebnissen.
Name
task_error
Type
object
Description
Warum der Task fehlgeschlagen ist. null, außer wenn status gleich FAILED ist. Siehe Fehler.
Name
consumed_credits
Type
integer
Description
Anzahl der für den Task berechneten Credits, nach etwaiger Rückerstattung. Eine Anfrage, die einen Fehler zurückgibt, wird nicht berechnet. Ein fehlgeschlagener Task hat den Wert 0, da Meshy ihn erstattet. Ein Abbruch erstattet einen Task nur, solange er PENDING ist. Falls Meshy die Belastung nicht auslesen kann, lässt eine get- oder stream-Antwort das Feld weg, und eine Listenanfrage gibt 500 zurück. In diesem Fall wiederholen Sie die Anfrage.
Name
prompt
Type
string
Description
Bei einem Figure-Build-Task immer "".
Name
negative_prompt
Type
string
Description
Bei einem Figure-Build-Task immer "", wie prompt.
Name
texture_prompt
Type
string
Description
Bei einem Figure-Build-Task immer "", wie prompt.
Name
texture_image_url
Type
string
Description
Bei einem Figure-Build-Task immer "", wie prompt.
Name
model_urls
Type
object
Description
Download-URLs für das 3D-Modell, als texturierte GLB-Datei sowie 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 Texturmaps, als Array mit einem Objekt, das die Basisfarb-Map enthält.
- Name
  base_color
  Type
  string
  Description
  Download-URL für die Basisfarb-Map.