API Creative Lab Keychain

La foto da trasformare in un'immagine concettuale di keychain, 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.

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

Etichetta l'attività nella tua dashboard e negli elenchi delle attività, e non appare sul keychain. Per inserire un nome sul keychain, usa name_text.

Un nome da aggiungere al keychain, ad esempio il nome di un animale domestico o di una persona, fino a 10 caratteri. Meshy conta i caratteri, non i byte, quindi un nome cinese, giapponese o coreano di 10 caratteri rientra nel limite. Un nome più lungo restituisce 400. Ometti questo campo per un keychain senza nome.

Il nome appare sulla faccia del keychain come dettaglio colorato piatto, non come testo in rilievo o inciso.

Meshy rimuove gli spazi bianchi circostanti ed elimina i caratteri di formattazione invisibili. L'oggetto attività di prototipo restituisce il risultato come name_text, così puoi verificare il testo prima di pagare per la build.

Meshy aggiunge il nome nella fase di prototipo. La build lo mantiene e ignora un eventuale name_text inviato all'endpoint di build.

Se rimuovere lo sfondo dall'immagine di prototipo. true restituisce un PNG RGBA trasparente che mantiene l'intero medaglione, così puoi posizionarlo su qualsiasi sfondo. Anche la build parte dall'immagine senza il suo sfondo. Se Meshy non riesce a rimuovere lo sfondo, restituisce l'immagine con il suo sfondo, e l'attività ha comunque esito positivo.

L'opzione remove_background della build è separata.

La richiesta non può essere eseguita. Ad esempio:

• image_url manca.
• 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 è una codifica base64 valida.
• name_text è più lungo di 10 caratteri. Meshy lo rifiuta invece di accorciarlo, e non addebita costi per la richiesta.
• L'immagine o name_text è stato segnalato come NSFW.

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

La chiave API manca 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 è sul piano gratuito.

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

Il tuo team ha attivato IP Filtering, e Meshy ha segnalato l'immagine per proprietà intellettuale di terze parti. Invia un'immagine di cui hai i diritti d'uso. Meshy verifica la proprietà intellettuale solo sull'immagine, non su name_text.

È stato raggiunto uno di questi limiti:

• Hai inviato più richieste di quante ne consenta il tuo limite di frequenza. Attendi qualche secondo, quindi riprova. Vedi Limiti di frequenza.
• Troppe delle tue attività sono in coda o in esecuzione. Attendi che alcune terminino, quindi 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é non è riuscito a eseguire il controllo sulla proprietà intellettuale dell'immagine. Meshy non crea l'attività, e rimborsa eventuali crediti addebitati. Riprova la richiesta.

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

Un ID che non corrisponde a una delle tue attività prototype Keychain dell'API restituisce 404, incluso un prototipo creato nell'app web.

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

Il contorno del portachiavi quando Meshy non lo traccia dal soggetto. Meshy lo usa quando remove_background è false, oppure quando non riesce a trovare il contorno del soggetto.

Valori disponibili:

• circle
• rounded-rect
• hexagon
• shield
• star

La lunghezza del lato del quadrato di delimitazione del portachiavi, in millimetri, fino a 400. 0 usa il valore predefinito.

L'altezza massima del rilievo sopra la base, in millimetri, da 0 a 20.

Di quanto abbassare il rilievo, in millimetri, da 0 a 20. Meshy lo sottrae dall'altezza del rilievo ovunque, fino alla base.

Lo spessore della piastra base piatta dietro il rilievo, in millimetri, da 0 a 20.

Se chiudere il retro del portachiavi. false lascia il retro aperto, come un guscio.

La curva che mappa i valori della depth-map sull'altezza del rilievo.

Valori disponibili:

• linear
• gamma
• s-curve

L'intensità della curva, fino a 10. Le curve gamma e s-curve la usano, mentre linear la ignora. 0 usa il valore predefinito.

Se invertire la depth map, in modo che le aree più scure diventino rilievo più alto.

