Creative Lab Keycap API

La foto da trasformare in un design di keycap, come URL pubblico o data URI (data:image/jpeg;base64,<i tuoi dati immagine codificati in base64>).

L'immagine deve essere un file JPG, JPEG, PNG o WebP di al massimo 20 MB (20.000.000 byte). Ogni lato deve essere di almeno 32 pixel, e l'immagine può avere al massimo 178.956.970 pixel in totale. Un'immagine al di fuori di questi limiti restituisce 400.

Meshy rileva il formato dai dati dell'immagine, non dall'estensione del file nell'URL. Un URL senza estensione funziona, e Meshy segue i reindirizzamenti HTTP. Meshy applica l'orientamento EXIF, quindi una foto scattata da telefono e ruotata viene visualizzata nel modo in cui appare.

Un data URI deve essere codificato in base64 con un tipo di immagine, come data:image/png;base64,..., e l'immagine decodificata deve essere JPEG, PNG o WebP. Il limite di 20 MB si applica all'immagine decodificata, quindi il testo base64 può essere circa un terzo più grande.

Un nome per l'attività, fino a 100 caratteri. Viene restituito nel campo name dell'attività. Un nome più lungo restituisce 400.

Se rimuovere lo sfondo dall'immagine del prototipo. true restituisce un PNG RGBA trasparente, così puoi posizionare il keycap su qualsiasi sfondo. Se Meshy non riesce a rimuovere lo sfondo, restituisce l'immagine con il suo sfondo, e l'attività comunque riesce.

Il design della testa che la build trasforma in 3D mantiene il suo sfondo in entrambi i casi. La build dipinge la base del keycap a partire dall'immagine in image_urls, senza il suo sfondo se hai inviato true. La build restituisce questa immagine come process_image_urls.composite.

La richiesta non può essere eseguita. Ad esempio:

• image_url è mancante.
• L'immagine non è un file JPG, JPEG, PNG o WebP.
• L'immagine è troppo piccola, supera i 20 MB, o supera il numero massimo di pixel.
• Meshy non riesce a scaricare l'immagine, ad esempio perché l'URL restituisce 404 o va in timeout.
• Il data URI non è un base64 valido.
• L'immagine è stata segnalata come NSFW.

Il messaggio di errore indica quale problema è stato trovato. Correggi la richiesta, quindi inviala di nuovo.

La chiave API è mancante o non valida. Controlla l'header Authorization.

Si applica una delle seguenti condizioni:

• L'account non ha crediti sufficienti.
• La chiave API, lo spazio di lavoro o il membro ha raggiunto il proprio limite di crediti.
• L'account è nel piano gratuito.

Controlla i tuoi crediti e il tuo piano, poi riprova.

Il tuo team ha attivato il filtraggio IP, e Meshy ha segnalato l'immagine per proprietà intellettuale di terzi. Invia un'immagine di cui hai i diritti d'uso.

È stato raggiunto uno dei seguenti limiti:

• Hai inviato più richieste di quante ne consenta il tuo limite di frequenza. Attendi qualche secondo, poi riprova. Vedi Limiti di frequenza.
• Troppe delle tue attività sono in coda o in esecuzione. Attendi che alcune terminino, poi riprova.
• Su un piano illimitato senza crediti residui, hai raggiunto il numero di attività che possono essere eseguite senza crediti. Attendi che un'attività termini, oppure aggiungi crediti.

Meshy ha riscontrato un errore del server, ad esempio perché la moderazione dei contenuti o il controllo della proprietà intellettuale non è riuscito a essere eseguito, oppure Meshy non è riuscito a memorizzare l'immagine. Meshy non crea l'attività, e rimborsa eventuali crediti addebitati. Riprova la richiesta.

L'ID dell'attività di prototipo da costruire. Deve essere un'attività creata dal tuo account con POST /openapi/creative-lab/keycap/v1/prototype, con stato SUCCEEDED.

Un ID che non corrisponde a una delle tue attività di prototipo Keycap create tramite l'API restituisce 404, incluso un prototipo creato nell'app web.

Il candidato da costruire, dall'array candidate_ids dell'attività di prototipo. Un valore che non è presente in quell'array restituisce 400.

Un nome per l'attività, fino a 100 caratteri. Viene restituito nel campo name dell'attività. Un nome più lungo restituisce 400.

La base del keycap su cui costruire. L'unico valore è cherry-mx-1x1-r1, un keycap standard con profilo Cherry MX 1u. Le dimensioni personalizzate non sono supportate, e qualsiasi altro valore restituisce 400.

La dimensione della testa lungo la sua dimensione più lunga, in millimetri, da 10 a 40. Meshy ridimensiona la testa in modo che la sua dimensione più lunga corrisponda a questo valore. Un valore fuori dall'intervallo restituisce 400.

