Creative Lab — Vinyl Figure API

Verwandeln Sie ein Ausgangsfoto in zwei Schritten in eine Vinyl-Sammelfigur mit großem Kopf als 3D-Figur: Im Schritt prototype wird aus Ihrem Eingabefoto ein stilisiertes Konzeptbild erzeugt, anschließend wandelt build dieses Konzeptbild in ein texturiertes 3D-Modell um. Die beiden Schritte sind über input_task_id miteinander verknüpft.

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

Erstellen einer Vinyl Figure Prototype Task

Erzeugt aus dem Ausgangsfoto ein einzelnes Konzeptbild im Vinyl-Figur-Stil. Die zurückgegebene Task-ID wird als input_task_id an den Build-Endpunkt übergeben. Die Form der Antwort ist unter The Vinyl Figure Prototype Task Object beschrieben.

Parameter

  • Name
    image_url
    Type
    string
    Erforderlich
    Description

    Ausgangsfoto, das Meshy im Stil einer Vinyl-Figur mit großem Kopf gestalten soll. Derzeit werden die Formate .jpg, .jpeg, .png und .webp unterstützt.

    Es gibt zwei Möglichkeiten, das Bild bereitzustellen:

    • Öffentlich zugängliche URL: Eine URL, die aus dem öffentlichen Internet erreichbar ist.
    • Data URI: Ein base64-kodierter Data URI des Bildes. Beispiel für einen Data URI: data:image/jpeg;base64,<Ihre base64-kodierten Bilddaten>.
  • Name
    name
    Type
    string
    Description

    Optionaler Task-Name für Anzeigezwecke. Maximal 100 Zeichen.

  • Name
    remove_background
    Type
    boolean
    Standard false
    Description

    Wenn dieser Wert auf true gesetzt ist, wird das Prototypbild als transparentes RGBA-PNG mit entferntem Hintergrund zurückgegeben, sodass Sie das Motiv mit jedem beliebigen Hintergrund kombinieren können.

Rückgabewerte

Die Eigenschaft result der Antwort enthält die Task-id der neu erstellten Vinyl-Figure-Prototype-Task. Fragen Sie den Endpunkt Get a Task ab oder abonnieren Sie den Stream, bis die Task den Status SUCCEEDED erreicht, und übergeben Sie diese ID anschließend als input_task_id an den Build-Endpunkt.

Fehlermodi

  • Name
    400 - Bad Request
    Description

    Die Anfrage war ungültig. Häufige Ursachen:

    • Fehlender Parameter: image_url ist erforderlich.
    • Ungültiges Bildformat: Die angegebene image_url hat kein unterstütztes Format (.jpg, .jpeg, .png, .webp).
    • Bildabmessungen außerhalb des zulässigen Bereichs: Das Bild ist zu klein, überschreitet die maximale Dateigröße oder überschreitet die maximale Pixelanzahl.
    • Nicht erreichbare URL: Die image_url konnte nicht heruntergeladen werden (404 oder timeout).
    • Ungültiger Data URI: Der base64-String ist fehlerhaft.
    • Inhalt gekennzeichnet: Das Eingabebild wurde durch die NSFW- oder Urheberrechts-moderation gekennzeichnet.
  • Name
    401 - Unauthorized
    Description

    Die Authentifizierung ist fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.

  • Name
    402 - Payment Required
    Description

    Nicht genügend Credits, um diese Task auszuführen.

  • Name
    429 - Too Many Requests
    Description

    Sie haben Ihre Ratenbegrenzung überschritten.

Request

POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept image
curl https://api.meshy.ai/openapi/creative-lab/vinyl-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": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"
}
Prototype example
Start with a source photo, then generate the prototype image used by the build stage.
Source photo used as the Creative Lab Vinyl Figure input
Prototype input
Big-head vinyl figure prototype image generated from the source photo
Prototype output
POST/openapi/creative-lab/vinyl-figure/v1/build

Erstellen einer Vinyl-Figur-Build-Aufgabe

Generiert die finale texturierte 3D-Vinyl-Figur aus einer erfolgreich abgeschlossenen Prototyp-Aufgabe. Der Build läuft über dieselbe Bild-zu-3D-Pipeline wie Bild zu 3D, sodass das Format des Antwortobjekts und die Liste der Ausgabe-URLs exakt übereinstimmen. Informationen zur Struktur der Antwort finden Sie unter Das Vinyl-Figur-Build-Aufgabenobjekt.

