Creative Lab — Brick Figure API

Källfoto som Meshy ska stilisera som en tegelstensfigur (minifigure). Vi stöder för närvarande formaten .jpg, .jpeg, .png och .webp.

Maximal filstorlek: 20 MB.

Det finns två sätt att tillhandahålla bilden:

• Offentligt tillgänglig URL: En URL som är tillgänglig från det publika internet.
• Data URI: En base64-kodad data-URI av bilden. Exempel på en data-URI: data:image/jpeg;base64,<din base64-kodade bilddata>.

Valfritt uppgiftsnamn för visningsändamål. Maximalt 100 tecken.

När detta sätts till true returneras prototypbilden som en transparent RGBA-PNG med bakgrunden borttagen, så att du kan sammanfoga motivet mot valfri bakgrund.

Begäran var inte godtagbar. Vanliga orsaker:

• Saknad parameter: image_url krävs.
• Ogiltigt bildformat: Den angivna image_url har inte ett format som stöds (.jpg, .jpeg, .png, .webp).
• Bilddimensioner utanför tillåtet intervall: Bilden är för liten, överskrider den maximala filstorleken eller överskrider det maximala antalet pixlar.
• Onåbar URL: image_url kunde inte laddas ner (404 eller timeout).
• Ogiltig Data URI: Base64-strängen är felaktigt formaterad.
• Innehåll flaggat: Inmatningsbilden flaggades av NSFW-moderation.

Autentisering misslyckades. Kontrollera din API-nyckel.

Otillräckligt med credits för att utföra denna uppgift.

Inmatningsbilden flaggades för intrång i immateriella rättigheter.

Du har överskridit din hastighetsgräns.

Uppgifts-ID för en prototyp-uppgift skapad via samma OpenAPI-endpoint. Prototypen måste ha skapats med samma API-nyckel, måste ha nått SUCCEEDED, och måste ha producerat exakt en kandidatbild.

Prototyp-uppgifter skapade via webbappen accepteras inte — build-endpointen accepterar endast prototyp-uppgifter som producerats av POST /openapi/creative-lab/brick-figure/v1/prototype och avvisar alla andra källor med 404.

Valfritt uppgiftsnamn för visningsändamål. Maximalt 100 tecken.

Begäran kunde inte godtas. Vanliga orsaker:

• Saknad parameter: input_task_id krävs.
• Ogiltig UUID: input_task_id är inte en giltig UUID.
• Överordnad har inte lyckats: Den refererade prototyp-uppgiften har ännu inte nått SUCCEEDED.
• Ingen kandidat: Prototyp-uppgiften lyckades men producerade ingen kandidatbild.

Autentiseringen misslyckades. Kontrollera din API-nyckel.

Otillräckliga credits för att utföra denna uppgift.

Den refererade prototyp-uppgiften finns inte, tillhör en annan användare eller skapades via webbappen (endast prototyp-uppgifter i API-mode kan kedjas till en byggnadsuppgift).

Du har överskridit din hastighetsgräns.

Unik identifierare för brick figure-uppgiften som ska hämtas.

Unik identifierare för den brick figure-uppgift som ska avbrytas.

Uppgiften befinner sig redan i ett slutgiltigt tillstånd och kan inte avbrytas.

Uppgiften finns inte, tillhör en annan användare, eller dess fas matchar inte URL-sökvägen.

Unik identifierare för den brick figure-uppgift som ska streamas.

Antingen prototype eller build. Samlingen returnerar endast uppgifter vars steg matchar URL:en — att hämta /prototype returnerar aldrig build-uppgifter och vice versa.

Sidnummer för paginering.

Sidstorleksgräns. Maximalt tillåtet är 100 objekt.

Fält att sortera efter. Tillgängliga värden:

• +created_at: Sortera efter skapelsetid i stigande ordning.
• -created_at: Sortera efter skapelsetid i fallande ordning.

Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-id som implementationsdetalj bör du inte göra några antaganden om id:ts format.

Uppgiftens typ. Värdet är creative-lab-brick-figure-prototype.

Uppgiftens namn som angavs när uppgiften skapades. Tom sträng om inget namn angavs.

Uppgiftens status. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Uppgiftens progress. Om uppgiften ännu inte har startat är denna egenskap 0. När uppgiften har lyckats blir den 100.

Tidsstämpel för när uppgiften skapades, i millisekunder.

Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften ännu inte har startat är denna egenskap null.

Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften ännu inte är avslutad är denna egenskap null.

Tidsstämpel för när uppgiftens resultat upphör att gälla, i millisekunder.

Antalet föregående uppgifter.

Feldetaljer för misslyckade uppgifter. Se Fel för den fullständiga referensen för objektet task_error.

Antalet credits som förbrukats av denna uppgift. Finns när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).

Nedladdningsbara URL:er för de konceptbildskandidater som genererats av denna prototyp-uppgift. För närvarande returnerar API:et alltid exakt en kandidat; fältet är en array så att framtida revisioner kan tillhandahålla flera kandidater utan en brytande ändring.

Unik identifierare för uppgiften.

Typ av uppgift. Värdet är creative-lab-brick-figure-build.

Uppgiftens namn som angavs när uppgiften skapades. Tom sträng om inget namn angavs.

Uppgiftens status. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Uppgiftens progress. Om uppgiften inte har startat ännu kommer denna egenskap att vara 0. När uppgiften har lyckats blir den 100.

Tidsstämpel för när uppgiften skapades, i millisekunder.

Tidsstämpel för när uppgiften startades, i millisekunder.

Tidsstämpel för när uppgiften avslutades, i millisekunder.

Tidsstämpel för när uppgiftens resultat upphör att gälla, i millisekunder.

Antalet föregående uppgifter. Meningsfullt endast när status är PENDING.

Felinformation för misslyckade uppgifter. Se Fel för den fullständiga referensen till task_error-objektet.

Antalet credits som förbrukats av denna uppgift. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).

Alltid tom för brick figure build. Finns för kompatibilitet mellan endpoints med den delade V2ImageTo3DTaskResponse-formen som används av Bild till 3D.

Alltid tom för brick figure build. Finns för kompatibilitet mellan endpoints.

Alltid tom för brick figure build. Finns för kompatibilitet mellan endpoints.

Alltid tom för brick figure build. Finns för kompatibilitet mellan endpoints.

Nedladdningsbara URL:er för den genererade 3D-modellen. Brick figure build genererar en texturerad GLB samt OBJ + MTL-paret för pipelines som föredrar Wavefront OBJ. Fältets form matchar Image to 3D model_urls-objektet så att framtida formattillägg passar in utan en brytande förändring.

Nedladdningsbar URL till miniatyrbilden för modellfilen.

En array med textur-URL-objekt som genererats av denna uppgift. Innehåller för närvarande ett enda objekt med baskarga (base color map).