Creative Lab sleutelhanger-API

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

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

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

Het labelt de taak in je dashboard en taaklijsten, en verschijnt niet op de keychain. Gebruik name_text om een naam op de keychain te plaatsen.

Een naam om aan de keychain toe te voegen, zoals de naam van een huisdier of een persoon, tot 10 tekens. Meshy telt tekens, geen bytes, dus een Chinese, Japanse of Koreaanse naam van 10 tekens past. Een langere naam levert 400 op. Laat dit weg voor een keychain zonder naam.

De naam verschijnt op de voorzijde van de keychain als een plat gekleurd detail, niet als verhoogde of uitgesneden tekst.

Meshy verwijdert omliggende witruimte en onzichtbare opmaaktekens. Het prototypetaakobject geeft het resultaat terug als name_text, zodat je de tekst kunt controleren voordat je voor de build betaalt.

Meshy voegt de naam toe in de prototypefase. De build behoudt deze, en negeert een name_text die naar de build-endpoint wordt gestuurd.

Of de achtergrond uit de prototypeafbeelding moet worden verwijderd. true geeft een transparante RGBA-PNG terug die het hele medaillon behoudt, zodat je het op elke achtergrond kunt plaatsen. De build start ook vanaf de afbeelding zonder achtergrond. Als Meshy de achtergrond niet kan verwijderen, geeft het de afbeelding mét achtergrond terug, en slaagt de taak alsnog.

De remove_background-optie van de build is afzonderlijk.

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 een time-out veroorzaakt.
• De data-URI is geen geldige base64.
• name_text is langer dan 10 tekens. Meshy wijst het verzoek af in plaats van de tekst in te korten, en brengt geen kosten in rekening voor het verzoek.
• De afbeelding of name_text is gemarkeerd als NSFW.

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

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

Een van de volgende situaties is van toepassing:

• Het account heeft niet voldoende 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 vanwege intellectueel eigendom van derden. Stuur een afbeelding waarvoor je het gebruiksrecht hebt. Meshy controleert alleen de afbeelding op intellectueel eigendom, niet name_text.

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 ze worden al uitgevoerd. Wacht tot er een aantal zijn voltooid 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 voltooid, of voeg credits toe.

Meshy heeft een serverfout ondervonden, bijvoorbeeld omdat de intellectueel-eigendomscontrole op de afbeelding niet kon worden uitgevoerd. Meshy maakt de taak niet aan en vergoedt eventueel in rekening gebrachte credits. Probeer het verzoek opnieuw.

De ID van de prototype-taak die moet worden gebouwd. Dit moet een taak zijn die uw account heeft aangemaakt met POST /openapi/creative-lab/keychain/v1/prototype, met de status SUCCEEDED.

Een ID die niet overeenkomt met een van uw Keychain-prototypetaken uit de API retourneert 404, inclusief een prototype dat in de web-app is gemaakt.

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

De omtrek van de sleutelhanger wanneer Meshy deze niet uit het onderwerp traceert. Meshy gebruikt dit wanneer remove_background false is, of wanneer de omtrek van het onderwerp niet gevonden kan worden.

Beschikbare waarden:

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

De zijlengte van het begrenzende vierkant van de sleutelhanger, 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 verlaagd moet worden, 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.

Of de achterkant van de sleutelhanger gesloten moet worden. false laat de achterkant open, als een schaal.

De curve die depth-map-waarden koppelt aan de reliëfhoogte.

Beschikbare waarden:

• linear
• gamma
• s-curve

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

Of de depth map geïnverteerd moet worden, zodat donkerdere gebieden een hoger reliëf krijgen.

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

Hoeveel het reliëf en de textuur ervan binnen de omtrek moeten worden ingezoomd, rond het midden, 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 sleutelhanger uit het onderwerp getraceerd moet worden, zodat de sleutelhanger de vorm van het onderwerp volgt. false gebruikt in plaats daarvan de badge_shape-omtrek. Meshy gebruikt badge_shape ook wanneer de omtrek van het onderwerp niet gevonden kan worden.

Dit staat los van de remove_background-parameter van het prototype, die bepaalt of de prototype-afbeelding 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 extra vlakken toevoegen zonder extra detail. 0 gebruikt de standaardwaarde.

Het bestandsformaat dat de build retourneert.

Beschikbare waarden:

• glb: één bestand model.glb, 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

De aanvraag 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 draait, wacht dan en probeer het opnieuw. Als deze mislukt is of geannuleerd is, 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 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 heeft het gratis abonnement.

Controleer uw credits en abonnement, en probeer het opnieuw.

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

Een van deze limieten is bereikt:

• U hebt meer aanvragen 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 er te veel. Wacht tot er enkele klaar zijn en probeer het opnieuw.
• Bij een onbeperkt abonnement zonder resterende credits hebt u het maximale aantal taken bereikt dat zonder credits kan draaien. Wacht tot een taak klaar is, of voeg credits toe.

De taak-ID uit de aanmaakrespons.

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

Je team heeft IP Filtering ingeschakeld, en Meshy heeft de afbeelding van de prototype-taak gemarkeerd wegens intellectueel eigendom van derden. Build-taken en teams op het Enterprise-abonnement krijgen deze fout niet. Maak een prototype-taak aan met een afbeelding waarvan je de rechten bezit.

Er is geen sleutelhanger-taak met deze ID gekoppeld aan jouw account, of de fase van de taak komt niet overeen met het pad. Controleer de ID en gebruik /prototype of /build om de taak te matchen.

Meshy kon de intellectueel-eigendomscontrole niet uitvoeren. Probeer het verzoek opnieuw.

Het ID van de taak die moet worden geannuleerd.

Een van de volgende is van toepassing:

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

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

De taak-ID uit de create-respons.

De weer te geven 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-keychain-prototype.

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

De naam die Meshy aan de sleutelhanger heeft toegevoegd, na het verwijderen van witruimte en onzichtbare opmaaktekens. Wordt weggelaten als je geen name_text hebt meegestuurd. Om te controleren of je HTTP-client de tekst correct heeft gecodeerd, vergelijk je deze met wat je hebt verzonden.

De status van de taak.

Beschikbare waarden:

• PENDING: wacht in de wachtrij
• IN_PROGRESS: resultaat wordt gegenereerd
• SUCCEEDED: definitief, met 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 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 leidt alleen tot terugbetaling van een taak zolang 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.

Download-URL's voor de conceptafbeelding. De array bevat één URL nadat de taak is geslaagd, en is daarvoor leeg.

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

Het taaktype, altijd creative-lab-keychain-build.

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 zodra 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 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, ligt 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 heeft de waarde 0, omdat Meshy deze terugbetaalt. Annuleren betaalt een taak alleen terug zolang 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.

Downloadlinks voor het modelbestand, met één vermelding voor de door u opgevraagde output.format. {} totdat de taak slaagt.