Creative Lab Fidget Pixel API

De foto die moet worden omgezet in pixel-art, als openbare URL of als data-URI (data:image/jpeg;base64,<je base64-gecodeerde afbeeldingsgegevens>).

De afbeelding moet een JPG-, JPEG-, PNG- of WebP-bestand van maximaal 20 MB zijn. Meshy detecteert het formaat op basis van de afbeeldingsgegevens, niet op basis van de bestandsextensie in de URL. Een URL zonder extensie werkt ook, en Meshy volgt omleidingen.

Wat de foto toont, wat de pixel-art-stijl bepaalt. De twee stijlen zien er duidelijk verschillend uit. Elke andere waarde geeft 400 terug.

Beschikbare waarden:

• person: een persoon, op een portret- of volledige-lichaamsfoto. Meshy tekent een pixelsprite in chibi-stijl.
• other: elk ander onderwerp, bijvoorbeeld een huisdier, een object, een mascotte, een logo of een landschap. Meshy tekent een pixelicoon in kralenkunst-stijl.

Een naam voor de taak, tot 100 tekens. Deze komt terug in het name-veld van de taak. Een langere naam geeft 400 terug.

Het verzoek kan niet worden uitgevoerd. Bijvoorbeeld:

• image_url of type ontbreekt.
• type is niet person of other.
• De afbeelding is geen JPG-, JPEG-, PNG- of WebP-bestand.
• De afbeelding is te klein, groter dan 20 MB, of overschrijdt het maximale aantal pixels.
• Meshy kan de afbeelding niet downloaden, bijvoorbeeld omdat de URL 404 teruggeeft of de time-out verstrijkt.
• De data-URI is geen geldige base64.
• De afbeelding is gemarkeerd als NSFW.

Het foutbericht geeft aan welk probleem er is gevonden. Herstel het verzoek en verstuur het opnieuw.

De API-sleutel ontbreekt of is ongeldig. Controleer de Authorization-header.

Een van de volgende situaties doet zich voor:

• Het account heeft niet genoeg credits.
• De API-sleutel, werkruimte of het lid heeft het creditlimiet bereikt.
• Het account gebruikt het gratis abonnement.

Controleer je credits en abonnement, en probeer het opnieuw.

Je team heeft IP-filtering ingeschakeld, en Meshy heeft de afbeelding gemarkeerd vanwege intellectueel eigendom van derden. Stuur een afbeelding waarvoor je gebruiksrechten hebt.

Een van deze limieten is bereikt:

• Je hebt meer verzoeken verstuurd dan je rate limit toestaat. Wacht een paar seconden en probeer het opnieuw. Zie Rate limits.
• Er staan te veel van je taken in de wachtrij of lopen er al te veel. Wacht tot een aantal zijn afgerond en probeer het opnieuw.
• Bij een onbeperkt abonnement zonder resterende credits heb je het aantal taken bereikt dat zonder credits kan worden uitgevoerd. Wacht tot een taak is afgerond, of voeg credits toe.

Meshy is op een serverfout gestuit, bijvoorbeeld omdat de controle op intellectueel eigendom van de afbeelding niet kon worden uitgevoerd. Meshy maakt de taak niet aan en betaalt eventueel in rekening gebrachte credits terug. Probeer het verzoek opnieuw.

De ID van de prototype-taak om te builden. Het moet een taak zijn die uw account heeft aangemaakt met POST /openapi/creative-lab/fidget-pixel/v1/prototype, met de status SUCCEEDED.

Een ID die niet een van uw Fidget Pixel prototype-taken via de API is, geeft 404 terug, inclusief een prototype gemaakt in de web-app.

Een naam voor de taak, tot 100 tekens. Deze komt terug in het name-veld van de taak. Een langere naam geeft 400 terug.

De voetafdruk van elk onderdeel. Elke andere waarde geeft 400 terug.

Beschikbare waarden:

• square: vierkante onderdelen op een vierkant raster
• hex: zeshoekige onderdelen op een zeshoekig raster, met piece_size_mm ingesteld op 6 of 8

Het aantal rastercellen langs elke zijde van het bord, 16 of 32. Elke andere waarde geeft 400 terug. Een 32-raster behoudt meer detail. Een 16-raster geeft minder onderdelen van dezelfde grootte, waardoor het bord ongeveer half zo breed is.

De randlengte van elk onderdeel in millimeter, 6, 8, of 10. Elke andere waarde geeft 400 terug. Samen met grid_size bepaalt dit de grootte van het geprinte bord. Bijvoorbeeld, een 32-raster met onderdelen van 8 mm is ongeveer 26,5 cm per zijde.

10 werkt niet met hex en geeft 400 terug, omdat het schuine zeshoeksvlak bij de meeste consumenten-FDM-printers overhangt.

Het maximale aantal kleuren in het pixel-art-palet, van 1 tot 8. Een waarde buiten het bereik geeft 400 terug. Om te printen heeft u tot color_count plus één filament nodig, één per kleur en één voor de grijze lichamen.

