Creative Lab — API Portachiavi

Foto sorgente che Meshy colorizzerà in un'immagine concettuale pronta per il portachiavi. Attualmente supportiamo i formati .jpg, .jpeg, .png e .webp.

Esistono due modi per fornire l'immagine:

• URL accessibile pubblicamente: un URL accessibile da internet pubblicamente.
• Data URI: un URI dati con codifica base64 dell'immagine. Esempio di data URI: data:image/jpeg;base64,<i tuoi dati immagine codificati in base64>.

Nome opzionale del task per scopi di visualizzazione. Massimo 100 caratteri.

Questo etichetta il task nella tua dashboard e negli elenchi dei task. Non viene inciso sul portachiavi — usa name_text per quello.

Testo da incidere sul portachiavi, come il nome di un animale domestico o di una persona. Massimo 10 caratteri, contati come caratteri Unicode anziché byte, quindi è accettato un nome cinese, giapponese o coreano di 10 caratteri. Omettilo per produrre un portachiavi senza incisione.

Gli spazi bianchi circostanti vengono rimossi e i caratteri di formattazione invisibili vengono eliminati prima che il testo venga utilizzato. Il valore risultante viene restituito come name_text nell'oggetto task del prototipo, così puoi confermare esattamente cosa verrà inciso prima di pagare per la fase di build.

L'incisione viene applicata qui, nella fase di prototipo. La fase di build la eredita automaticamente e non accetta un proprio name_text.

Quando impostato su true, l'immagine del prototipo viene restituita come PNG RGBA trasparente con lo sfondo rimosso, così puoi comporre il soggetto su qualsiasi sfondo.

Questo controlla solo l'immagine restituita da questo endpoint. È separato dall'opzione di build con lo stesso nome (predefinito true), che controlla la rimozione dello sfondo prima del rilievo.

La richiesta era inaccettabile. Cause comuni:

• Parametro mancante: image_url è obbligatorio.
• Formato immagine non valido: l'image_url fornito non è in un formato supportato (.jpg, .jpeg, .png, .webp).
• Dimensioni dell'immagine fuori intervallo: l'immagine è troppo piccola, supera la dimensione massima del file o supera il numero massimo di pixel.
• URL non raggiungibile: l'image_url non è stato scaricabile (404 o timeout).
• Data URI non valido: la stringa base64 è malformata.
• Incisione troppo lunga: name_text supera i 10 caratteri. La richiesta viene rifiutata anziché troncata, così non ti viene mai addebitato un portachiavi inciso con un nome accorciato.
• Contenuto segnalato: l'immagine di input è stata segnalata dalla moderation per contenuti NSFW o proprietà intellettuale, oppure l'incisione name_text è stata segnalata dalla moderation NSFW. L'incisione viene controllata solo per contenuti NSFW — il controllo sulla proprietà intellettuale si applica all'immagine.

Autenticazione fallita. Verifica la tua chiave API.

Crediti insufficienti per eseguire questo task.

Hai superato il tuo limite di frequenza.

L'ID dell'attività di un'attività di prototipo creata tramite questo stesso endpoint OpenAPI. Il prototipo deve essere stato creato con la stessa chiave API, deve aver raggiunto lo stato SUCCEEDED e deve aver prodotto esattamente un'immagine candidata.

Le attività di prototipo create tramite la webapp non sono accettate: l'endpoint di build accetta solo attività di prototipo prodotte da POST /openapi/creative-lab/keychain/v1/prototype e rifiuta qualsiasi altra origine con 404.

Nome dell'attività opzionale, a scopo di visualizzazione. Massimo 100 caratteri.

Silhouette del contorno del medaglione portachiavi. Valori disponibili:

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

Lunghezza del lato del quadrato di ingombro del portachiavi, in millimetri. Intervallo: (0, 400].

Altezza massima del rilievo sopra la base, in millimetri. Intervallo: [0, 20].

Offset verticale applicato al rilievo prima dell'estrusione, in millimetri. Intervallo: [0, 20].

Spessore della piastra di base piatta dietro il rilievo, in millimetri. Intervallo: [0, 20].

Indica se il retro del medaglione è sigillato come superficie chiusa. Imposta su false per un guscio aperto.

Curva di trasferimento che mappa i valori della mappa di profondità sull'altezza del rilievo. Valori disponibili:

• linear (predefinito)
• gamma
• s-curve

Parametro di forma per la curva di trasferimento (significativo solo quando relief_curve è gamma). Intervallo: (0, 10].

Inverte l'interpretazione della mappa di profondità in modo che le regioni più scure diventino rilievo più alto.

Intensità dello smoothing applicato alla mappa di profondità prima dell'estrazione del rilievo. Intervallo: [0, 10].

Moltiplicatore di scala verticale applicato sopra relief_height_mm. Intervallo: (0, 10].

Soglia di taglio basso per i valori della mappa di profondità; tutto ciò che è al di sotto viene azzerato. Intervallo: [0, 1].

Rimuove automaticamente lo sfondo dell'immagine concettuale del prototipo prima di applicare il rilievo.

Distinto dal parametro del prototipo con lo stesso nome (predefinito false), che controlla se l'immagine del prototipo stessa viene restituita con trasparenza.

