Creative Lab Fidget Pixel API

Fotot som ska omvandlas till pixelkonst, som en offentlig URL eller en data-URI (data:image/jpeg;base64,<dina base64-kodade bilddata>).

Bilden måste vara en JPG-, JPEG-, PNG- eller WebP-fil på högst 20 MB. Meshy identifierar formatet utifrån bilddata, inte utifrån filändelsen i URL:en. En URL utan filändelse fungerar, och Meshy följer omdirigeringar.

Vad fotot visar, vilket avgör pixelkonststilen. De två stilarna ser tydligt olika ut. Alla andra värden returnerar 400.

Tillgängliga värden:

• person: en person, på ett porträtt eller helkroppsfoto. Meshy ritar en pixelfigur i chibi-stil.
• other: alla andra motiv, till exempel ett husdjur, ett föremål, en maskot, en logotyp eller ett landskap. Meshy ritar en pixelikon i pärlkonststil.

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

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

• image_url eller type saknas.
• type är varken person eller other.
• 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 löper ut.
• Data-URI:n är inte giltig base64.
• Bilden flaggades som olämplig (NSFW).

Felmeddelandet anger vilket problem som hittades. Åtgärda begäran och skicka den igen.

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

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 använder den kostnadsfria planen.

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

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

En av följande gränser har nåtts:

• Du har skickat fler förfrågningar än vad din hastighetsgräns tillåter. Vänta några sekunder och försök sedan igen. Se Rate limits.
• För många av dina uppgifter är köade eller pågående. Vänta tills några är klara och försök sedan igen.
• På en plan utan gräns men utan kvarvarande credits har du nått det antal uppgifter som kan köras utan credits. Vänta tills en uppgift är klar, eller lägg till credits.

Meshy stötte på ett serverfel, till exempel för att det inte kunde köra kontrollen av immateriella rättigheter på bilden. Meshy skapar inte uppgiften och återbetalar eventuella credits som debiterats. Försök igen med begäran.

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

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

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

Avtrycket för varje bit. Alla andra värden returnerar 400.

Tillgängliga värden:

• square: fyrkantiga bitar på ett fyrkantigt rutnät
• hex: hexagonala bitar på ett hexagonalt rutnät, med piece_size_mm satt till 6 eller 8

Antalet rutnätsceller längs varje sida av brädet, 16 eller 32. Alla andra värden returnerar 400. Ett 32-rutnät behåller mer detalj. Ett 16-rutnät ger färre bitar av samma storlek, så brädet blir ungefär hälften så brett.

Kantlängden för varje bit i millimeter, 6, 8 eller 10. Alla andra värden returnerar 400. Tillsammans med grid_size bestämmer det storleken på det utskrivna brädet. Till exempel är ett 32-rutnät med 8 mm-bitar ungefär 26,5 cm per sida.

10 fungerar inte med hex och returnerar 400, eftersom den sneda hexagonala ytan hänger ut på de flesta konsumentens FDM-skrivare.

Det maximala antalet färger i pixelbildspaletten, från 1 till 8. Ett värde utanför intervallet returnerar 400. För att skriva ut behöver du upp till color_count plus ett filament, ett per färg och ett för de grå kropparna.

Höjden på varje bit i millimeter, från 10 till 80. Ett värde utanför intervallet returnerar 400.

Filformatet för resultatet. Alla andra värden returnerar 400.

Tillgängliga värden:

• 3mf: en flerfärgad model.3mf-fil, returneras i model_urls.3mf

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 bild. Skapa en ny prototyp-uppgift.
• Ett options-fält ligger utanför sina tillåtna värden, till exempel ett grid_size som inte är 16 eller 32.
• piece_size_mm är 10 och shape är hex. Hexagonala bitar finns bara i 6 och 8 mm.
• output.format är inte 3mf.

Felmeddelandet anger vilket problem det hittade.

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

Något av följande gäller:

