Creative Lab Schlüsselanhänger API

Das Foto, das in ein Keychain-Konzeptbild 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 von maximal 20 MB sein.

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.

Er kennzeichnet die Aufgabe in Ihrem Dashboard und in Aufgabenlisten und erscheint nicht auf dem Keychain. Um einen Namen auf dem Keychain anzubringen, verwenden Sie name_text.

Ein Name, der dem Keychain hinzugefügt werden soll, zum Beispiel der Name eines Haustiers oder einer Person, bis zu 10 Zeichen. Meshy zählt Zeichen, nicht Bytes, sodass ein 10-stelliger chinesischer, japanischer oder koreanischer Name hineinpasst. Ein längerer Name führt zu 400. Lassen Sie das Feld weg, um einen Keychain ohne Namen zu erhalten.

Der Name erscheint auf der Vorderseite des Keychains als flaches, farbiges Detail, nicht als erhabener oder eingeschnittener Text.

Meshy entfernt umgebende Leerzeichen und unsichtbare Formatierungszeichen. Das Prototyp-Aufgabenobjekt gibt das Ergebnis als name_text zurück, sodass Sie den Text überprüfen können, bevor Sie für den Build bezahlen.

Meshy fügt den Namen in der Prototyp-Phase hinzu. Der Build behält ihn bei und ignoriert einen an den Build-Endpunkt gesendeten name_text.

Ob der Hintergrund aus dem Prototypbild entfernt werden soll. true liefert ein transparentes RGBA-PNG, das das gesamte Medaillon beibehält, sodass Sie es auf jeden beliebigen Hintergrund setzen können. Auch der Build startet dann mit dem Bild ohne Hintergrund. Wenn Meshy den Hintergrund nicht entfernen kann, gibt es das Bild mit Hintergrund zurück, und die Aufgabe ist dennoch erfolgreich.

Die remove_background-Option des Builds ist davon unabhängig.

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.
• name_text ist länger als 10 Zeichen. Meshy lehnt es ab, statt es zu kürzen, und berechnet keine Credits für die Anfrage.
• Das Bild oder name_text wurde als NSFW eingestuft.

Die Fehlermeldung gibt an, welches Problem gefunden wurde. 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 der folgenden Fälle trifft zu:

• Das Konto verfügt nicht über genügend Credits.
• Der API-Schlüssel, 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 erneut.

Ihr Team hat IP Filtering aktiviert, und Meshy hat das Bild wegen geistigen Eigentums Dritter markiert. Senden Sie ein Bild, zu dessen Nutzung Sie berechtigt sind. Meshy prüft nur das Bild auf geistiges Eigentum, nicht name_text.

Eines dieser Limits wurde erreicht:

• Sie haben mehr Anfragen gesendet, als Ihre Ratenbegrenzung zulässt. 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.

Bei Meshy ist ein Serverfehler aufgetreten, zum Beispiel weil die Prüfung auf geistiges Eigentum für das Bild nicht durchgeführt werden konnte. Meshy erstellt die Aufgabe nicht und erstattet alle berechneten Credits zurück. Versuchen Sie die Anfrage erneut.

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

Eine ID, die keiner Ihrer Keychain-Prototyp-Aufgaben aus der API entspricht, gibt 404 zurück, einschließlich eines in der Web-App erstellten Prototyps.

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.

Die Umrisslinie des Schlüsselanhängers, wenn Meshy sie nicht aus dem Motiv ableitet. Meshy verwendet sie, wenn remove_background false ist, oder wenn die Umrisslinie des Motivs nicht gefunden werden kann.

Verfügbare Werte:

• circle
• rounded-rect
• hexagon
• shield
• star

Die Kantenlänge des umschließenden Quadrats des Schlüsselanhängers, in Millimetern, bis zu 400. 0 verwendet den Standardwert.

Die maximale Höhe des Reliefs über der Basis, in Millimetern, von 0 bis 20.

Wie weit das Relief abgesenkt wird, in Millimetern, von 0 bis 20. Meshy zieht diesen Wert überall von der Reliefhöhe ab, bis hinunter zur Basis.

Die Dicke der flachen Grundplatte hinter dem Relief, in Millimetern, von 0 bis 20.

Ob die Rückseite des Schlüsselanhängers geschlossen werden soll. false lässt die Rückseite als Schale offen.

Die Kurve, die Tiefenkartenwerte auf die Reliefhöhe abbildet.

Verfügbare Werte:

• linear
• gamma
• s-curve

Die Stärke der Kurve, bis zu 10. Die Kurven gamma und s-curve verwenden sie, linear ignoriert sie. 0 verwendet den Standardwert.

Ob die Tiefenkarte invertiert werden soll, sodass dunklere Bereiche ein höheres Relief ergeben.

Wie stark die Tiefenkarte geglättet wird, bevor Meshy das Relief erstellt, von 0 bis 10.

