Creative Lab — Figur-API

Källfoto som Meshy ska stilisera som en chibi-figur. Vi stöder för närvarande formaten .jpg, .jpeg, .png och .webp.

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

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

Valfritt tasknamn för visningsändamål. Max 100 tecken.

När denna sätts till true returneras prototypbilden som en transparent RGBA-PNG med bakgrunden borttagen, så att du kan sätta samman motivet mot vilken bakgrund som helst.

Begäran kunde inte accepteras. 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: Den inmatade bilden flaggades av moderation för NSFW eller immateriella rättigheter.

Autentiseringen misslyckades. Kontrollera din API-nyckel.

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

Du har överskridit din hastighetsgräns.

Task-ID:t för en prototyp-task 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-tasks skapade via webbappen accepteras inte — build-endpointen accepterar endast prototyp-tasks producerade av POST /openapi/creative-lab/figure/v1/prototype och avvisar alla andra källor med 404.

Valfritt task-namn för visningsändamål. Max 100 tecken.

Begäran var inte acceptabel. Vanliga orsaker:

• Saknad parameter: input_task_id krävs.
• Ogiltig UUID: input_task_id är inte ett giltigt UUID.
• Förälder inte lyckad: Den refererade prototyp-tasken har inte nått SUCCEEDED än.
• Ingen kandidat: Prototyp-tasken lyckades men producerade ingen kandidatbild.

Autentisering misslyckades. Kontrollera din API-nyckel.

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

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

Du har överskridit din hastighetsgräns.

Unik identifierare för figuruppgiften som ska hämtas.

Unik identifierare för figuruppgiften som ska avbrytas.

Uppgiften har redan uppnått ett sluttillstånd och kan inte avbrytas.

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

Unik identifierare för figuruppgiften som ska strömmas.

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 ett k-sorterbart UUID för uppgifts-id som implementationsdetalj bör du inte göra några antaganden om id:ts format.

Typ av uppgift. Värdet är creative-lab-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 kommer denna egenskap att vara 0. Så snart 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 kommer denna egenskap att vara 0.

Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften ännu inte är avslutad kommer denna egenskap att vara 0.

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 uppgifter med status FAILED (credits återbetalas vid misslyckande).

Nedladdningsbara URL:er för de konceptbildkandidater som genererats av denna prototypuppgift. För närvarande returnerar API:et alltid exakt en kandidat; fältet är en array så att framtida revisioner kan visa flera kandidater utan en bakåtkompatibilitetsbrytande ändring.

Unik identifierare för tasken.

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

Tasknamnet som angavs när tasken skapades. Tom sträng om inget namn angavs.

Status för tasken. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress för tasken. Om tasken inte har startats ännu är detta värde 0. När tasken har lyckats blir detta 100.

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

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

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

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

Antalet föregående tasks. Endast meningsfullt när status är PENDING.

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

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

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

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

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

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

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

Nedladdningsbar URL till miniatyrbilden av modellfilen.

En array med textur-URL-objekt som genererats av denna task. Innehåller för närvarande ett enda objekt med basfärgskartan.