Creative Lab Keycap API

Fotot som ska omvandlas till en keycap-design, som en offentlig URL eller en data-URI (data:image/jpeg;base64,<your base64-encoded image data>).

Bilden måste vara en JPG-, JPEG-, PNG- eller WebP-fil på max 20 MB (20 000 000 byte). Varje sida måste vara minst 32 pixlar, och bilden kan ha totalt högst 178 956 970 pixlar. En bild utanför dessa gränser returnerar 400.

Meshy identifierar formatet utifrån bilddatan, inte utifrån filändelsen i URL:en. En URL utan filändelse fungerar, och Meshy följer HTTP-omdirigeringar. Meshy tillämpar EXIF-orienteringen, så ett roterat mobilfoto kommer ut så som det ser ut.

En data-URI måste vara base64-kodad med en bildtyp, till exempel data:image/png;base64,..., och den avkodade bilden måste vara JPEG, PNG eller WebP. 20 MB-gränsen gäller för den avkodade bilden, så base64-texten kan vara ungefär en tredjedel större.

Ett namn för tasken, upp till 100 tecken. Det returneras i taskens fält name. Ett längre namn returnerar 400.

Om bakgrunden ska tas bort från prototypbilden. true returnerar en transparent RGBA-PNG, så att du kan placera keycappen mot vilken bakgrund som helst. Om Meshy inte kan ta bort bakgrunden returneras bilden med sin bakgrund, och tasken lyckas ändå.

Huvuddesignen som bygget omvandlar till 3D behåller sin bakgrund oavsett. Bygget målar keycap-basen utifrån bilden i image_urls, utan dess bakgrund om du skickade true. Bygget returnerar den bilden som process_image_urls.composite.

Förfrågan kan inte köras. Till exempel:

• image_url saknas.
• Bilden är inte en JPG-, JPEG-, PNG- eller WebP-fil.
• Bilden är för liten, över 20 MB, eller över det maximala antalet pixlar.
• Meshy kan inte ladda ner bilden, till exempel för att URL:en returnerar 404 eller tidsgränsen överskrids.
• Data-URI:n är inte giltig base64.
• Bilden flaggades som NSFW.

Felmeddelandet anger vilket problem som hittades. Åtgärda förfrågan och skicka den igen.

API-nyckeln saknas eller är ogiltig. Kontrollera headern Authorization.

Något av följande gäller:

• Kontot har inte tillräckligt med credits.
• API-nyckeln, arbetsytan eller medlemmen har nått sin creditgräns.
• Kontot har en gratisplan.

Kontrollera dina credits och din plan, och försök igen.

Ditt team har IP Filtering aktiverat, och Meshy har flaggat bilden för tredjeparts immateriella rättigheter. Skicka en bild som du har rätt att använda.

Någon av dessa gränser nåddes:

• Du skickade fler förfrågningar än vad din hastighetsgräns tillåter. Vänta några sekunder och försök igen. Se Hastighetsgränser.
• För många av dina tasks köar eller körs. Vänta tills några är klara och försök igen.
• På en obegränsad plan utan credits kvar har du nått antalet tasks som kan köras utan credits. Vänta tills en task är klar, eller lägg till credits.

Meshy stötte på ett serverfel, till exempel för att innehållsmoderering eller kontrollen av immateriella rättigheter inte kunde köras, eller för att Meshy inte kunde lagra bilden. Meshy skapar inte tasken, och återbetalar eventuella credits som debiterades. Försök igen med förfrågan.

ID:t för den prototyp-uppgift som ska byggas. Det måste vara en uppgift som ditt konto skapade med POST /openapi/creative-lab/keycap/v1/prototype, med statusen SUCCEEDED.

Ett ID som inte är en av dina Keycap-prototypuppgifter från API:et returnerar 404, inklusive en prototyp skapad i webbappen.

Kandidaten som ska byggas, från prototyp-uppgiftens array candidate_ids. Ett värde som inte finns i den arrayen returnerar 400.

Ett namn för uppgiften, upp till 100 tecken. Det returneras i uppgiftens fält name. Ett längre namn returnerar 400.

Keycap-basen att bygga på. Det enda värdet är cherry-mx-1x1-r1, en standard Cherry MX-profil 1u keycap. Anpassade storlekar stöds inte, och alla andra värden returnerar 400.

Storleken på huvudet längs dess längsta dimension, i millimeter, från 10 till 40. Meshy skalar huvudet så att dess längsta dimension matchar detta värde. Ett värde utanför intervallet returnerar 400.

För ett värde över ungefär 32.9 kan Meshy minska storleken så att huvudet passar basens skyddande fotavtrycksgräns. Huvudet kan då bli mindre än du begärde. Uppgiftsobjektet returnerar inte den storlek som Meshy tillämpade. För att kontrollera den, mät begränsningsrutan för keycap-head-nätet i modellen.

