Creative Lab Fidget Pixel API

Das Foto, das in Pixel-Art 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 höchstens 20 MB sein. Meshy erkennt das Format anhand der Bilddaten, nicht anhand der Dateiendung in der URL. Eine URL ohne Dateiendung funktioniert ebenfalls, und Meshy folgt Weiterleitungen.

Was das Foto zeigt, wodurch der Pixel-Art-Stil festgelegt wird. Die beiden Stile unterscheiden sich deutlich. Jeder andere Wert führt zu 400.

Verfügbare Werte:

• person: eine Person, als Porträt- oder Ganzkörperfoto. Meshy zeichnet ein Pixel-Sprite im Chibi-Stil.
• other: jedes andere Motiv, zum Beispiel ein Haustier, ein Gegenstand, ein Maskottchen, ein Logo oder eine Landschaft. Meshy zeichnet ein Pixel-Icon im Bead-Art-Stil.

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

Die Anfrage kann nicht ausgeführt werden. Zum Beispiel:

• image_url oder type fehlt.
• type ist weder person noch other.
• 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 eingestuft.

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

Ihr Team hat die IP-Filterung aktiviert, und Meshy hat das Bild wegen geistigen Eigentums Dritter markiert. Senden Sie ein Bild, für das Sie die Nutzungsrechte besitzen.

Eine der folgenden Grenzen 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 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 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 dafür berechneten Credits zurück. Wiederholen Sie die Anfrage.

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

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

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.

Die Grundfläche jedes Teils. Jeder andere Wert liefert 400.

Verfügbare Werte:

• square: quadratische Teile auf einem quadratischen Raster
• hex: sechseckige Teile auf einem sechseckigen Raster, mit piece_size_mm auf 6 oder 8 gesetzt

Die Anzahl der Rasterzellen entlang jeder Seite des Bretts, 16 oder 32. Jeder andere Wert liefert 400. Ein 32-Raster behält mehr Details bei. Ein 16-Raster ergibt weniger Teile derselben Größe, sodass das Brett etwa halb so breit ist.

Die Kantenlänge jedes Teils in Millimetern, 6, 8 oder 10. Jeder andere Wert liefert 400. Zusammen mit grid_size bestimmt dieser Wert die Größe des gedruckten Bretts. Zum Beispiel ist ein 32-Raster aus 8-mm-Teilen etwa 26,5 cm pro Seite groß.

10 funktioniert nicht mit hex und liefert 400, da die schräge Sechseckfläche bei den meisten handelsüblichen FDM-Druckern einen Überhang verursacht.

Die maximale Anzahl der Farben in der Pixel-Art-Palette, von 1 bis 8. Ein Wert außerhalb dieses Bereichs liefert 400. Zum Drucken benötigen Sie bis zu color_count plus eins Filamente, eines pro Farbe und eines für die grauen Grundkörper.

Die Höhe jedes Teils in Millimetern, von 10 bis 80. Ein Wert außerhalb dieses Bereichs liefert 400.

Das Dateiformat des Ergebnisses. Jeder andere Wert liefert 400.

Verfügbare Werte:

• 3mf: eine mehrfarbige model.3mf-Datei, zurückgegeben unter model_urls.3mf

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, enthält aber kein Bild. Erstellen Sie eine neue Prototyp-Aufgabe.
• Ein Feld in options liegt außerhalb der zulässigen Werte, zum Beispiel ein grid_size, das weder 16 noch 32 ist.
• piece_size_mm ist 10 und shape ist hex. Sechseckige Teile gibt es nur in 6 und 8 mm.
• output.format ist nicht 3mf.

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.

Ihr Team hat IP-Filterung aktiviert, und Meshy hat das Bild der Prototyp-Aufgabe wegen geistigen Eigentums Dritter markiert. Erstellen Sie eine Prototyp-Aufgabe aus einem Bild, an dem Sie die Nutzungsrechte besitzen.

input_task_id entspricht keiner Fidget Pixel-Prototyp-Aufgabe, die Ihr Konto über die API erstellt hat. Ein in der Web-App erstellter Prototyp liefert ebenfalls 404. Senden Sie die result-ID aus einer Prototyp-Erstellungsantwort.

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 bereits 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 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 der Prototyp-Aufgabe nicht ausgeführt werden konnte. Meshy erstellt die Aufgabe nicht und erstattet alle bereits belasteten Credits zurück. Versuchen Sie die Anfrage erneut.

Die Aufgaben-ID aus der Erstellungsantwort.

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

Ihr Team hat die IP-Filterung aktiviert, und Meshy hat das Bild der Prototyp-Aufgabe wegen geistigen Eigentums Dritter markiert. Bei Build-Aufgaben und Teams im Enterprise-Plan tritt dieser Fehler nicht auf. Erstellen Sie eine Prototyp-Aufgabe mit einem Bild, an dem Sie die Nutzungsrechte besitzen.

Keine Fidget Pixel-Aufgabe mit dieser ID gehört zu Ihrem Konto, oder die Phase der Aufgabe stimmt nicht mit dem Pfad überein. Ü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 des abzubrechenden Tasks.

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 endgültigen Status (SUCCEEDED, FAILED oder CANCELED) und kann daher nicht abgebrochen werden.

Es gehört kein Fidget Pixel-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 passenden Task 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 ihr Format.

Der Task-Typ, immer creative-lab-fidget-pixel-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: 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. 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, sofern status nicht FAILED ist. Siehe Fehler.

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. Wenn Meshy die Belastung nicht auslesen kann, lässt eine Get- oder Stream-Antwort das Feld weg, und eine Listenanfrage liefert 500. Wiederholen Sie die Anfrage in diesem Fall.

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

Die URLs sind signiert, rufen Sie sie daher ohne Authorization-Header ab. Sie bleiben bis expires_at gültig. Wird der Task vor diesem Zeitpunkt erneut abgerufen, liefert er dieselben URLs, nicht neu signierte. Eine abgelaufene URL kann nicht erneuert werden, laden Sie die Dateien daher vorher herunter und speichern Sie sie.

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

Der Task-Typ, immer creative-lab-fidget-pixel-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 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 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, bis der Task 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, sofern status nicht 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 ist 0, da Meshy ihn erstattet. Das Abbrechen erstattet einen Task nur, solange er 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. In diesem Fall wiederholen Sie die Anfrage.

Download-URLs für das Ergebnis, mit dem Dateiformat als Schlüssel. Das Objekt enthält einen Eintrag für das von Ihnen gesendete output.format und ist leer, bis der Task erfolgreich ist.

Die URLs sind signiert, rufen Sie sie daher ohne Authorization-Header ab. Sie bleiben bis expires_at gültig. Wird der Task vor diesem Zeitpunkt erneut abgerufen, werden dieselben URLs zurückgegeben, keine neu signierten. Eine abgelaufene URL kann nicht erneuert werden, laden Sie die Dateien also vorher herunter und speichern Sie sie.