• Kontot har inte tillräckligt med credits.
• API-nyckeln, arbetsytan eller medlemmen nådde sin credit-gräns.
• Kontot har den kostnadsfria planen.

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

Ditt team har IP Filtering aktiverat, och Meshy flaggade prototyp-uppgiftens bild för tredjepartsimmateriell egendom. Skapa en prototyp-uppgift från en bild du har rättigheter att använda.

input_task_id matchar ingen Fidget Pixel-prototypuppgift som ditt konto skapat med API:et. En prototyp gjord i webbappen returnerar också 404. Skicka result-ID:t från ett svar på skapandet av en 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 sedan igen.
• På en obegränsad plan utan credits kvar nådde du antalet uppgifter som kan köras utan credits. Vänta tills en uppgift är klar, eller lägg till credits.

Meshy stötte på ett serverfel, till exempel för att det inte kunde köra immaterialrättskontrollen på prototyp-uppgiftens bild. Meshy skapar inte uppgiften, och återbetalar eventuella credits den debiterade. Försök med begäran igen.

Uppgifts-ID:t från skapandesvaret.

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

Ditt team har IP-filtrering aktiverat, och Meshy flaggade prototypuppgiftens bild för immateriella rättigheter som tillhör tredje part. Byggguppgifter 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 Fidget Pixel-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.

Ett 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 Fidget Pixel-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.

Uppgifts-ID från skapandesvaret.

Stadiet 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

Task-ID:t. Förlita dig inte på dess format.

Tasktypen, alltid creative-lab-fidget-pixel-prototype.

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

Taskens 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 utförts, från 0 till 100. Det är 0 tills tasken startar och 100 när den lyckas.

Tidpunkten då tasken skapades, i Unix-millisekunder.

Tidpunkten då en worker startade tasken, i Unix-millisekunder. null fram till dess.

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

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

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

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

Antal credits som debiterats för tasken, efter eventuell återbetalning. En begäran som returnerar ett fel debiteras inte. En misslyckad task är 0, eftersom Meshy återbetalar den. Att avbryta återbetalar en task 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. I så fall, försök igen med begäran.

Nedladdnings-URL:er för pixelkonstbilden. Arrayen har en URL när tasken har lyckats, och är tom fram till dess.

URL:erna är signerade, så hämta dem utan en Authorization-header. De förblir giltiga fram till expires_at. Att hämta tasken igen innan dess returnerar samma URL:er, inte nyligen signerade sådana. En utgången URL kan inte förnyas, så ladda ner och lagra filerna innan dess.

Task-ID:t. Lita inte på dess format.

Tasktypen, alltid creative-lab-fidget-pixel-build.

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

Taskens 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

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

Tidpunkt då tasken skapades, i Unix-millisekunder.

Tidpunkt då en worker startade tasken, i Unix-millisekunder. null fram till dess.

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

Tidpunkt då taskens resultat upphör att gälla, i Unix-millisekunder. Det är 3 dagar efter finished_at, eller 3 dagar efter created_at tills tasken är klar. För Enterprise-konton, som behåller API-resultat permanent, är det cirka 100 år senare. Se Tillgångslagring.

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

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

Antal credits som debiterats för tasken, efter eventuell återbetalning. En förfrågan som returnerar ett fel debiteras inte. En misslyckad task är 0, eftersom Meshy återbetalar den. Att avbryta återbetalar en task endast medan den är PENDING. Om Meshy inte kan läsa debiteringen utelämnas fältet i ett get- eller stream-svar, och en listförfrågan returnerar 500. Försök i så fall igen med förfrågan.

Nedladdnings-URL:er för resultatet, med filformat som nyckel. Objektet har en post, för det output.format du skickade, och är tomt tills tasken lyckas.

URL:erna är signerade, så hämta dem utan en Authorization-header. De förblir giltiga fram till expires_at. Att hämta tasken igen innan dess returnerar samma URL:er, inte nysignerade sådana. En utgången URL kan inte förnyas, så ladda ner och spara filerna innan dess.