Den vertikala förskjutning som ska tillämpas på huvudet innan Meshy placerar det på basen, i millimeter, från -5 till 5. Ett värde utanför intervallet returnerar 400.

Begäran kan inte köras. Till exempel:

• input_task_id saknas eller är inte ett giltigt uppgifts-ID.
• Prototyp-uppgiftens status är inte SUCCEEDED. Om den fortfarande körs, vänta och försök igen. Om den misslyckades eller avbröts, skapa en ny prototyp-uppgift.
• Prototyp-uppgiften lyckades men saknar kandidater. Skapa en ny prototyp-uppgift.
• candidate_id saknas, eller finns inte i prototyp-uppgiftens candidate_ids. Skicka ett värde från den arrayen.
• Ett fält i options är utanför intervallet, eller base_model är inte ett tillgängligt värde.

Felmeddelandet anger vilket problem det hittade.

API-nyckeln saknas eller är ogiltig. Kontrollera Authorization-huvudet.

Ett av följande gäller:

• Kontot har inte tillräckligt med credits.
• API-nyckeln, arbetsytan eller medlemmen nådde sin creditgräns.
• Kontot har en gratisplan.

Kontrollera dina credits och din plan, och försök igen.

input_task_id matchar ingen Keycap-prototypuppgift som ditt konto skapade med API:et. En prototyp skapad i webbappen returnerar också 404. Skicka result-ID:t från ett svar vid skapande av prototyp.

En av dessa gränser nåddes:

• Du skickade fler förfrågningar än din hastighetsgräns tillåter. Vänta några sekunder och försök igen. Se Rate limits.
• För många av dina uppgifter är köade eller körs. Vänta tills några är klara och försök igen.
• På en obegränsad plan utan kvarvarande credits har du nått antalet uppgifter som kan köras utan credits. Vänta tills en uppgift är klar, eller lägg till credits.

Meshy kunde inte skapa uppgiften på grund av ett serverfel. Meshy återbetalar eventuella credits som debiterades. Försök igen med begäran.

Uppgifts-ID:t från skaparsvaret.

id är inte ett giltigt uppgifts-ID. Skicka result-ID:t från skaparsvaret.

Ditt team har IP Filtering aktiverat, och Meshy har flaggat prototypuppgiftens bild för tredjeparts immateriella rättigheter. Byggsuppgifter och team på Enterprise-planen får inte detta fel. Skapa en prototypuppgift från en bild du har rättigheter att använda.

Ingen Keycap-uppgift med detta ID tillhör ditt konto, eller så matchar inte uppgiftens steg sökvägen. Kontrollera ID:t, och använd /prototype eller /build för att matcha uppgiften.

Meshy kunde inte köra kontrollen av immateriella rättigheter. Försök igen med förfrågan.

ID:t för uppgiften som ska avbrytas.

Något av följande gäller:

• id är inte ett giltigt uppgifts-ID. Skicka result-ID:t från skapandesvaret.
• Uppgiften har redan en slutgiltig status (SUCCEEDED, FAILED eller CANCELED), så den kan inte avbrytas.

Ingen Keycap-uppgift med detta ID tillhör ditt konto, eller så matchar inte uppgiftens steg sökvägen. Kontrollera ID:t och använd /prototype eller /build för att matcha uppgiften.

Meshy stötte på ett serverfel vid avbrytandet av uppgiften, så uppgiften kan ha avbrutits eller inte. Hämta uppgiften för att kontrollera dess status innan du försöker igen.

Uppgiftens ID från create-svaret.

Steget som ska listas, prototype eller build.

Sidan som ska returneras, från 1 till 255. 0 returnerar den första sidan. Ett värde utanför 0 till 255 returnerar 400.

Antal uppgifter per sida, upp till 100. Ett värde från 101 till 255 returnerar 100 uppgifter, och 0 använder standardvärdet. Ett värde utanför 0 till 255 returnerar 400.

Sorteringsordningen.

Tillgängliga värden:

• -created_at: nyaste först
• +created_at: äldsta först

Uppgiftens ID. Förlita dig inte på dess format.

Uppgiftstypen, alltid creative-lab-keycap-prototype.

Det name du skickade när du skapade uppgiften, eller "" om du inte skickade något.

Uppgiftens status.

Tillgängliga värden:

• PENDING: väntar i kön
• IN_PROGRESS: genererar resultatet
• SUCCEEDED: slutgiltig, med resultatet
• FAILED: slutgiltig, med orsaken i task_error
• CANCELED: slutgiltig, utan resultat

Procentandel av arbetet som är klart, från 0 till 100. Det är 0 tills uppgiften startar och 100 när den lyckas.

Tidpunkten då uppgiften skapades, i Unix-millisekunder.

Tidpunkten då en arbetare startade uppgiften, i Unix-millisekunder. null fram tills dess.

Tidpunkten då uppgiften nådde en slutgiltig status, i Unix-millisekunder. null fram tills dess.