Parameter

  • Name
    input_task_id
    Type
    string
    Erforderlich
    Description

    Die Aufgaben-ID einer Prototyp-Aufgabe, die über denselben OpenAPI-Endpunkt erstellt wurde. Der Prototyp muss mit demselben API-Schlüssel erstellt worden sein, muss den Status SUCCEEDED erreicht haben und darf genau ein Kandidatenbild erzeugt haben.

    Prototyp-Aufgaben, die über die Webapp erstellt wurden, werden nicht akzeptiert — der Build-Endpunkt akzeptiert ausschließlich Prototyp-Aufgaben, die über POST /openapi/creative-lab/vinyl-figure/v1/prototype erzeugt wurden, und weist jede andere Quelle mit 404 zurück.

  • Name
    name
    Type
    string
    Description

    Optionaler Aufgabenname für Anzeigezwecke. Maximal 100 Zeichen.

Rückgabewerte

Die Eigenschaft result der Antwort enthält die id der neu erstellten Vinyl-Figur-Build-Aufgabe. Fragen Sie den Endpunkt Eine Aufgabe abrufen ab oder abonnieren Sie den Stream, bis die Aufgabe den Status SUCCEEDED erreicht, und laden Sie dann das texturierte GLB über model_urls.glb herunter (oder das OBJ- + MTL-Paar über model_urls.obj und model_urls.mtl, falls Ihre nachgeschaltete Pipeline OBJ bevorzugt).

Fehlermodi

  • Name
    400 - Bad Request
    Description

    Die Anfrage war nicht akzeptabel. Häufige Ursachen:

    • Fehlender Parameter: input_task_id ist erforderlich.
    • Ungültige UUID: Die input_task_id ist keine gültige UUID.
    • Übergeordnete Aufgabe nicht erfolgreich abgeschlossen: Die referenzierte Prototyp-Aufgabe hat den Status SUCCEEDED noch nicht erreicht.
    • Kein Kandidat: Die Prototyp-Aufgabe war erfolgreich, hat aber kein Kandidatenbild erzeugt.
  • Name
    401 - Unauthorized
    Description

    Die Authentifizierung ist fehlgeschlagen. Bitte überprüfen Sie Ihren API-Schlüssel.

  • Name
    402 - Payment Required
    Description

    Nicht genügend Credits, um diese Aufgabe auszuführen.

  • Name
    404 - Not Found
    Description

    Die referenzierte Prototyp-Aufgabe existiert nicht, gehört einem anderen Benutzer oder wurde über die Webapp erstellt (nur Prototyp-Aufgaben im API-mode können in einen Build übergehen).

  • Name
    429 - Too Many Requests
    Description

    Sie haben Ihre Ratenbegrenzung überschritten.

Request

POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"
  }'

Response

{
  "result": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef"
}
GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id

Eine Vinylfigur-Aufgabe abrufen

Ruft eine Prototyp- oder Build-Aufgabe anhand einer gültigen Aufgaben-id ab. Der URL-Pfad muss zur Stufe der Aufgabe passen — eine Build-Aufgabe, die über /prototype/:id abgerufen wird, liefert 404, und umgekehrt ebenso.

Weitere Informationen zu den Antwortformaten finden Sie unter Das Vinylfigur-Prototyp-Aufgabenobjekt und Das Vinylfigur-Build-Aufgabenobjekt.

Parameter

  • Name
    id
    Type
    path
    Description

    Eindeutige Kennung der abzurufenden Vinylfigur-Aufgabe.

Rückgabewerte

Die Antwort enthält das Vinylfigur-Aufgabenobjekt. Die Form hängt davon ab, welche Stufe angefordert wurde.

Request

GET
/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "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/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}
DELETE/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id

Eine Vinyl-Figur-Aufgabe löschen

Bricht eine Vinyl-Figur-Aufgabe ab. Befindet sich die Aufgabe noch im Status PENDING, werden die bei der Erstellung verbrauchten Credits zurückerstattet. Aufgaben, die sich bereits IN_PROGRESS befinden, werden ohne Rückerstattung abgebrochen (der Worker verbraucht möglicherweise bereits Ressourcen). Aufgaben, die bereits einen Endzustand erreicht haben (SUCCEEDED, FAILED, CANCELED), können nicht abgebrochen werden.

Der URL-Pfad muss mit der Phase der Aufgabe übereinstimmen — ein DELETE auf /prototype/:buildId liefert 404 zurück.

Pfadparameter

  • Name
    id
    Type
    path
    Description

    Eindeutige Kennung der abzubrechenden Vinyl-Figur-Aufgabe.

Rückgabewerte

Gibt bei Erfolg 204 No Content mit leerem Body zurück.

Fehlerfälle

  • Name
    400 - Bad Request
    Description

    Die Aufgabe befindet sich bereits in einem Endzustand und kann nicht abgebrochen werden.

  • Name
    404 - Not Found
    Description

    Die Aufgabe existiert nicht, gehört einem anderen Benutzer, oder ihre Phase stimmt nicht mit dem URL-Pfad überein.