Risoluzione mesh usata per l'esportazione. Intervallo: [64, 2048].

Pacchetto di artefatti restituito dalla build. Valori disponibili:

• glb (predefinito) — restituisce un singolo model.glb in model_urls.glb.
• obj — comprime model.obj + model.mtl + texture.png e restituisce il pacchetto in model_urls.obj.
• zip — comprime ogni artefatto prodotto dal generatore e restituisce il pacchetto in model_urls.bundle_zip.

La richiesta non era accettabile. Cause comuni:

• Parametro mancante: input_task_id è obbligatorio.
• UUID non valido: input_task_id non è un UUID valido.
• Attività genitore non riuscita: l'attività di prototipo referenziata non ha ancora raggiunto lo stato SUCCEEDED.
• Nessun candidato: l'attività di prototipo è riuscita ma non ha prodotto alcuna immagine candidata.
• Opzioni fuori intervallo: uno dei campi di options è al di fuori dell'intervallo consentito o dell'insieme di valori enumerati.

Autenticazione non riuscita. Controlla la tua chiave API.

Crediti insufficienti per eseguire questa attività.

L'attività di prototipo referenziata non esiste, appartiene a un altro utente oppure è stata creata tramite la webapp (solo le attività di prototipo in modalità API possono essere concatenate a una build).

Hai superato il limite di frequenza.

Identificatore univoco dell'attività keychain da recuperare.

Identificatore univoco dell'attività di portachiavi da annullare.

L'attività è già in uno stato terminale e non può essere annullata.

L'attività non esiste, appartiene a un utente diverso, oppure la sua fase non corrisponde al percorso URL.

Identificatore univoco del task keychain di cui effettuare lo streaming.

Può essere prototype o build. La raccolta restituisce solo i task la cui fase corrisponde all'URL — richiamare /prototype non restituisce mai task di build e viceversa.

Numero di pagina per la paginazione.

Limite della dimensione della pagina. Il massimo consentito è 100 elementi.

Campo per l'ordinamento. Valori disponibili:

• +created_at: Ordina per orario di creazione in ordine crescente.
• -created_at: Ordina per orario di creazione in ordine decrescente.

Identificatore univoco per il task. Sebbene utilizziamo un UUID k-sortable per gli id dei task come dettaglio implementativo, non dovresti fare alcuna assunzione riguardo al formato dell'id.

Tipo del task. Il valore è creative-lab-keychain-prototype.

Il nome del task fornito al momento della creazione del task. Stringa vuota se non è stato fornito alcun nome.

L'incisione applicata a questo portachiavi, dopo la rimozione degli spazi in eccesso e dei caratteri di formattazione invisibili. Assente quando il task è stato creato senza name_text. Confrontalo con quanto inviato per verificare che il testo sia sopravvissuto alla codifica del tuo client HTTP.

Stato del task. I valori possibili sono uno tra PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress del task. Se il task non è ancora stato avviato, questa proprietà sarà 0. Una volta che il task ha avuto successo, diventerà 100.

Timestamp di quando il task è stato creato, in millisecondi.

Timestamp di quando il task è stato avviato, in millisecondi. Se il task non è ancora stato avviato, questa proprietà sarà 0.

Timestamp di quando il task è terminato, in millisecondi. Se il task non è ancora terminato, questa proprietà sarà 0.

Timestamp di quando il risultato del task scade, in millisecondi.

Il conteggio dei task precedenti.

Dettagli dell'errore per i task falliti. Vedi Errori per il riferimento completo dell'oggetto task_error.

Il numero di crediti consumati da questo task. Presente quando lo stato del task è PENDING, IN_PROGRESS, o SUCCEEDED. Restituisce 0 per i task FAILED (i crediti vengono rimborsati in caso di fallimento).

URL scaricabili per i candidati dell'immagine concettuale generati da questo task prototipo. Attualmente l'API restituisce sempre esattamente un candidato; il campo è un array in modo che revisioni future possano esporre più candidati senza introdurre una modifica incompatibile.

Identificatore univoco del task.

Tipo del task. Il valore è creative-lab-keychain-build.

Il nome del task fornito al momento della creazione. Stringa vuota se non è stato fornito alcun nome.

Stato del task. I possibili valori sono PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress del task. Se il task non è ancora iniziato, questa proprietà sarà 0. Una volta che il task è completato con successo, diventerà 100.

Timestamp di quando il task è stato creato, in millisecondi.

Timestamp di quando il task è stato avviato, in millisecondi.

Timestamp di quando il task è terminato, in millisecondi.

Timestamp di quando il risultato del task scade, in millisecondi.

Il conteggio dei task precedenti. Significativo solo quando lo stato è PENDING.

Dettagli dell'errore per i task falliti. Consulta Errori per il riferimento completo dell'oggetto task_error.

Il numero di crediti consumati da questo task. Restituisce 0 per i task FAILED (i crediti vengono rimborsati in caso di fallimento).

URL scaricabili per l'artefatto generato, indicizzati per nome dell'artefatto. Contiene sempre esattamente una voce — il formato richiesto tramite output.format della richiesta di build. La chiave corrisponde al formato richiesto: