Creative Lab Figure API

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

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 geeft 400 terug.

Of de achtergrond uit de prototypeafbeelding verwijderd moet worden. true geeft een transparante RGBA-PNG terug, zodat je het onderwerp op elke achtergrond kunt plaatsen. De build begint dan ook met de afbeelding zonder achtergrond. Als Meshy de achtergrond niet kan verwijderen, geeft het de afbeelding mét 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 er is gevonden. Pas het verzoek aan en stuur het opnieuw.

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

Een van de volgende situaties is van toepassing:

• 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 vanwege intellectueel eigendom van derden. Stuur een afbeelding waarvoor je de rechten 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.
• Er staan te veel van je taken in de wachtrij of lopen al. Wacht tot sommige klaar zijn en probeer het opnieuw.
• Bij een onbeperkt abonnement zonder resterende credits heb je het aantal taken bereikt dat zonder credits kan draaien. Wacht tot een taak klaar is, of voeg credits toe.

Meshy is gestuit op een serverfout, bijvoorbeeld omdat de controle op intellectueel eigendom van 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 gebuild moet worden. Dit moet een taak zijn die uw account heeft aangemaakt met POST /openapi/creative-lab/figure/v1/prototype, met status SUCCEEDED.

Een ID die niet een van uw Figure-prototypetaken uit de API is, geeft 404 terug, ook voor een prototype dat in de web-app is gemaakt.

Een naam voor de taak, maximaal 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:

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

Het foutbericht geeft aan welk probleem er is gevonden.

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

Een van de volgende situaties is van toepassing:

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

Controleer uw credits en abonnement en probeer het opnieuw.

input_task_id komt niet overeen met een Figure-prototypetaak die uw 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 reactie op het aanmaken van een prototype.

Een van deze limieten is bereikt:

• U hebt meer verzoeken verstuurd dan uw rate limit toestaat. Wacht enkele 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 een aantal zijn afgerond 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 afgerond, 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 wegens intellectueel eigendom van derden. Teams met het Enterprise-plan krijgen deze fout niet. Maak een prototypetaak aan met een afbeelding waarvoor je de rechten hebt.

Er bestaat geen 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 dat overeenkomt 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 de volgende is van toepassing:

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

Er bestaat geen Figure-taak met deze ID in uw 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.

De taak-ID uit het aanmaakantwoord.

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-figure-prototype.

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

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 tot de taak start en 100 zodra 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 voor onbepaalde tijd 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.

Het aantal credits dat voor de taak in rekening is gebracht, na eventuele terugbetaling. Voor een verzoek dat een fout retourneert, worden geen credits in rekening gebracht. Een mislukte taak heeft de waarde 0, omdat Meshy deze terugbetaalt. Annuleren leidt alleen tot terugbetaling van een taak 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 dan toe leeg.

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

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

De name die je hebt meegestuurd 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: 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 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 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 verlaat, en altijd 0 in lijstresultaten.

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

Aantal credits dat in rekening is gebracht voor de taak, 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 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.

Altijd "" voor een Figure build-taak.

Altijd "" voor een Figure build-taak, net als prompt.

Altijd "" voor een Figure build-taak, net als prompt.

Altijd "" voor een Figure build-taak, net als prompt.

Downloadlinks voor het 3D-model, als een getextureerde GLB en als een OBJ-bestand met het bijbehorende MTL-bestand.

Downloadlink voor een voorbeeldafbeelding van het model.

De textuurkaarten, als een array met één object dat de basiskleurenkaart bevat.

Of Meshy lichtaccenten en schaduwen uit de basiskleurtextuur heeft verwijderd.