Request

DELETE
/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).
GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id/stream

Streamen einer Vinyl-Figur-Aufgabe

Streamt Echtzeit-Updates für eine Vinyl-Figur-Aufgabe über Server-Sent Events (SSE). Der URL-Pfad muss der Stufe der Aufgabe entsprechen — wird ein Stream unter /prototype/:buildId/stream geöffnet, wird ein einzelner event: error-Payload mit status_code: 404 ausgegeben und der Stream geschlossen.

Parameter

  • Name
    id
    Type
    path
    Description

    Eindeutige Kennung der zu streamenden Vinyl-Figur-Aufgabe.

Rückgabewerte

Gibt einen Stream von Vinyl Figure Prototype- oder Vinyl Figure Build-Aufgabenobjekten als Server-Sent Events zurück. Jeder Frame enthält das vollständige Aufgabenobjekt für die jeweilige Stufe — dieselbe Form, die der Get-Endpunkt zurückgibt — daher sind, solange die Aufgabe PENDING oder IN_PROGRESS ist, die Ausgabefelder einfach noch nicht befüllt (null, [] oder {}), und finished_at ist null.

Request

GET
/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/stream
curl -N https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/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 PENDING frame below is abbreviated to the fields that change.
event: message
data: {
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}
GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)

List Vinyl Figure Tasks

Ruft eine paginierte Liste Ihrer Vinyl-Figur-Aufgaben für eine einzelne Stufe ab. Der URL-Pfad wählt die Stufe aus — /prototype liefert Prototyp-Aufgaben zurück; /build liefert Build-Aufgaben zurück. Aufgaben der jeweils anderen Stufe sind in keiner der beiden Antworten enthalten.

Pfadparameter

  • Name
    stage
    Type
    path
    Erforderlich
    Description

    Entweder prototype oder build. Die Sammlung liefert nur Aufgaben zurück, deren Stufe mit der URL übereinstimmt — das Abrufen von /prototype liefert niemals Build-Aufgaben zurück und umgekehrt.

Abfrageparameter

  • Name
    page_num
    Type
    integer
    Standard 1
    Description

    Seitenzahl für die Paginierung.

  • Name
    page_size
    Type
    integer
    Standard 10
    Description

    Begrenzung der Seitengröße. Maximal erlaubt sind 100 Elemente.

  • Name
    sort_by
    Type
    string
    Standard -created_at
    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ückgabewerte

Gibt eine paginierte Liste des jeweiligen Aufgabenobjekts der Stufe zurück — entweder das Vinyl-Figur-Prototyp-Aufgabenobjekt beim Auflisten von /prototype oder das Vinyl-Figur-Build-Aufgabenobjekt beim Auflisten von /build.

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
    "type": "creative-lab-vinyl-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1752969600000,
    "started_at": 1752969604000,
    "finished_at": 1752969630000,
    "expires_at": 1753228830000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Das Vinyl Figure Prototype Task Objekt

Das Vinyl Figure Prototype Task Objekt ist eine Arbeitseinheit, die Meshy verfolgt, um aus einem Ausgangsfoto ein Konzeptbild im Vinyl-Figur-Stil zu erzeugen. Die Ausgabe dieser Stufe wird über input_task_id mit der Build-Stufe verkettet.

Eigenschaften

  • Name
    id
    Type
    string
    Description

    Eindeutiger Bezeichner für den Task. Auch wenn wir als Implementierungsdetail eine k-sortierbare UUID für Task-IDs verwenden, solltest du keine Annahmen über das Format der ID treffen.

  • Name
    type
    Type
    string
    Description

    Typ des Tasks. Der Wert ist creative-lab-vinyl-figure-prototype.

  • Name
    name
    Type
    string
    Description

    Der Task-Name, der bei der Erstellung des Tasks angegeben wurde. Leerer String, wenn kein Name angegeben wurde.

  • Name
    status
    Type
    string
    Description

    Status des Tasks. Mögliche Werte sind einer von PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • 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 sie 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Zeitstempel, wann der Task erstellt wurde, in Millisekunden.

    Ein Zeitstempel repräsentiert die Anzahl der Millisekunden, die seit dem 1. Januar 1970 UTC vergangen sind, gemäß dem Standard RFC 3339. Zum Beispiel wird Freitag, 1. September 2023, 12:00:00 Uhr GMT als 1693569600000 dargestellt. Dies gilt für alle Zeitstempel in der Meshy API.

  • 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.

  • Name
    finished_at
    Type
    timestamp
    Description

    Zeitstempel, wann der Task beendet wurde, in Millisekunden. Wenn der Task noch nicht beendet wurde, ist diese Eigenschaft 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Zeitstempel, wann das Ergebnis des Tasks abläuft, in Millisekunden.

  • 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).

  • Name
    image_urls
    Type
    array of strings
    Description

    Herunterladbare URLs für die von diesem Prototype-Task generierten Konzeptbild-Kandidaten. Derzeit gibt die API immer genau einen Kandidaten zurück; das Feld ist ein Array, damit zukünftige Überarbeitungen mehrere Kandidaten liefern können, ohne eine Breaking Change zu verursachen.

