Creative Lab Lamp API

Das Foto, auf dem der Lampenschirm basieren soll, als öffentliche URL oder als 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.

Die Art des Motivs im Foto, die festlegt, wie Meshy es stilisiert.

Verfügbare Werte:

• character: eine einzelne Figur oder ein einzelnes Objekt, z. B. eine Figur, ein Tier oder ein Maskottchen
• landscape: eine Außenszene oder ein Panorama, z. B. ein Berg, eine Stadtlandschaft oder ein Wald

Ein Name für die Aufgabe, mit bis zu 100 Zeichen. Er wird im name-Feld der Aufgabe zurückgegeben. Ein längerer Name führt zu 400.

Ob der Hintergrund aus dem Prototypbild entfernt werden soll. true liefert ein transparentes RGBA-PNG, sodass Sie das Motiv vor einen beliebigen Hintergrund setzen können. Meshy erstellt das 3D-Modell außerdem aus dem Bild ohne dessen Hintergrund. Kann Meshy den Hintergrund nicht entfernen, verwendet es das Bild mit Hintergrund, und die Aufgabe ist trotzdem erfolgreich.

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 gekennzeichnet.
• image_subject ist weder character noch landscape.

Die Fehlermeldung nennt das gefundene Problem. Beheben Sie die Anfrage und senden Sie sie erneut.

Der API-Schlüssel fehlt oder ist ungültig. Überprüfen Sie den Authorization-Header.

Einer dieser Fälle trifft zu:

• Das Konto hat nicht 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.

Ihr Team hat IP Filtering aktiviert, und Meshy hat das Bild wegen geistigen Eigentums Dritter gekennzeichnet. Senden Sie ein Bild, zu dessen Nutzung Sie berechtigt sind.

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 laufen können. Warten Sie, bis eine Aufgabe abgeschlossen ist, oder fügen Sie Credits hinzu.

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 bereits berechneten Credits. Versuchen Sie die Anfrage erneut.

Die ID der zu bauenden Prototyp-Aufgabe. Sie muss eine Aufgabe sein, die Ihr Konto mit POST /openapi/creative-lab/lamp/v1/prototype erstellt hat, mit dem Status SUCCEEDED.

Eine ID, die nicht zu einer Ihrer Lamp-Prototyp-Aufgaben aus der API gehört, liefert 404 zurück, auch wenn der Prototyp in der Web-App erstellt wurde.

Ein Name für die Aufgabe, bis zu 100 Zeichen. Er wird im name-Feld der Aufgabe zurückgegeben. Ein längerer Name liefert 400 zurück.

Die größte Abmessung des Lampenschirms in Millimetern, von 50 bis 400. Meshy skaliert das Modell gleichmäßig, um es anzupassen. 0 verwendet den Standardwert, und jeder andere Wert außerhalb des Bereichs liefert 400 zurück.

Die Wandstärke des Lampenschirms in Millimetern, bis zu 10. 0 verwendet den Standardwert, und ein negativer Wert oder ein Wert über 10 liefert 400 zurück.

Der Prozentsatz der Modellhöhe, der am Boden flach abgeschnitten wird, von 1 bis 100. Der flache Boden ermöglicht es dem Lampenschirm, auf dem Druckbett zu stehen, und lässt Platz für die Fixture. Ein Wert außerhalb des Bereichs liefert 400 zurück.

Das Leuchtmittel-Fixture-Preset, das festlegt, wie Meshy den Boden baut.

Verfügbare Werte:

• bambu_mh001_60mm: ein Lampenschirm mit offenem Boden und einer Grundplatte mit einer 60-mm-Fixture-Bohrung, beide in model_urls.lamp_stl, sowie die Fixture-Halterung in model_urls.base_stl
• none: ein einzelner geschlossener Lampenschirm in model_urls.lamp_stl, ohne model_urls.base_stl

