API Entreprise

L'API Entreprise est une fonctionnalité qui vous permet d'intégrer les capacités Entreprise de Meshy dans votre propre application. Ces fonctionnalités d'API ne sont disponibles que pour les utilisateurs de notre offre entreprise. Dans cette section, vous trouverez toutes les informations nécessaires pour démarrer avec cette API.

GET/openapi/v1/showcases

List Showcases

Ce point de terminaison vous permet de rechercher et de retourner des modèles de la communauté disponibles au téléchargement. Vous pouvez retourner jusqu'à 10 modèles maximum dans une seule requête, et chaque requête coûtera 1 crédit.

Paramètres

Attributs optionnels

Name
page_size
Type
integer
Description
Le nombre de modèles à retourner. Doit être un nombre positif compris entre 1 et 10 inclus. Notez qu'il est possible que la requête retourne moins de modèles correspondants que demandé s'il n'y a pas assez de correspondances trouvées. Aucun modèle ne sera retourné si aucune correspondance n'est trouvée. La valeur par défaut est 3 modèles si page_size n'est pas fourni.
Name
sort_by
Type
string
Description
Méthode de tri des résultats de recherche obtenus. Si non fourni, les résultats seront triés par heure de création, du plus récent au plus ancien (-created_at).
- +created_at : Trier par heure de création par ordre croissant.
- -created_at : Trier par heure de création par ordre décroissant.
- +updated_at : Trier par heure de mise à jour par ordre croissant.
- -updated_at : Trier par heure de mise à jour par ordre décroissant.
- +downloads : Trier par nombre de téléchargements par ordre croissant.
- -downloads : Trier par nombre de téléchargements par ordre décroissant.
Name
search
Type
string
Description
Texte à rechercher parmi les noms des modèles publiés par la communauté (CC0). Si non fourni, les meilleurs modèles globaux de la communauté (selon sort_by) seront retournés.
Name
format
Type
string
Description
Format 3D souhaité pour les résultats retournés. Tous les modèles récupérés seront dans le format spécifié. Doit être l'une des valeurs optionnelles ci-dessous. Si non fourni, ce sera glb par défaut.
- glb : format glb.
- fbx : format fbx.
- obj : format obj.
- usdz : format usdz.
Name
showcase_type
Type
string
Description
Type de modèle souhaité pour les résultats retournés. Tous les modèles récupérés seront du type spécifié. Doit être l'une des valeurs optionnelles ci-dessous. Si non fourni, ce sera all par défaut.
- all : Tous les modèles.
- animated : Modèles animés.
- static : Modèles statiques.

Retours

Name
id
Type
string
Description
L'identifiant unique du modèle de la vitrine communautaire. Bien que nous utilisions un UUID triable par ordre chronologique (k-sortable) comme détail d'implémentation pour l'id de tâche, vous ne devez pas supposer un format particulier pour l'id.
Name
result_id
Type
string
Description
L'identifiant unique du résultat du modèle retourné. Cet ID est lié au modèle et peut être utilisé directement dans d'autres tâches de l'API, comme le remaillage.
Name
model_url
Type
object
Description
L'URL du modèle 3D téléchargeable avec les textures. Retourne par défaut le format glb.
Name
conversion_status
Type
string
Description
Le statut de conversion du type de fichier des modèles retournés.
- <chaîne vide> : Non converti (glb par défaut).
- success : Conversion réussie.
- failed : Échec de la conversion.
Name
community_url
Type
string
Description
Le lien de navigation communautaire du modèle de la vitrine.
Name
author
Type
string
Description
L'auteur du modèle de la vitrine.
Name
topology
Type
string
Description
La topology du modèle de la vitrine (quad ou triangle).
Name
name
Type
string
Description
Le nom du modèle de la vitrine.
Name
object_prompt
Type
string
Description
La description du modèle de la vitrine.
Name
categories
Type
array
Description
Les catégories du modèle de la vitrine.
Name
tags
Type
array
Description
Les tags du modèle de la vitrine.
Name
mode
Type
string
Description
Le mode du modèle de la vitrine.
Name
created_at
Type
timestamp
Description
L'horodatage de la création du modèle de la vitrine (millisecondes).
Name
updated_at
Type
timestamp
Description
L'horodatage de la mise à jour du modèle de la vitrine (millisecondes).

Request

GET

/openapi/v1/showcases

curl "https://api.meshy.ai/openapi/v1/showcases?page_size=10&sort_by=-created_at&search=car&format=glb" \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "result": [
    {
      "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
      "result_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
      "model_url": "https://api.meshy.ai/v1/models/018a210d-8ba4-705c-b111-1f1776f7f578/model.glb",
      "conversion_status": "success",
      "community_url": "https://www.meshy.ai/showcase/018a210d-8ba4-705c-b111-1f1776f7f578",
      "author": "John Doe",
      "topology": "quad",
      "name": "Car",
      "object_prompt": "A car",
      "categories": ["vehicle"],
      "tags": ["car", "vehicle"],
      "mode": "3d",
      "created_at": 1717171717171,
      "updated_at": 1717171717171
    }
  ]
}