Per un valore superiore a circa 32.9, Meshy potrebbe ridurre la dimensione affinché la testa rientri nel limite dell'ingombro protettivo della base. In tal caso la testa potrebbe risultare più piccola di quanto richiesto. L'oggetto attività non restituisce la dimensione applicata da Meshy. Per verificarla, misura la bounding box della mesh keycap-head nel modello.

Lo spostamento verticale da applicare alla testa prima che Meshy la posizioni sulla base, in millimetri, da -5 a 5. Un valore fuori dall'intervallo restituisce 400.

La richiesta non può essere eseguita. Ad esempio:

• input_task_id è mancante o non è un ID attività valido.
• Lo stato dell'attività di prototipo non è SUCCEEDED. Se è ancora in esecuzione, attendi e riprova. Se è fallita o è stata annullata, crea una nuova attività di prototipo.
• L'attività di prototipo è riuscita ma non ha candidati. Crea una nuova attività di prototipo.
• candidate_id è mancante, oppure non è presente in candidate_ids dell'attività di prototipo. Invia un valore da quell'array.
• Un campo in options è fuori dall'intervallo consentito, oppure base_model non è un valore disponibile.

Il messaggio di errore indica quale problema ha riscontrato.

La chiave API è mancante o non valida. Controlla l'header Authorization.

Si applica una di queste condizioni:

• L'account non ha crediti sufficienti.
• La chiave API, lo spazio di lavoro o il membro ha raggiunto il proprio limite di crediti.
• L'account è nel piano gratuito.

Controlla i tuoi crediti e il tuo piano, poi riprova.

input_task_id non corrisponde a nessuna attività di prototipo Keycap creata dal tuo account tramite l'API. Anche un prototipo creato nell'app web restituisce 404. Invia l'ID result ottenuto dalla risposta di creazione del prototipo.

È stato raggiunto uno di questi limiti:

• Hai inviato più richieste di quante ne consenta il tuo limite di frequenza. Attendi qualche secondo, poi riprova. Vedi Limiti di frequenza.
• Troppe delle tue attività sono in coda o in esecuzione. Attendi che alcune si completino, poi riprova.
• Con un piano illimitato senza crediti residui, hai raggiunto il numero di attività eseguibili senza crediti. Attendi che un'attività si completi, oppure aggiungi crediti.

Meshy non è riuscita a creare l'attività a causa di un errore del server. Meshy rimborsa eventuali crediti addebitati. Riprova la richiesta.

L'ID del task dalla risposta di creazione.

id non è un ID di task valido. Invia l'ID result dalla risposta di creazione.

Il tuo team ha il Filtraggio IP attivato, e Meshy ha segnalato l'immagine del task di prototipo per proprietà intellettuale di terzi. I task di build e i team con piano Enterprise non ricevono questo errore. Crea un task di prototipo a partire da un'immagine di cui hai i diritti d'uso.

Nessun task Keycap con questo ID appartiene al tuo account, oppure lo stage del task non corrisponde al percorso. Controlla l'ID e usa /prototype o /build in base al task.

Meshy non è riuscito a eseguire il controllo sulla proprietà intellettuale. Riprova la richiesta.

L'ID del task da annullare.

Si applica uno dei seguenti casi:

• id non è un ID di task valido. Invia l'ID result restituito dalla risposta di creazione.
• Il task ha già uno stato finale (SUCCEEDED, FAILED o CANCELED), quindi non può essere annullato.

Nessun task Keycap con questo ID appartiene al tuo account, oppure la fase del task non corrisponde al percorso. Controlla l'ID e usa /prototype o /build per far corrispondere il task.

Meshy ha riscontrato un errore del server durante l'annullamento del task, quindi il task potrebbe essere stato annullato oppure no. Recupera il task per controllare il suo status prima di riprovare.

L'ID del task dalla risposta di creazione.

La fase da elencare, prototype o build.

La pagina da restituire, da 1 a 255. 0 restituisce la prima pagina. Un valore al di fuori dell'intervallo 0-255 restituisce 400.

Numero di task per pagina, fino a 100. Un valore da 101 a 255 restituisce 100 task, mentre 0 utilizza il valore predefinito. Un valore al di fuori dell'intervallo 0-255 restituisce 400.

L'ordine di ordinamento.

Valori disponibili:

• -created_at: prima i più recenti
• +created_at: prima i più vecchi

L'ID del task. Non fare affidamento sul suo formato.

Il tipo di task, sempre creative-lab-keycap-prototype.

Il name inviato durante la creazione del task, oppure "" se non ne è stato inviato uno.

Lo stato del task.

Valori disponibili:

• PENDING: in attesa nella coda
• IN_PROGRESS: generazione del risultato in corso
• SUCCEEDED: finale, con il risultato
• FAILED: finale, con il motivo in task_error
• CANCELED: finale, senza risultato

Percentuale del lavoro completato, da 0 a 100. È 0 finché il task non inizia e 100 quando ha successo.

Momento in cui il task è stato creato, in millisecondi Unix.

Momento in cui un worker ha avviato il task, in millisecondi Unix. null fino ad allora.

