Creative Lab — Nyckelring-API

Källfoto som Meshy ska färglägga till en nyckelrings-klar konceptbild. 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 offentliga 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.

Detta märker tasken i din instrumentpanel och tasklistor. Det graveras inte in på nyckelringen — använd name_text för det.

Text att gravera in på nyckelringen, till exempel ett husdjurs eller en persons namn. Max 10 tecken, räknat som Unicode-tecken snarare än byte, så ett 10-tecken långt kinesiskt, japanskt eller koreanskt namn godkänns. Utelämna det för att skapa en nyckelring utan gravyr.

Omgivande blanksteg trimmas bort och osynliga formateringstecken tas bort innan texten används. Det resulterande värdet returneras som name_text på prototyptask-objektet, så att du kan bekräfta exakt vad som kommer att graveras innan du betalar för build-steget.

Graveringen tillämpas här, i prototypsteget. Build-steget ärver den automatiskt och accepterar inte en egen name_text.

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

Detta styr endast bilden som denna endpoint returnerar. Det är separat från byggalternativet med samma namn (standard true), som styr bakgrundsborttagning innan reliefering.

Begäran var oacceptabel. 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 intervallet: Bilden är för liten, överskrider maximal filstorlek eller överskrider maximalt antal pixlar.
• Onåbar URL: image_url kunde inte laddas ner (404 eller timeout).
• Ogiltig Data URI: Base64-strängen är felaktigt formaterad.
• Gravyr för lång: name_text är längre än 10 tecken. Begäran avvisas i stället för att trunkeras, så du debiteras aldrig för en nyckelring graverad med ett förkortat namn.
• Innehåll flaggat: Den inmatade bilden flaggades av moderation för olämpligt innehåll eller immateriella rättigheter, eller name_text-gravyren flaggades av moderation för olämpligt innehåll. Gravyren granskas endast för olämpligt innehåll — granskning av immateriella rättigheter gäller för bilden.

Autentiseringen misslyckades. Kontrollera din API-nyckel.

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

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 genererat exakt en kandidatbild.

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

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

Konturens siluett för nyckelringsmedaljongen. Tillgängliga värden:

• circle (standard)
• rounded-rect
• hexagon
• shield
• star

Nyckelringens omslutande kvadrats sidlängd, i millimeter. Intervall: (0, 400].

Maximal relieffhöjd ovanför basen, i millimeter. Intervall: [0, 20].

Vertikal förskjutning tillämpad på reliefen före extrudering, i millimeter. Intervall: [0, 20].

Tjocklek på den platta basplattan bakom reliefen, i millimeter. Intervall: [0, 20].

Om medaljongens baksida är förseglad som en sluten yta. Sätt till false för ett öppet skal.

Överföringskurva som mappar djupkartans värden till relieffhöjd. Tillgängliga värden:

• linear (standard)
• gamma
• s-curve

Formparameter för överföringskurvan (endast relevant när relief_curve är gamma). Intervall: (0, 10].

Invertera tolkningen av djupkartan så att mörkare områden blir högre relief.

Utjämningsstyrka tillämpad på djupkartan innan reliefextraktion. Intervall: [0, 10].

Vertikal skalfaktor tillämpad ovanpå relief_height_mm. Intervall: (0, 10].

Lågpassgräns för djupkartans värden; allt under detta klipps till noll. Intervall: [0, 1].

Ta automatiskt bort bakgrunden från prototypens konceptbild innan relief tillämpas.

Skild från prototypparametern med samma namn (standard false), som styr huruvida själva prototypbilden returneras med transparens.

Nätupplösning som används vid export. Intervall: [64, 2048].

Artefaktpaket som returneras av bygget. Tillgängliga värden:

• glb (standard) — returnerar en enda model.glb under model_urls.glb.
• obj — zippar model.obj + model.mtl + texture.png och returnerar paketet under model_urls.obj.
• zip — zippar varje artefakt som generatorn skapar och returnerar paketet under model_urls.bundle_zip.

Förfrågan var oacceptabel. Vanliga orsaker:

• Saknad parameter: input_task_id krävs.
• Ogiltig UUID: input_task_id är inte en giltig UUID.
• Överordnad ej lyckad: Den refererade prototyp-uppgiften har ännu inte nått SUCCEEDED.
• Ingen kandidat: Prototyp-uppgiften lyckades men producerade ingen kandidatbild.
• Alternativ utanför intervall: Ett av options-fälten låg utanför sitt tillåtna intervall eller enum-uppsättning.

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 build).

Du har överskridit din hastighetsgräns.

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

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

Uppgiften är redan i 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 den nyckelringsuppgift som ska streamas.

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

Sidnummer för paginering.

Gräns för sidstorlek. Maximalt tillåtet är 100 objekt.

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

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

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

Uppgiftens typ. Värdet är creative-lab-keychain-prototype.

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

Graveringen som applicerats på denna nyckelring, efter trimning och borttagning av osynliga formateringstecken. Saknas när uppgiften skapades utan name_text. Jämför den med det du skickade för att bekräfta att texten överlevde din HTTP-klients kodning.

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

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. 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 koncept-bildkandidater 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 visa flera kandidater utan att bryta bakåtkompatibiliteten.

Unik identifierare för tasken.

Taskens typ. Värdet är creative-lab-keychain-build.

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

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

Taskens progress. Om tasken ännu inte har startats är denna egenskap 0. När tasken har lyckats blir den 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 slutfördes, i millisekunder.

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

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

Felinformation 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).

Nedladdningsbara URL:er för den genererade artefakten, nyckelsatta efter artefaktnamn. Innehåller alltid exakt en post — formatet som begärdes via byggförfrågans output.format. Nyckeln matchar det begärda formatet: