Creative Lab — API Keycap

Photo source pour que Meshy la transforme en images de design de keycap. Nous supportons actuellement les formats .jpg, .jpeg, .png, et .webp.

Le format est détecté en décodant les données de l'image, pas à partir de l'extension de fichier de l'URL — une URL sans extension, ou une qui redirige, fonctionne tant que les octets se décodent dans un format supporté. Les redirections HTTP sont suivies. L'orientation EXIF est normalisée, donc une photo de téléphone tournée est utilisée telle qu'elle apparaît.

Limites : au moins 32 pixels de chaque côté, au maximum 178,956,970 pixels au total, et au maximum 20,000,000 octets une fois téléchargée. Pour un Data URI, la limite s'applique aux octets décodés, donc le fichier source lui-même peut atteindre cette taille — c'est le texte base64 qui est environ un tiers plus grand, ce qui compte pour votre corps de requête, pas pour cette limite. Un Data URI doit déclarer un type de contenu image/* et ;base64.

Il y a deux façons de fournir l'image :

• URL accessible publiquement : Une URL accessible depuis l'internet public.
• Data URI : Un Data URI encodé en base64 de l'image. Exemple de Data URI : data:image/jpeg;base64,<vos données d'image encodées en base64>.

Nom de tâche optionnel à des fins d'affichage. Maximum 100 caractères.

Lorsqu'il est réglé sur true, le rendu d'affichage retourné dans image_urls est un PNG RGBA transparent avec le fond supprimé, vous pouvez donc le composer sur n'importe quel fond.

Cela s'applique uniquement au rendu d'affichage. Le candidat que le point de terminaison de construction consomme n'est pas affecté, donc le résultat 3D est identique dans les deux cas.

La requête était inacceptable. Causes courantes :

• Paramètre manquant : image_url est requis.
• Format d'image invalide : Le image_url fourni n'est pas un format supporté (.jpg, .jpeg, .png, .webp).
• Dimensions de l'image hors limites : L'image est trop petite, dépasse la taille de fichier maximale, ou dépasse le nombre maximal de pixels.
• URL inaccessible : Le image_url n'a pas pu être téléchargé (404 ou timeout).
• Data URI invalide : La chaîne base64 est mal formée.
• Contenu signalé : L'image d'entrée a été signalée par la modération NSFW.

L'authentification a échoué. Veuillez vérifier votre clé API.

Le compte est sur le plan gratuit (un plan payant est requis pour créer des tâches) ou n'a pas suffisamment de crédits.

L'image d'entrée a été signalée par la modération de propriété intellectuelle.

Vous avez dépassé votre limite de débit.

Une erreur inattendue côté serveur s'est produite — par exemple, le service de modération de contenu était indisponible, la mise en scène de l'image d'entrée a échoué, ou la tâche n'a pas pu être créée. Aucune tâche n'est créée dans ce cas, donc réessayer est sans risque.

L'ID de la tâche prototype créée via ce même point de terminaison OpenAPI. Le prototype doit avoir été créé par le même compte Meshy, doit avoir atteint SUCCEEDED, et doit avoir produit au moins un candidat.

Les tâches prototype créées via l'application web ne sont pas acceptées — le point de terminaison de construction accepte uniquement les tâches prototype produites par POST /openapi/creative-lab/keycap/v1/prototype et refuse toute autre source avec 404.

Le candidat à construire, pris dans le tableau candidate_ids de la tâche prototype réussie. Doit appartenir à cette tâche ; toute autre valeur est rejetée avec 400.

Nom de tâche optionnel à des fins d'affichage. Maximum 100 caractères.

La base de la touche à construire. Actuellement, la seule valeur disponible est cherry-mx-1x1-r1 — une touche standard de profil Cherry MX 1u. 3 à 5 tailles standard grand public supplémentaires sont prévues ; les tailles personnalisées ne sont pas prises en charge.

Taille cible de la tête sculptée, en millimètres : sa plus grande dimension est mise à l'échelle à cette valeur. Plage : [10, 40]. Les valeurs supérieures à environ 32.9 peuvent être réduites pour que la tête s'adapte toujours à la limite de l'empreinte de protection de la base, de sorte que la plus grande dimension livrée peut être inférieure à celle demandée. La valeur appliquée n'est pas renvoyée aujourd'hui sur l'objet tâche — si vous devez confirmer la taille que vous avez réellement reçue, mesurez la boîte englobante du maillage keycap-head dans le modèle téléchargé.

Décalage vertical appliqué à la tête avant qu'elle ne soit placée sur la base, en millimètres. Plage : [-5, 5].

La requête était inacceptable. Causes courantes :

• Paramètre manquant : input_task_id et candidate_id sont requis.
• UUID invalide : Le input_task_id n'est pas un UUID valide.
• Parent non réussi : La tâche prototype référencée n'a pas encore atteint SUCCEEDED.
• Aucun candidat : La tâche prototype a réussi mais n'a produit aucun candidat.
• Candidat inconnu : candidate_id n'est pas l'un des candidats de la tâche d'entrée.
• Options hors plage : L'un des champs options est tombé en dehors de sa plage autorisée ou de son ensemble d'énumération.

L'authentification a échoué. Veuillez vérifier votre clé API.

Le compte est sur le plan gratuit (un plan payant est requis pour créer des tâches) ou n'a pas suffisamment de crédits.

La tâche prototype référencée n'existe pas, appartient à un utilisateur différent, ou a été créée via l'application web (seules les tâches prototype en mode API s'enchaînent dans la construction).

Vous avez dépassé votre limite de débit.

Une erreur inattendue côté serveur s'est produite — par exemple, le service de modération de contenu était indisponible, la mise en scène de l'image d'entrée a échoué, ou la tâche n'a pas pu être créée. Aucune tâche n'est créée dans ce cas, donc réessayer est sans danger.

Identifiant unique pour la tâche de keycap à récupérer.

Identifiant unique pour la tâche de keycap à annuler.

La tâche est déjà dans un état terminal et ne peut pas être annulée.

La tâche n'existe pas, appartient à un autre utilisateur, ou son étape ne correspond pas au chemin URL.

Une erreur inattendue côté serveur s'est produite lors de l'annulation. La tâche peut ou non avoir été annulée — relisez-la pour confirmer avant de réessayer.

Identifiant unique pour la tâche keycap à diffuser.

Soit prototype soit build. La collection renvoie uniquement les tâches dont l'étape correspond à l'URL — récupérer /prototype ne renvoie jamais de tâches de construction et vice versa.

Numéro de page pour la pagination.

Limite de taille de page. Le maximum autorisé est de 100 éléments.

Champ par lequel trier. Valeurs disponibles :

• +created_at: Trier par heure de création par ordre croissant.
• -created_at: Trier par heure de création par ordre décroissant.

Identifiant unique pour la tâche. Bien que nous utilisions un UUID triable par k pour les identifiants de tâche comme détail d'implémentation, vous ne devez pas faire d'hypothèses sur le format de l'id.

Type de la tâche. La valeur est creative-lab-keycap-prototype.

Le nom de la tâche fourni lors de la création de la tâche. Chaîne vide si aucun nom n'a été fourni.

Statut de la tâche. Les valeurs possibles sont PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progression de la tâche. Si la tâche n'est pas encore commencée, cette propriété sera 0. Une fois la tâche réussie, cela deviendra 100.

Horodatage de la création de la tâche, en millisecondes.

Horodatage du début de la tâche, en millisecondes. Si la tâche n'est pas encore commencée, cette propriété sera 0.

Horodatage de la fin de la tâche, en millisecondes. Si la tâche n'est pas encore terminée, cette propriété sera 0.

Horodatage de l'expiration du résultat de la tâche, en millisecondes.

Le nombre de tâches précédentes.

Détails des erreurs pour les tâches échouées. Voir Erreurs pour la référence complète de l'objet task_error.

Le nombre de crédits consommés par cette tâche. Une tâche qui atteint SUCCEEDED est facturée du montant total pour son étape. Une tâche qui n'est jamais créée (un 4xx au moment de la demande, y compris un rejet de modération) n'est pas facturée du tout. Une tâche qui atteint FAILED retourne 0 — le montant est remboursé, y compris un blocage de modération asynchrone. L'annulation via DELETE est remboursée uniquement tant que la tâche est encore PENDING; une tâche déjà IN_PROGRESS reste facturée, car le travail a été effectué.

URL téléchargeable du rendu de conception de keycap fini — à quoi ressemble le candidat en tant que keycap fini. Contient une seule entrée; image_urls[i] correspond à candidate_ids[i]. Vide jusqu'à ce que la tâche atteigne SUCCEEDED. L'URL est uniquement pour l'affichage; le point de terminaison de construction consomme candidate_ids, pas ces URL. Même cycle de vie d'URL que model_urls: signé, sans en-tête Authorization, valide jusqu'à expires_at, et stable lorsque la tâche est relue.

Identifiants de candidats opaques, parallèles à image_urls. Passez l'entrée correspondant à votre conception choisie comme candidate_id de la demande de construction. Ne faites aucune hypothèse sur le format de ces identifiants.

Identifiant unique pour la tâche.

Type de la tâche. La valeur est creative-lab-keycap-build.

Le nom de la tâche fourni lors de la création de la tâche. Chaîne vide si aucun nom n'a été fourni.

Statut de la tâche. Les valeurs possibles sont l'une de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Avancement de la tâche. Si la tâche n'est pas encore commencée, cette propriété sera 0. Une fois la tâche réussie, cela deviendra 100.

Horodatage de la création de la tâche, en millisecondes.

Horodatage du début de la tâche, en millisecondes.

Horodatage de la fin de la tâche, en millisecondes.

Horodatage de l'expiration du résultat de la tâche, en millisecondes.

Le nombre de tâches précédentes. Significatif uniquement lorsque le statut est PENDING.

Détails des erreurs pour les tâches échouées. Voir Erreurs pour la référence complète de l'objet task_error.

Le nombre de crédits consommés par cette tâche. Une tâche qui atteint SUCCEEDED est facturée du montant total pour son étape. Une tâche qui n'est jamais créée (un 4xx au moment de la demande, y compris un rejet de modération) n'est pas facturée du tout. Une tâche qui atteint FAILED retourne 0 — la charge est remboursée, y compris un blocage de modération asynchrone. L'annulation via DELETE rembourse uniquement tant que la tâche est encore PENDING; une tâche déjà IN_PROGRESS reste facturée, car le travail a été dépensé.

URLs téléchargeables pour les artefacts de modèle générés. Les deux, le GLB et le bundle OBJ, sont exportés à l'échelle réelle en millimètres, Y-up, avec l'avant du keycap face au +Z. Les maillages sont nommés keycap-head et keycap-base; lorsque la base revient à un remplissage de motif, un troisième maillage keycap-base-interior est également présent pour la cavité de la tige. Ne supposez pas exactement deux maillages.

Ce sont des URLs signées : récupérez-les sans en-tête Authorization. Elles restent valides jusqu'à expires_at, qui est 3 jours après finished_at, et relire la tâche dans cette fenêtre retourne l'URL identique plutôt qu'une nouvelle signée. Téléchargez et stockez les fichiers vous-même avant cela — il n'y a aucun moyen de rafraîchir un lien expiré.

URLs téléchargeables pour les images de processus intermédiaires, indexées par type. Même cycle de vie d'URL que model_urls: signées, sans en-tête Authorization, valides jusqu'à expires_at, et stables lorsque la tâche est relue. Types actuellement émis :

• head_design — l'image de conception du candidat choisi que la construction a consommée (toujours présente).
• composite — le rendu d'affichage du keycap fini du candidat choisi (présent lorsque disponible).
• base_canvas — la toile de base du keycap peinte (présente lorsque disponible).

Considérez l'ensemble des clés comme ouvert ; de nouveaux types peuvent être ajoutés sans changement majeur.