Momento in cui il task ha raggiunto uno stato finale, in millisecondi Unix. null fino ad allora.

Momento in cui il risultato del task scade, in millisecondi Unix. Corrisponde a 3 giorni dopo finished_at, oppure a 3 giorni dopo created_at finché il task non termina. Per gli account Enterprise, che conservano i risultati API a tempo indeterminato, corrisponde a circa 100 anni dopo. Vedi Conservazione degli asset.

La posizione del task nella coda mentre è PENDING. 1 significa che inizierà come prossimo. 0 dopo che il task esce dalla coda, e sempre 0 nei risultati di elenco.

Il motivo per cui il task è fallito. null a meno che status non sia FAILED. Vedi Errori.

Numero di crediti addebitati per il task, dopo eventuali rimborsi. Una richiesta che restituisce un errore non viene addebitata. Un task fallito è 0, perché Meshy lo rimborsa. L'annullamento rimborsa un task solo mentre è PENDING. Se Meshy non riesce a leggere l'addebito, una risposta get o stream omette il campo, e una richiesta di elenco restituisce 500. In tal caso, riprova la richiesta.

URL di download per l'immagine del keycap finito. L'array contiene un URL dopo che il task ha successo, ed è vuoto fino ad allora. image_urls[i] mostra il candidato in candidate_ids[i].

Questi URL sono destinati alla visualizzazione. L'endpoint di build accetta una voce da candidate_ids, non un URL. Sono URL firmati, quindi recuperali senza un header Authorization. Restano validi fino a expires_at, e recuperare nuovamente il task restituisce gli stessi URL.

ID dei candidati, nello stesso ordine di image_urls. Per generare un candidato, invia il suo ID come candidate_id nella richiesta di build. Non fare affidamento sul formato di questi ID.

L'ID del task. Non fare affidamento sul suo formato.

Il tipo di task, sempre creative-lab-keycap-build.

Il name che hai inviato quando hai creato il task, oppure "" se non ne hai inviato uno.

Lo stato del task.

Valori disponibili:

• PENDING: in attesa nella coda
• IN_PROGRESS: generazione del risultato in corso
• SUCCEEDED: definitivo, con il risultato
• FAILED: definitivo, con il motivo in task_error
• CANCELED: definitivo, senza risultato

Percentuale di lavoro completato, da 0 a 100. È 0 finché il task non inizia e 100 quando ha esito positivo.

Momento in cui il task è stato creato, in millisecondi Unix.

Momento in cui un worker ha avviato il task, in millisecondi Unix. null fino ad allora.

Momento in cui il task ha raggiunto uno stato definitivo, in millisecondi Unix. null fino ad allora.

Momento in cui il risultato del task scade, in millisecondi Unix. È 3 giorni dopo finished_at, oppure 3 giorni dopo created_at finché il task non termina. Per gli account Enterprise, che conservano i risultati delle API a tempo indeterminato, è circa 100 anni dopo. Consulta Conservazione degli asset.

La posizione del task nella coda mentre è PENDING. 1 significa che inizierà come prossimo. 0 dopo che il task lascia la coda, e sempre 0 nei risultati degli elenchi.

Il motivo per cui il task è fallito. null a meno che status non sia FAILED. Consulta Errori.

Numero di crediti addebitati per il task, dopo eventuali rimborsi. Una richiesta che restituisce un errore non viene addebitata. Un task fallito è 0, perché Meshy lo rimborsa. L'annullamento rimborsa un task solo mentre è PENDING. Se Meshy non riesce a leggere l'addebito, una risposta get o stream omette il campo, e una richiesta di elenco restituisce 500. In quel caso, ripeti la richiesta.

URL di download per il modello 3D. Meshy esporta il file GLB e il pacchetto OBJ in scala reale in millimetri, con Y verso l'alto, con la parte anteriore del keycap rivolta verso +Z.

Il modello ha mesh denominate keycap-head e keycap-base. Quando Meshy ricorre a un riempimento a pattern per la base, il modello include anche una mesh keycap-base-interior per la cavità dello stelo. Non dare per scontato che il modello abbia esattamente due mesh.

Questi sono URL firmati, quindi recuperali senza un header Authorization. Restano validi fino a expires_at, e richiedere di nuovo il task prima di allora restituisce gli stessi URL. Un URL scaduto non può essere rinnovato, quindi scarica e salva i file prima di allora.

URL di download per le immagini delle fasi di build, organizzate per tipo. Come model_urls, sono URL firmati, quindi recuperali senza un header Authorization. Restano validi fino a expires_at, e richiedere di nuovo il task restituisce gli stessi URL.

Può avere queste chiavi:

• head_design: l'immagine di design del candidato scelto, che la build ha trasformato in 3D. Sempre presente.
• composite: l'immagine del keycap finito per il candidato scelto, da cui la build ha dipinto la base. Può essere assente.
• base_canvas: la base del keycap dipinta. Può essere assente.

Meshy potrebbe aggiungere delle chiavi, quindi ignora una chiave che non riconosci.