Creative Lab — API Portachiavi

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

Ci sono due modi per fornire l'immagine:

• URL accessibile pubblicamente: Un URL accessibile da internet pubblico.
• Data URI: Un Data URI codificato in base64 dell'immagine. Esempio di un Data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Nome dell'attività opzionale per scopi di visualizzazione. Massimo 100 caratteri.

Quando impostato su true, l'immagine prototipo viene restituita come un PNG RGBA trasparente con lo sfondo rimosso, in modo da poter comporre il soggetto su qualsiasi sfondo.

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

La richiesta non era accettabile. Cause comuni:

• Parametro mancante: image_url è richiesto.
• Formato immagine non valido: L'image_url fornito non è un formato supportato (.jpg, .jpeg, .png, .webp).
• Dimensioni immagine fuori intervallo: L'immagine è troppo piccola, supera la dimensione massima del file o supera il conteggio massimo dei pixel.
• URL irraggiungibile: L'image_url non può essere scaricato (404 o timeout).
• Data URI non valido: La stringa base64 è malformata.
• Contenuto segnalato: L'immagine di input è stata segnalata dalla moderation NSFW o di proprietà intellettuale.

Autenticazione fallita. Si prega di controllare la tua chiave API.

Crediti insufficienti per eseguire questa attività.

Hai superato il tuo limite di frequenza.

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

I task prototipo creati tramite l'app web non sono accettati — l'endpoint di costruzione accetta solo task prototipo prodotti da POST /openapi/creative-lab/keychain/v1/prototype e rifiuta qualsiasi altra fonte con 404.

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

Silhouette del contorno del medaglione portachiavi. Valori disponibili:

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

Lunghezza del bordo del quadrato di delimitazione 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].

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à all'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].

Inverti l'interpretazione della mappa di profondità in modo che le regioni più scure diventino rilievi più alti.

Forza di levigatura applicata 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 passaggio basso per i valori della mappa di profondità; qualsiasi valore inferiore viene bloccato a zero. Intervallo: [0, 1].

Rimuovi automaticamente lo sfondo dell'immagine concettuale del prototipo prima del rilievo.

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

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

Pacchetto di artefatti restituito dalla costruzione. Valori disponibili:

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

La richiesta non era accettabile. Cause comuni:

• Parametro mancante: input_task_id è richiesto.
• UUID non valido: L'input_task_id non è un UUID valido.
• Genitore non riuscito: Il task prototipo di riferimento non ha ancora raggiunto SUCCEEDED.
• Nessun candidato: Il task prototipo è riuscito ma non ha prodotto alcuna immagine candidata.
• Opzioni fuori intervallo: Uno dei campi options è caduto fuori dal suo intervallo consentito o set di enum.

Autenticazione fallita. Si prega di controllare la chiave API.

Crediti insufficienti per eseguire questo task.

Il task prototipo di riferimento non esiste, appartiene a un altro utente o è stato creato tramite l'app web (solo i task prototipo in modalità API si concatenano nella costruzione).

Hai superato il tuo limite di frequenza.

Identificatore univoco per l'attività del portachiavi da recuperare.

Identificatore univoco per l'attività del portachiavi da annullare.

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

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

Identificatore univoco per l'attività di portachiavi da trasmettere.

O prototype o build. La raccolta restituisce solo le attività la cui fase corrisponde all'URL — il recupero di /prototype non restituisce mai attività di build e viceversa.

Numero di pagina per la paginazione.

Limite della dimensione della pagina. Il massimo consentito è di 50 elementi.

Campo per l'ordinamento. Valori disponibili:

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

Identificatore univoco per il task. Anche se utilizziamo un UUID ordinabile per k per gli id dei task come dettaglio di implementazione, non dovresti fare alcuna supposizione sul formato dell'id.

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

Il nome del task fornito quando il task è stato creato. Stringa vuota se non è stato fornito alcun nome.

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

Avanzamento del task. Se il task non è ancora iniziato, questa proprietà sarà 0. Una volta che il task è riuscito, 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 iniziato, questa proprietà sarà 0.

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

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

Il conteggio dei task precedenti.

Dettagli degli errori per i task falliti. Vedi Errori per il riferimento completo all'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 le revisioni future possano presentare più candidati senza una modifica dirompente.

Identificatore univoco per il task.

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

Il nome del task fornito quando il task è stato creato. Stringa vuota se non è stato fornito alcun nome.

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

Avanzamento del task. Se il task non è ancora iniziato, questa proprietà sarà 0. Una volta che il task è riuscito, 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 è stato completato, in millisecondi.

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

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

Dettagli degli errori per i task falliti. Vedi Errori per il riferimento completo all'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 un elemento — il formato richiesto tramite la richiesta di costruzione output.format. La chiave corrisponde al formato richiesto: