Creative Lab Koelkastmagneet API

De foto die moet worden omgezet in een koelkastmagneet-conceptafbeelding, als een publieke URL of een data-URI (data:image/jpeg;base64,<your base64-encoded image data>).

De afbeelding moet een JPG-, JPEG-, PNG- of WebP-bestand van maximaal 20 MB zijn.

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

Of de achtergrond uit de prototypeafbeelding moet worden verwijderd. true levert een transparante RGBA-PNG op waarop de hele magneet behouden blijft, zodat je deze op elke achtergrond kunt plaatsen. De build gaat ook uit van de afbeelding zonder achtergrond. Als Meshy de achtergrond niet kan verwijderen, geeft het de afbeelding met achtergrond terug, en slaagt de taak alsnog.

De remove_background-optie van de build staat hier los van.

Het verzoek kan niet worden uitgevoerd. Bijvoorbeeld:

• image_url ontbreekt.
• 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 time-out geeft.
• De data-URI is geen geldige base64.
• De afbeelding is gemarkeerd als NSFW.

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

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

Een van de volgende situaties doet zich voor:

• Het account heeft onvoldoende credits.
• De API-sleutel, werkruimte of het lid heeft de 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 wegens intellectueel eigendom van derden. Stuur een afbeelding waarvan je het gebruiksrecht 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 te veel. Wacht tot sommige 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 ondervond een serverfout, bijvoorbeeld doordat de controle op intellectueel eigendom van de afbeelding niet kon worden uitgevoerd. Meshy maakt de taak niet aan en betaalt eventuele in rekening gebrachte credits terug. Probeer het verzoek opnieuw.

De ID van de te bouwen prototypetaak. Dit moet een taak zijn die jouw account heeft aangemaakt met POST /openapi/creative-lab/fridge-magnet/v1/prototype, met de status SUCCEEDED.

Een ID die niet bij een van jouw Fridge Magnet-prototypetaken uit de API hoort, geeft 404 terug, ook als het een prototype uit de web-app betreft.

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

De omtrek van de magneet wanneer Meshy deze niet uit het onderwerp traceert. Meshy gebruikt dit wanneer remove_background op false staat, of wanneer het de omtrek van het onderwerp niet kan vinden.

Beschikbare waarden:

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

De zijlengte van het begrenzende vierkant van de magneet, in millimeter, tot 400. 0 gebruikt de standaardwaarde.

De maximale hoogte van het reliëf boven de basis, in millimeter, van 0 tot 20.

Hoeveel het reliëf moet worden verlaagd, in millimeter, van 0 tot 20. Meshy trekt dit overal van de hoogte van het reliëf af, tot aan de basis.

De dikte van de platte basisplaat achter het reliëf, in millimeter, van 0 tot 20. De standaard van 2 mm geeft de magneet voldoende body om aan de koelkast te hechten, zodat het reliëf niet breekbaar aanvoelt.

Of de achterkant van de magneet gesloten moet zijn, de kant waarop je de magneet lijmt. false laat de achterkant open, als een schaal.

De curve die depth-map-waarden omzet naar reliëfhoogte.

Beschikbare waarden:

• linear
• gamma
• s-curve

De sterkte van de curve, tot 10. De curves gamma en s-curve gebruiken deze, en linear negeert hem. 0 gebruikt de standaardwaarde.

Of de depth-map moet worden omgekeerd, zodat donkerdere gebieden een hoger reliëf krijgen.

Hoeveel de depth-map moet worden gladgestreken voordat Meshy het reliëf bouwt, van 0 tot 10.

Hoeveel het reliëf en de bijbehorende textuur binnen de omtrek, rond het midden, moeten worden ingezoomd, tot 10. Een waarde boven 1 vergroot het onderwerp, en een waarde onder 1 verkleint het. Dit verandert de hoogte van het reliëf niet. 0 gebruikt de standaardwaarde.