Wie weit die Fixture-Bohrung entlang der X-Achse vom Zentrum des Lampenschirms verschoben wird, in Millimetern, von -80 bis 80. Gilt nur, wenn light_source_preset nicht none ist.

Wie weit die Fixture-Bohrung entlang der Z-Achse (Tiefe) vom Zentrum des Lampenschirms verschoben wird, in Millimetern, von -80 bis 80. Gilt nur, wenn light_source_preset nicht none ist.

Die Drehung um die X-Achse, die auf das Modell angewendet wird, bevor Meshy es verarbeitet, in Grad, von -360 bis 360. Meshy wendet die drei Drehungen als XYZ-Euler-Winkel um das Zentrum des Modells an.

Die Drehung um die Y-Achse, die auf das Modell angewendet wird, bevor Meshy es verarbeitet, in Grad, von -360 bis 360.

Die Drehung um die Z-Achse, die auf das Modell angewendet wird, bevor Meshy es verarbeitet, in Grad, von -360 bis 360.

Ob eine result.json-Datei zum Zip-Bündel hinzugefügt werden soll, mit dem Namen der ausgeführten Pipeline, Warnungen und Dateipfaden. Erfordert, dass output.format auf zip gesetzt ist. true zusammen mit stl liefert 400 zurück.

Die Dateien, die der Build zurückgibt.

Verfügbare Werte:

• stl: model_urls.lamp_stl, der Lampenschirm mit seiner Grundplatte, wenn ein Fixture-Preset vorhanden ist, sowie model_urls.base_stl, wenn light_source_preset nicht none ist
• zip: eine Zip-Datei in model_urls.bundle_zip, mit lamp.stl sowie base.stl und result.json, wenn diese zutreffen

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 3D-Modell. Erstellen Sie eine neue Prototyp-Aufgabe.
• Ein options-Feld liegt außerhalb seines Bereichs oder ist kein verfügbarer Wert.
• output.format ist nicht stl oder zip, oder include_result_json ist true ohne zip.

Die Fehlermeldung gibt an, welches Problem gefunden wurde.

Der API-Schlüssel fehlt oder ist ungültig. Überprüfen Sie den Authorization-Header.

Einer der folgenden Punkte trifft zu:

• Das Konto verfügt nicht über ausreichend 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 dann erneut.

input_task_id stimmt mit keiner Lamp-Prototyp-Aufgabe überein, die Ihr Konto mit der API erstellt hat. Ein in der Web-App erstellter Prototyp liefert ebenfalls 404 zurück. Senden Sie die result-ID aus einer Antwort zur Prototyp-Erstellung.

Eines dieser Limits 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 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.

Die Aufgaben-ID aus der Erstellungsantwort.

id ist keine gültige Aufgaben-ID. Senden Sie die result-ID aus der Erstellungsantwort.

Ihr Team hat IP Filtering aktiviert, und Meshy hat das Bild der Prototype-Aufgabe wegen geistigem Eigentum Dritter markiert. Build-Aufgaben und Teams im Enterprise-Plan erhalten diesen Fehler nicht. Erstellen Sie eine Prototype-Aufgabe aus einem Bild, an dem Sie die Nutzungsrechte besitzen.

Es gehört keine Lamp-Aufgabe mit dieser ID zu Ihrem Konto, oder die Stufe der Aufgabe passt nicht zum Pfad. Überprüfen Sie die ID und verwenden Sie /prototype oder /build, passend zur Aufgabe.

Meshy konnte die Prüfung auf geistiges Eigentum nicht durchführen. Wiederholen Sie die Anfrage.

Die ID der abzubrechenden Aufgabe.

Einer der folgenden Fälle trifft zu:

• id ist keine gültige Aufgaben-ID. Senden Sie die result-ID aus der Antwort der Erstellung.
• Die Aufgabe hat bereits einen endgültigen Status (SUCCEEDED, FAILED oder CANCELED) und kann daher nicht abgebrochen werden.