De hoogte van elk onderdeel in millimeter, van 10 tot 80. Een waarde buiten het bereik geeft 400 terug.

Het bestandsformaat van het resultaat. Elke andere waarde geeft 400 terug.

Beschikbare waarden:

• 3mf: één multicolor model.3mf-bestand, teruggegeven in model_urls.3mf

Het verzoek kan niet worden uitgevoerd. Bijvoorbeeld:

• input_task_id ontbreekt of is geen geldige taak-ID.
• De status van de prototype-taak is niet SUCCEEDED. Als deze nog loopt, wacht en probeer het opnieuw. Als deze is mislukt of geannuleerd, maak dan een nieuwe prototype-taak aan.
• De prototype-taak is geslaagd, maar heeft geen afbeelding. Maak een nieuwe prototype-taak aan.
• Een options-veld valt buiten de toegestane waarden, bijvoorbeeld een grid_size anders dan 16 of 32.
• piece_size_mm is 10 en shape is hex. Zeshoekige onderdelen zijn alleen beschikbaar in 6 en 8 mm.
• output.format is niet 3mf.

Het foutbericht geeft aan welk probleem er is gevonden.

De API-sleutel ontbreekt of is ongeldig. Controleer de Authorization-header.

Een van het volgende is van toepassing:

• Het account heeft onvoldoende credits.
• De API-sleutel, werkruimte of het lid heeft zijn creditlimiet bereikt.
• Het account heeft een gratis abonnement.

Controleer uw credits en abonnement en probeer het opnieuw.

Uw team heeft IP Filtering ingeschakeld, en Meshy heeft de afbeelding van de prototype-taak gemarkeerd wegens intellectueel eigendom van derden. Maak een prototype-taak aan vanuit een afbeelding waarvoor u de rechten heeft.

input_task_id komt niet overeen met een Fidget Pixel prototype-taak die uw account via de API heeft aangemaakt. Een prototype gemaakt in de web-app geeft ook 404 terug. Stuur de result-ID uit een prototype-aanmaakrespons.

Een van deze limieten is bereikt:

• U hebt meer verzoeken verstuurd dan uw rate limit toestaat. Wacht een paar seconden en probeer het opnieuw. Zie Rate limits.
• Er staan te veel van uw taken in de wachtrij of lopen te veel. Wacht tot er een aantal zijn voltooid en probeer het opnieuw.
• Bij een onbeperkt abonnement zonder resterende credits heeft u het aantal taken bereikt dat zonder credits kan draaien. Wacht tot een taak is voltooid, of voeg credits toe.

Meshy is op een serverfout gestuit, bijvoorbeeld omdat de controle op intellectueel eigendom op de afbeelding van de prototype-taak niet kon worden uitgevoerd. Meshy maakt de taak niet aan en vergoedt eventuele in rekening gebrachte credits. Probeer het verzoek opnieuw.

De taak-ID uit het aanmaakantwoord.

id is geen geldige taak-ID. Stuur de result-ID uit het aanmaakantwoord.

Uw team heeft IP Filtering ingeschakeld, en Meshy heeft de afbeelding van de prototype-taak gemarkeerd wegens intellectueel eigendom van derden. Build-taken en teams in het Enterprise-plan krijgen deze foutmelding niet. Maak een prototype-taak aan met een afbeelding waarvoor u de gebruiksrechten heeft.

Er bestaat geen Fidget Pixel-taak met deze ID voor uw account, of de fase van de taak komt niet overeen met het pad. Controleer de ID en gebruik /prototype of /build om overeen te komen met de taak.

Meshy kon de controle op intellectueel eigendom niet uitvoeren. Probeer het verzoek opnieuw.

De ID van de taak die moet worden geannuleerd.

Een van het volgende is van toepassing:

• id is geen geldige taak-ID. Stuur de result-ID uit de create-respons.
• De taak heeft al een definitieve status (SUCCEEDED, FAILED of CANCELED), dus kan niet worden geannuleerd.

Er bestaat geen Fidget Pixel-taak met deze ID die bij uw account hoort, of de fase van de taak komt niet overeen met het pad. Controleer de ID en gebruik /prototype of /build om overeen te komen met de taak.

De taak-ID uit het antwoord van het aanmaken.

De op te vragen fase, prototype of build.

De terug te geven pagina, van 1 tot 255. 0 geeft de eerste pagina terug. Een waarde buiten 0 tot 255 geeft 400 terug.

Aantal taken per pagina, tot 100. Een waarde van 101 tot 255 geeft 100 taken terug, en 0 gebruikt de standaardwaarde. Een waarde buiten 0 tot 255 geeft 400 terug.

De sorteervolgorde.

Beschikbare waarden:

• -created_at: nieuwste eerst
• +created_at: oudste eerst

De taak-ID. Vertrouw niet op het formaat ervan.

Het taaktype, altijd creative-lab-fidget-pixel-prototype.

De name die je hebt meegestuurd bij het aanmaken van de taak, of "" als je er geen hebt meegestuurd.

