Creative Lab Brick Figure API

De foto die moet worden omgezet in een brick-minifiguur, als een openbare 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 prototype-afbeelding moet worden verwijderd. true levert een transparante RGBA-PNG op, zodat je het onderwerp op elke achtergrond kunt plaatsen. De build begint eveneens vanuit de afbeelding zonder achtergrond. Als Meshy de achtergrond niet kan verwijderen, geeft het de afbeelding met achtergrond terug en slaagt de taak alsnog.

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 verstuur het opnieuw.

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

Een van de volgende situaties is van toepassing:

• Het account heeft niet genoeg 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.

IP Filtering staat aan voor je team, 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 enkele seconden en probeer het opnieuw. Zie Rate limits.
• Te veel van je taken staan in de wachtrij of lopen al. Wacht tot sommige 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 is op een serverfout gestuit, bijvoorbeeld omdat de intellectueel-eigendomscontrole op 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 prototypetaak die gebouwd moet worden. Het moet een taak zijn die uw account heeft aangemaakt met POST /openapi/creative-lab/brick-figure/v1/prototype, met de status SUCCEEDED.

Een ID die niet een van uw Brick Figure-prototypetaken uit de API is, retourneert 404, 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 retourneert 400.

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 wordt uitgevoerd, wacht en probeer het opnieuw. Als deze mislukt is of geannuleerd werd, maak een nieuwe prototypetaak aan.
• De prototypetaak is geslaagd maar heeft geen afbeelding. Maak een nieuwe prototypetaak aan.

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 Brick Figure-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 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.
• Te veel van uw taken staan in de wachtrij of worden uitgevoerd. Wacht tot sommige klaar zijn en probeer het opnieuw.
• Bij een onbeperkt abonnement zonder resterende credits hebt u het aantal taken bereikt dat zonder credits kan worden uitgevoerd. Wacht tot een taak is voltooid of voeg credits toe.

De taak-ID uit de respons van het aanmaken.

id is geen geldige taak-ID. Stuur de result-ID uit de respons van het aanmaken.

Je team heeft IP Filtering ingeschakeld, en Meshy heeft de afbeelding van de taak gemarkeerd voor intellectueel eigendom van derden. Teams met het Enterprise-plan krijgen deze fout niet. Maak een prototypetaak aan met een afbeelding waarvoor je over de rechten beschikt.

Er bestaat geen Brick Figure-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 intellectueel eigendom niet uitvoeren. Probeer het verzoek opnieuw.

De ID van de te annuleren taak.

Een van het volgende is van toepassing:

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

Er bestaat geen Brick Figure-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 om weer te geven, prototype of build.

De pagina om terug te geven, 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-brick-figure-prototype.

De name die je verstuurde toen je de taak aanmaakte, 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 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 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 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 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 de conceptafbeelding. De array bevat één URL nadat de taak is geslaagd, en is tot die tijd leeg.

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

Het task-type, altijd creative-lab-brick-figure-build.

De name die je verstuurde toen je de task aanmaakte, of "" als je er geen hebt verstuurd.

De status van de task.

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. Het is 0 totdat de task start en 100 wanneer deze slaagt.

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

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

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

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

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

Waarom de task mislukte. null tenzij status gelijk is aan FAILED. Zie Fouten.

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

Altijd "" voor een Brick Figure build task.

Altijd "" voor een Brick Figure build task, net als prompt.

Altijd "" voor een Brick Figure build task, net als prompt.

Altijd "" voor een Brick Figure build task, net als prompt.

Download-URL's voor het 3D-model, als een getextureerde GLB en als een OBJ-bestand met het bijbehorende MTL-bestand.

Download-URL voor een voorbeeldafbeelding van het model.

De texturen, als een array met één object dat de basiskleurmap bevat.