Es gehört keine Lampe-Aufgabe mit dieser ID zu Ihrem Konto, oder die Stufe der Aufgabe stimmt nicht mit dem Pfad überein. Überprüfen Sie die ID und verwenden Sie /prototype oder /build, um die passende Aufgabe anzusprechen.

Die Task-ID aus der Erstellungsantwort.

Die aufzulistende Stufe, prototype oder build.

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.

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.

Die Sortierreihenfolge.

Verfügbare Werte:

• -created_at: neueste zuerst
• +created_at: älteste zuerst

Die Task-ID. Verlassen Sie sich nicht auf ihr Format.

Der Task-Typ, immer creative-lab-lamp-prototype.

Der name, den Sie beim Erstellen des Tasks gesendet haben, oder "", falls Sie keinen gesendet haben.

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

Prozentsatz der erledigten Arbeit, von 0 bis 100. Er ist 0, bis der Task beginnt, und 100, wenn er erfolgreich ist.

Zeitpunkt der Erstellung des Tasks, in Unix-Millisekunden.

Zeitpunkt, zu dem ein Worker den Task gestartet hat, in Unix-Millisekunden. Bis dahin null.

Zeitpunkt, zu dem der Task einen finalen Status erreicht hat, in Unix-Millisekunden. Bis dahin null.

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.

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.

Warum der Task fehlgeschlagen ist. null, außer wenn status gleich FAILED ist. Siehe Fehler.

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 zurückerstattet. 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 Listenanfrage gibt 500 zurück. In diesem Fall wiederholen Sie die Anfrage.

Download-URLs für das aus dem Konzeptbild generierte 3D-Modell. {}, bis der Task erfolgreich ist.

Download-URL für ein Vorschaubild des 3D-Modells. "", bis der Task erfolgreich ist.

Download-URLs für das Konzeptbild. Das Array enthält eine URL, nachdem der Task erfolgreich war, und ist bis dahin leer.

Die Task-ID. Verlassen Sie sich nicht auf deren Format.

Der Task-Typ, immer creative-lab-lamp-build.

Der name, den Sie beim Erstellen des Tasks gesendet haben, oder "", falls Sie keinen gesendet haben.

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

Prozentsatz der erledigten Arbeit, von 0 bis 100. Er ist 0, bis der Task startet, und 100, wenn er erfolgreich ist.

Zeitpunkt, zu dem der Task erstellt wurde, in Unix-Millisekunden.

Zeitpunkt, zu dem ein Worker den Task gestartet hat, in Unix-Millisekunden. Bis dahin null.

Zeitpunkt, zu dem der Task einen finalen Status erreicht hat, in Unix-Millisekunden. Bis dahin null.

Zeitpunkt, zu dem das Ergebnis des Tasks abläuft, in Unix-Millisekunden. Das sind 3 Tage nach finished_at, oder, solange der Task noch nicht abgeschlossen ist, 3 Tage nach created_at. Bei Enterprise-Konten, die API-Ergebnisse unbegrenzt aufbewahren, liegt er etwa 100 Jahre später. Siehe Aufbewahrung von Assets.

Die Position des Tasks in der Warteschlange, während er sich im Status PENDING befindet. 1 bedeutet, dass er als Nächstes startet. 0, nachdem der Task die Warteschlange verlassen hat, und bei Listenergebnissen immer 0.

Warum der Task fehlgeschlagen ist. null, außer wenn status FAILED ist. Siehe Fehler.

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 zurückerstattet. Ein Abbruch erstattet einen Task nur, solange er sich im Status PENDING befindet. Kann Meshy die Belastung nicht auslesen, lässt eine Get- oder Stream-Antwort das Feld weg, und eine Listenanfrage gibt 500 zurück. Wiederholen Sie in diesem Fall die Anfrage.

Download-URLs für die druckbaren Dateien. Welche Schlüssel vorkommen, hängt von output.format und options.light_source_preset ab.