De status van de taak.

Beschikbare waarden:

• PENDING: wacht in de wachtrij
• IN_PROGRESS: resultaat wordt gegenereerd
• SUCCEEDED: definitief, met het resultaat
• FAILED: definitief, met de reden in task_error
• CANCELED: definitief, zonder resultaat

Percentage van het voltooide werk, van 0 tot 100. Dit is 0 totdat de taak start en 100 wanneer deze slaagt.

Tijdstip waarop de taak werd aangemaakt, in Unix-milliseconden.

Tijdstip waarop een worker de taak startte, in Unix-milliseconden. null tot dan.

Tijdstip waarop de taak een definitieve status bereikte, in Unix-milliseconden. null tot dan.

Tijdstip waarop het resultaat van de taak verloopt, in Unix-milliseconden. Dit is 3 dagen na finished_at, of 3 dagen na created_at totdat de taak voltooid is. Voor Enterprise-accounts, die API-resultaten onbeperkt bewaren, is dit ongeveer 100 jaar later. Zie Asset-retentie.

De positie van de taak in de wachtrij terwijl deze PENDING is. 1 betekent dat deze als volgende start. 0 nadat de taak de wachtrij verlaat, en altijd 0 in lijstresultaten.

Waarom de taak is mislukt. null tenzij status gelijk is aan FAILED. Zie Fouten.

Aantal credits dat voor de taak in rekening is gebracht, na eventuele terugbetaling. Een verzoek dat een fout retourneert, wordt niet in rekening gebracht. Een mislukte taak is 0, omdat Meshy deze terugbetaalt. Annuleren betaalt een taak alleen terug terwijl deze PENDING is. Als Meshy de kosten niet kan uitlezen, laat een get- of streamrespons het veld weg, en retourneert een lijstverzoek 500. Probeer het verzoek in dat geval opnieuw.

Download-URL's voor de pixel-art-afbeelding. De array bevat één URL nadat de taak is geslaagd, en is leeg tot dan.

De URL's zijn ondertekend, dus haal ze op zonder een Authorization-header. Ze blijven geldig tot expires_at. De taak opnieuw ophalen vóór die tijd levert dezelfde URL's op, niet opnieuw ondertekende. Een verlopen URL kan niet worden vernieuwd, dus download en bewaar de bestanden vóór die tijd.

De taak-ID. Vertrouw niet op het formaat ervan.

Het taaktype, altijd creative-lab-fidget-pixel-build.

De name die je hebt meegestuurd toen je de taak hebt aangemaakt, of "" als je er geen hebt meegestuurd.

De status van de taak.

Beschikbare waarden:

• PENDING: wacht in de wachtrij
• IN_PROGRESS: genereert het resultaat
• SUCCEEDED: definitief, met het resultaat
• FAILED: definitief, met de reden in task_error
• CANCELED: definitief, zonder resultaat

Percentage van het voltooide werk, van 0 tot 100. Dit is 0 totdat de taak begint en 100 wanneer deze slaagt.

Tijdstip waarop de taak is aangemaakt, in Unix-milliseconden.

Tijdstip waarop een worker de taak heeft gestart, in Unix-milliseconden. null tot dat moment.

Tijdstip waarop de taak een definitieve status heeft bereikt, in Unix-milliseconden. null tot dat moment.

Tijdstip waarop het resultaat van de taak verloopt, in Unix-milliseconden. Dit is 3 dagen na finished_at, of 3 dagen na created_at totdat de taak voltooid is. Voor Enterprise-accounts, die API-resultaten onbeperkt bewaren, is dit ongeveer 100 jaar later. Zie Asset-retentie.

De positie van de taak in de wachtrij terwijl deze PENDING is. 1 betekent dat deze als volgende start. 0 nadat de taak de wachtrij verlaat, en altijd 0 in lijstresultaten.

Waarom de taak is mislukt. null tenzij status gelijk is aan FAILED. Zie Fouten.

Aantal credits dat voor de taak in rekening is gebracht, na eventuele terugbetaling. Voor een verzoek dat een fout retourneert, worden geen kosten in rekening gebracht. Een mislukte taak is 0, omdat Meshy deze terugbetaalt. Annuleren betaalt een taak alleen terug terwijl deze PENDING is. Als Meshy de kosten niet kan uitlezen, laat een get- of streamrespons het veld weg, en retourneert een lijstverzoek 500. Probeer het verzoek in dat geval opnieuw.

Download-URL's voor het resultaat, gesleuteld op bestandsformaat. Het object heeft één item, voor de output.format die je hebt meegestuurd, en is leeg totdat de taak slaagt.

De URL's zijn ondertekend, dus haal ze op zonder een Authorization-header. Ze blijven geldig tot expires_at. Als je de taak vóór dat moment opnieuw ophaalt, krijg je dezelfde URL's terug, geen nieuw ondertekende. Een verlopen URL kan niet worden vernieuwd, dus download en bewaar de bestanden ervoor.