Quanto smussare la depth map prima che Meshy costruisca il rilievo, da 0 a 10.

Di quanto ingrandire il rilievo e la sua texture all'interno del contorno, rispetto al centro, fino a 10. Un valore superiore a 1 ingrandisce il soggetto, mentre un valore inferiore a 1 lo rimpicciolisce. Non modifica l'altezza del rilievo. 0 usa il valore predefinito.

Il valore della depth-map al di sotto del quale Meshy imposta la profondità a zero, da 0 a 1.

Se tracciare il contorno del portachiavi dal soggetto, in modo che il portachiavi segua la forma del soggetto. false usa invece il contorno badge_shape. Meshy usa badge_shape anche quando non riesce a trovare il contorno del soggetto.

Questo è separato dal parametro remove_background del prototipo, che imposta se l'immagine del prototipo ha uno sfondo trasparente.

La risoluzione della mesh del modello esportato, da 64 a 512. Meshy costruisce la geometria a partire da una depth map a 512 pixel, quindi una mesh più fine aggiungerebbe facce senza aggiungere dettaglio. 0 usa il valore predefinito.

Il formato file restituito dalla build.

Valori disponibili:

• glb: un file model.glb, in model_urls.glb
• obj: un file zip con model.obj, model.mtl e texture.png, in model_urls.obj
• zip: un file zip con ogni file generato da Meshy, in model_urls.bundle_zip

La richiesta non può essere eseguita. Ad esempio:

• input_task_id è mancante o non è un ID attività valido.
• Lo stato dell'attività prototype non è SUCCEEDED. Se è ancora in esecuzione, attendi e riprova. Se è fallita o è stata annullata, crea una nuova attività prototype.
• L'attività prototype è riuscita ma non ha un'immagine. Crea una nuova attività prototype.
• Un campo di options è fuori dall'intervallo consentito o non è un valore disponibile.

Il messaggio di errore indica quale problema ha trovato.

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

Si applica uno di questi casi:

• 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à prototype Keychain creata dal tuo account tramite l'API. Anche un prototipo creato nell'app web restituisce 404. Invia l'ID result proveniente da una 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 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.

L'ID dell'attività dalla risposta di creazione.

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

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

Nessuna attività Keychain con questo ID appartiene al tuo account, oppure la fase dell'attività non corrisponde al percorso. Controlla l'ID e usa /prototype o /build in base all'attività.

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

L'ID dell'attività da annullare.

Si applica uno dei seguenti casi:

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

Nessuna attività Keychain con questo ID appartiene al tuo account, oppure la fase dell'attività non corrisponde al percorso. Controlla l'ID e usa /prototype o /build per far corrispondere l'attività.

L'ID dell'attività proveniente 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 fuori dall'intervallo 0-255 restituisce 400.

Numero di task per pagina, fino a 100. Un valore da 101 a 255 restituisce 100 task, e 0 usa il valore predefinito. Un valore fuori dall'intervallo 0-255 restituisce 400.

L'ordine di ordinamento.

Valori disponibili:

• -created_at: più recenti per primi
• +created_at: meno recenti per primi

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

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

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

Il nome che Meshy ha aggiunto al portachiavi, dopo aver rimosso gli spazi bianchi e i caratteri di formattazione invisibili. Omesso quando non hai inviato name_text. Per verificare che il tuo client HTTP abbia codificato correttamente il testo, confrontalo con quello che hai inviato.

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 a quel momento.

Momento in cui il task ha raggiunto uno stato finale, in millisecondi Unix. null fino a quel momento.

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. 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, ritenta la richiesta.

URL di download per l'immagine concettuale. L'array contiene un URL dopo che il task ha successo, ed è vuoto fino a quel momento.

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

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

Il name inviato durante la creazione del 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: 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 ed è 100 quando riesce.

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. È 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. 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 il file del modello, con una voce per l'output.format richiesto. {} finché il task non riesce.