De depth-map-waarde waaronder Meshy de diepte op nul zet, van 0 tot 1.

Of de omtrek van de magneet uit het onderwerp moet worden getraceerd, zodat de magneet de vorm van het onderwerp volgt. false gebruikt in plaats daarvan de badge_shape-omtrek. Meshy gebruikt badge_shape ook wanneer het de omtrek van het onderwerp niet kan vinden.

Dit staat los van de remove_background-parameter van het prototype, die bepaalt of de prototypeafbeelding een transparante achtergrond heeft.

De mesh-resolutie van het geëxporteerde model, van 64 tot 512. Meshy bouwt de geometrie uit een depth-map van 512 pixels, dus een fijnere mesh zou alleen vlakken toevoegen zonder extra detail. 0 gebruikt de standaardwaarde.

Het bestandsformaat dat de build retourneert.

Beschikbare waarden:

• glb: één model.glb-bestand, in model_urls.glb
• obj: een zip-bestand met model.obj, model.mtl en texture.png, in model_urls.obj
• zip: een zip-bestand met elk bestand dat Meshy genereert, in model_urls.bundle_zip

Het verzoek kan niet worden uitgevoerd. Bijvoorbeeld:

• input_task_id ontbreekt of is geen geldige taak-ID.
• De status van de prototypetaak is niet SUCCEEDED. Als deze nog loopt, wacht dan en probeer het opnieuw. Als deze mislukt is of geannuleerd werd, maak dan een nieuwe prototypetaak aan.
• De prototypetaak is geslaagd, maar heeft geen afbeelding. Maak een nieuwe prototypetaak aan.
• Een options-veld valt buiten het bereik of is geen beschikbare waarde.

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 de creditlimiet bereikt.
• Het account gebruikt het gratis plan.

Controleer je credits en plan, en probeer het opnieuw.

input_task_id komt niet overeen met een Fridge Magnet-prototypetaak die jouw account met de API heeft aangemaakt. Een prototype dat in de web-app is gemaakt, geeft ook 404 terug. Stuur de result-ID uit een antwoord op het aanmaken van een prototype.

Een van deze limieten is bereikt:

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

De taak-ID uit het aanmaak-antwoord.

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

Je team heeft IP Filtering ingeschakeld, en Meshy heeft de afbeelding van de prototypetaak gemarkeerd wegens intellectuele eigendom van derden. Buildtaken en teams met het Enterprise-abonnement krijgen deze fout niet. Maak een prototypetaak aan met een afbeelding waarvoor je gebruiksrechten hebt.

Er bestaat geen koelkastmagneet-taak met deze ID voor jouw 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 intellectuele eigendom niet uitvoeren. Probeer het verzoek opnieuw.

De ID van de taak die moet worden geannuleerd.

Een van de volgende is van toepassing:

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

Er bestaat geen koelkastmagneet-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 aanmaakantwoord.

De fase die wordt weergegeven, prototype of build.

De pagina die moet worden geretourneerd, 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-fridge-magnet-prototype.

De name die u heeft meegestuurd bij het aanmaken van de taak, of "" als u er geen heeft 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 start 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 is voltooid. 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 heeft verlaten, 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 lezen, laat een get- of streamrespons het veld weg, en retourneert een lijstverzoek 500. Probeer het verzoek in dat geval opnieuw.

Downloadlinks voor de conceptafbeelding. De array bevat één URL nadat de taak is geslaagd, en is tot die tijd leeg.

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

Het taaktype, altijd creative-lab-fridge-magnet-build.

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 is aangemaakt, in Unix-milliseconden.

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

Tijdstip waarop de taak een definitieve status bereikte, 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 heeft verlaten, 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 lezen, laat een get- of stream-respons het veld weg, en retourneert een lijstverzoek 500. Probeer het verzoek in dat geval opnieuw.

Downloadlinks voor het modelbestand, met één item voor het output.format dat je hebt opgevraagd. {} totdat de taak slaagt.