Tidpunkten då uppgiftens resultat upphör att gälla, i Unix-millisekunder. Det är 3 dagar efter finished_at, eller 3 dagar efter created_at tills uppgiften är klar. För Enterprise-konton, som behåller API-resultat på obestämd tid, är det omkring 100 år senare. Se Tillgångslagring.

Uppgiftens position i kön medan den är PENDING. 1 betyder att den startar härnäst. 0 efter att uppgiften lämnat kön, och alltid 0 i listresultat.

Varför uppgiften misslyckades. null om inte status är FAILED. Se Fel.

Antal credits som debiterades för uppgiften, efter eventuell återbetalning. En begäran som returnerar ett fel debiteras inte. En misslyckad uppgift är 0, eftersom Meshy återbetalar den. Avbrytning återbetalar en uppgift endast medan den är PENDING. Om Meshy inte kan läsa debiteringen utelämnar ett get- eller stream-svar fältet, och en listbegäran returnerar 500. Försök i så fall igen med begäran.

Nedladdnings-URL:er för bilden av den färdiga keycap. Arrayen har en URL efter att uppgiften lyckats, och är tom fram tills dess. image_urls[i] visar kandidaten i candidate_ids[i].

Dessa URL:er är för visning. Build-endpointen tar en post från candidate_ids, inte en URL. De är signerade URL:er, så hämta dem utan en Authorization-header. De förblir giltiga fram till expires_at, och att hämta uppgiften igen returnerar samma URL:er.

ID:n för kandidaterna, i samma ordning som image_urls. För att bygga en kandidat, skicka dess ID som candidate_id i build-begäran. Förlita dig inte på formatet av dessa ID:n.

Uppgiftens ID. Förlita dig inte på dess format.

Uppgiftstypen, alltid creative-lab-keycap-build.

Det name du skickade när du skapade uppgiften, eller "" om du inte skickade något.

Uppgiftens status.

Tillgängliga värden:

• PENDING: väntar i kön
• IN_PROGRESS: genererar resultatet
• SUCCEEDED: slutgiltig, med resultatet
• FAILED: slutgiltig, med anledningen i task_error
• CANCELED: slutgiltig, utan resultat

Procent av arbetet som är klart, från 0 till 100. Det är 0 tills uppgiften startar och 100 när den lyckas.

Tidpunkt då uppgiften skapades, i Unix-millisekunder.

Tidpunkt då en arbetare startade uppgiften, i Unix-millisekunder. null fram tills dess.

Tidpunkt då uppgiften nådde en slutgiltig status, i Unix-millisekunder. null fram tills dess.

Tidpunkt då uppgiftens resultat löper ut, i Unix-millisekunder. Det är 3 dagar efter finished_at, eller 3 dagar efter created_at tills uppgiften är klar. För Enterprise-konton, som behåller API-resultat på obestämd tid, är det ungefär 100 år senare. Se Tillgångslagring.

Uppgiftens position i kön medan den är PENDING. 1 betyder att den startar härnäst. 0 efter att uppgiften lämnar kön, och alltid 0 i listresultat.

Varför uppgiften misslyckades. null om inte status är FAILED. Se Fel.

Antal credits som debiterats för uppgiften, efter eventuell återbetalning. En begäran som returnerar ett fel debiteras inte. En misslyckad uppgift är 0, eftersom Meshy återbetalar den. Avbrytning återbetalar en uppgift endast medan den är PENDING. Om Meshy inte kan läsa debiteringen utelämnar ett get- eller stream-svar fältet, och en listbegäran returnerar 500. Försök i så fall igen med begäran.

Nedladdnings-URL:er för 3D-modellen. Meshy exporterar GLB-filen och OBJ-paketet i verklig skala i millimeter, Y-upp, med framsidan av keycappen vänd mot +Z.

Modellen har nät som heter keycap-head och keycap-base. När Meshy faller tillbaka på en mönsterfyllning för basen har modellen också ett keycap-base-interior-nät för stammens hålrum. Anta inte att modellen har exakt två nät.

Dessa är signerade URL:er, så hämta dem utan en Authorization-header. De förblir giltiga tills expires_at, och att hämta uppgiften igen innan dess returnerar samma URL:er. En utgången URL kan inte förnyas, så ladda ner och lagra filerna innan dess.

Nedladdnings-URL:er för bilder från build-uppgiftens steg, nyckelade efter typ. Precis som model_urls är de signerade URL:er, så hämta dem utan en Authorization-header. De förblir giltiga tills expires_at, och att hämta uppgiften igen returnerar samma URL:er.

Den kan ha dessa nycklar:

• head_design: designbilden för den valda kandidaten, som build-uppgiften omvandlade till 3D. Alltid närvarande.
• composite: bilden av den färdiga keycappen för den valda kandidaten, som build-uppgiften målade basen utifrån. Kan saknas.
• base_canvas: den målade keycap-basen. Kan saknas.

Meshy kan lägga till nycklar, så ignorera en nyckel du inte känner igen.