Example Vinyl Figure Prototype Task Object

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Das Vinyl Figure Build Task-Objekt

Das Vinyl Figure Build Task-Objekt ist eine Arbeitseinheit, die Meshy nachverfolgt, um eine texturierte 3D-Vinylfigur aus einem erfolgreichen Prototyp-Task zu generieren. Es nutzt dieselbe Bild-zu-3D-Pipeline wie Bild zu 3D, sodass die Ausgabefelder dem Task-Objekt dieses Endpunkts entsprechen.

Eigenschaften

  • Name
    id
    Type
    string
    Description

    Eindeutige Kennung für den Task.

  • Name
    type
    Type
    string
    Description

    Typ des Tasks. Der Wert ist creative-lab-vinyl-figure-build.

  • Name
    name
    Type
    string
    Description

    Der Task-Name, der bei der Erstellung des Tasks angegeben wurde. Leerer String, wenn kein Name angegeben wurde.

  • Name
    status
    Type
    string
    Description

    Status des Tasks. Mögliche Werte sind PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Fortschritt des Tasks. Wenn der Task noch nicht gestartet wurde, ist dieser Wert 0. Sobald der Task erfolgreich war, wird er 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Zeitstempel, wann der Task erstellt wurde, in Millisekunden.

  • Name
    started_at
    Type
    timestamp
    Description

    Zeitstempel, wann der Task gestartet wurde, in Millisekunden.

  • Name
    finished_at
    Type
    timestamp
    Description

    Zeitstempel, wann der Task beendet wurde, in Millisekunden.

  • Name
    expires_at
    Type
    timestamp
    Description

    Zeitstempel, wann das Ergebnis des Tasks abläuft, in Millisekunden.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Die Anzahl der vorausgehenden Tasks. Nur relevant, wenn der 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. Gibt 0 für FAILED-Tasks zurück (Credits werden bei einem Fehlschlag zurückerstattet).

  • Name
    prompt
    Type
    string
    Description

    Für den Vinyl Figure Build immer leer. Vorhanden für die Endpunkt-übergreifende Kompatibilität mit der gemeinsamen V2ImageTo3DTaskResponse-Struktur, die von Bild zu 3D verwendet wird.

  • Name
    negative_prompt
    Type
    string
    Description

    Für den Vinyl Figure Build immer leer. Vorhanden für die Endpunkt-übergreifende Kompatibilität.

  • Name
    texture_prompt
    Type
    string
    Description

    Für den Vinyl Figure Build immer leer. Vorhanden für die Endpunkt-übergreifende Kompatibilität.

  • Name
    texture_image_url
    Type
    string
    Description

    Für den Vinyl Figure Build immer leer. Vorhanden für die Endpunkt-übergreifende Kompatibilität.

  • Name
    model_urls
    Type
    object
    Description

    Downloadbare URLs für das generierte 3D-Modell. Der Vinyl Figure Build liefert eine texturierte GLB-Datei sowie das OBJ + MTL-Paar für Pipelines, die Wavefront OBJ bevorzugen. Die Feldstruktur entspricht dem model_urls-Objekt von Bild zu 3D, sodass zukünftige Formatergänzungen ohne Breaking Change eingefügt werden können.

    • Name
      glb
      Type
      string
      Description

      Downloadbare URL zur texturierten GLB-Datei.

    • Name
      obj
      Type
      string
      Description

      Downloadbare URL zur Wavefront OBJ-Datei (Geometrie + UV).

    • Name
      mtl
      Type
      string
      Description

      Downloadbare URL zur begleitenden OBJ-MTL-Materialdatei. In Kombination mit obj und dem Eintrag aus texture_urls[0].base_color verwenden.

  • Name
    thumbnail_url
    Type
    string
    Description

    Downloadbare URL zur Miniaturansicht der Modelldatei.

  • Name
    texture_urls
    Type
    array
    Description

    Ein Array von Textur-URL-Objekten, die von diesem Task generiert wurden. Enthält aktuell ein einzelnes Objekt mit der Basisfarbkarte.

    • Name
      base_color
      Type
      string
      Description

      Downloadbare URL zum Basisfarbkarten-Bild.

Example Vinyl Figure Build Task Object

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "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/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}