Wie stark das Relief und dessen Textur innerhalb der Umrisslinie um das Zentrum herum gezoomt wird, bis zu 10. Ein Wert über 1 vergrößert das Motiv, ein Wert unter 1 verkleinert es. Die Reliefhöhe ändert sich dadurch nicht. 0 verwendet den Standardwert.

Der Tiefenkartenwert, unterhalb dessen Meshy die Tiefe auf null setzt, von 0 bis 1.

Ob die Umrisslinie des Schlüsselanhängers aus dem Motiv nachgezeichnet werden soll, sodass der Schlüsselanhänger der Form des Motivs folgt. false verwendet stattdessen die Umrisslinie von badge_shape. Meshy verwendet badge_shape auch dann, wenn die Umrisslinie des Motivs nicht gefunden werden kann.

Dies ist unabhängig vom remove_background-Parameter des Prototyps, der festlegt, ob das Prototypbild einen transparenten Hintergrund hat.

Die Netzauflösung des exportierten Modells, von 64 bis 512. Meshy erstellt die Geometrie aus einer Tiefenkarte mit 512 Pixel, sodass ein feineres Netz zusätzliche Flächen hinzufügen würde, ohne weitere Details zu liefern. 0 verwendet den Standardwert.

Das Dateiformat, das der Build zurückgibt.

Verfügbare Werte:

• glb: eine model.glb-Datei, in model_urls.glb
• obj: eine ZIP-Datei mit model.obj, model.mtl und texture.png, in model_urls.obj
• zip: eine ZIP-Datei mit allen von Meshy erzeugten Dateien, in model_urls.bundle_zip

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. 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.
• Ein options-Feld liegt außerhalb seines Bereichs oder ist kein verfügbarer Wert.

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 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 nutzt den kostenlosen Plan.

Überprüfen Sie Ihre Credits und Ihren Plan und versuchen Sie es erneut.

input_task_id entspricht keiner Keychain-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 die Erstellung eines Prototyps.

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 werden ausgeführt. 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.

Die Task-ID aus der Erstellungsantwort.

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

Ihr Team hat IP-Filterung aktiviert, und Meshy hat das Bild des Prototyp-Tasks wegen Rechten Dritter an geistigem Eigentum markiert. Build-Tasks und Teams im Enterprise-Plan erhalten diesen Fehler nicht. Erstellen Sie einen Prototyp-Task mit einem Bild, an dem Sie die Nutzungsrechte besitzen.

Es gehört kein Schlüsselanhänger-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.

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 Create-Antwort.
• Die Aufgabe hat bereits einen endgültigen Status (SUCCEEDED, FAILED oder CANCELED) und kann daher nicht abgebrochen werden.

Es gehört keine Keychain-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 Aufgabe zu finden.

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

Die Sortierreihenfolge.

Verfügbare Werte:

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

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

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

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

Der Name, den Meshy dem Schlüsselanhänger hinzugefügt hat, nach dem Entfernen von Leerzeichen und unsichtbaren Formatierungszeichen. Wird weggelassen, wenn Sie name_text nicht gesendet haben. Um zu prüfen, ob Ihr HTTP-Client den Text korrekt kodiert hat, vergleichen Sie ihn mit dem, was Sie gesendet haben.

Der Status des Tasks.

Verfügbare Werte:

• PENDING: wartet in der Warteschlange
• IN_PROGRESS: erzeugt das Ergebnis
• SUCCEEDED: abgeschlossen, mit Ergebnis
• FAILED: abgeschlossen, mit dem Grund in task_error
• CANCELED: abgeschlossen, ohne Ergebnis

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

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 endgültigen 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 bei Listenergebnissen immer 0.

Grund, warum der Task fehlgeschlagen ist. null, außer wenn status den Wert FAILED hat. 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. Bei einem fehlgeschlagenen Task ist der Wert 0, da Meshy ihn erstattet. Ein Abbruch erstattet einen Task nur, solange dieser 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 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 ihr Format.

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

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

Der Status des Tasks.

Verfügbare Werte:

• PENDING: wartet in der Warteschlange
• IN_PROGRESS: generiert das Ergebnis
• SUCCEEDED: final, mit Ergebnis
• FAILED: final, mit dem Grund in task_error
• CANCELED: final, ohne Ergebnis

Prozentsatz der erledigten Arbeit, von 0 bis 100. Der Wert ist 0, bis der Task startet, 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 dieser Wert etwa 100 Jahre in der Zukunft. 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. Bei einem fehlgeschlagenen Task ist der 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 das Feld weg, und eine Listenanfrage gibt 500 zurück. Wiederholen Sie in diesem Fall die Anfrage.

Download-URLs für die Modelldatei, mit einem Eintrag für das von Ihnen angeforderte output.format. {}, bis der Task erfolgreich ist.