Enterprise API

Die Enterprise API ist eine Funktion, mit der Sie Meshys Enterprise-Funktionen in Ihre eigene Anwendung integrieren können. Diese API-Funktionen stehen nur Nutzern unseres Enterprise-Tarifs zur Verfügung. In diesem Abschnitt finden Sie alle Informationen, die Sie benötigen, um mit dieser API zu beginnen.

GET/openapi/v1/showcases

Showcases auflisten

Dieser Endpunkt ermöglicht es Ihnen, nach Community-Showcase-Modellen zu suchen, die zum Download verfügbar sind, und diese zurückzugeben. Sie können bis zu maximal 10 Modelle in einer einzigen Anfrage zurückgeben lassen, und jede Anfrage kostet 1 Credit.

Parameter

Optionale Attribute

  • Name
    page_size
    Type
    integer
    Description

    Die Anzahl der zurückzugebenden Showcase-Modelle. Muss eine positive Zahl zwischen 1 und 10 (einschließlich) sein. Beachten Sie, dass die Anfrage möglicherweise weniger als die angeforderte Anzahl an übereinstimmenden Modellen zurückgibt, falls nicht genügend Treffer gefunden werden. Es werden keine Modelle zurückgegeben, wenn keine Treffer gefunden werden. Der Standardwert ist 3 Modelle, wenn page_size nicht angegeben wird.

  • Name
    sort_by
    Type
    string
    Description

    Methode zum Sortieren der erhaltenen Suchergebnisse. Wenn nicht angegeben, werden die Ergebnisse nach Erstellungszeit vom neuesten zum ältesten sortiert (-created_at).

    • +created_at: Sortierung nach Erstellungszeit in aufsteigender Reihenfolge.
    • -created_at: Sortierung nach Erstellungszeit in absteigender Reihenfolge.
    • +updated_at: Sortierung nach Aktualisierungszeit in aufsteigender Reihenfolge.
    • -updated_at: Sortierung nach Aktualisierungszeit in absteigender Reihenfolge.
    • +downloads: Sortierung nach Anzahl der Downloads in aufsteigender Reihenfolge.
    • -downloads: Sortierung nach Anzahl der Downloads in absteigender Reihenfolge.
  • Name
    search
    Type
    string
    Description

    Text, nach dem innerhalb der von der Community veröffentlichten (CC0) Modellnamen gesucht werden soll. Wenn nicht angegeben, werden die insgesamt besten Community-Modelle (basierend auf sort_by) zurückgegeben.

  • Name
    format
    Type
    string
    Description

    Gewünschtes 3D-Modellformat für die zurückgegebenen Ergebnisse. Alle abgerufenen Modelle liegen im angegebenen Format vor. Muss einer der folgenden optionalen Werte sein. Wenn nicht angegeben, ist der Standardwert glb.

    • glb: glb-Format.
    • fbx: fbx-Format.
    • obj: obj-Format.
    • usdz: usdz-Format.
  • Name
    showcase_type
    Type
    string
    Description

    Gewünschter Modelltyp für die zurückgegebenen Ergebnisse. Alle abgerufenen Modelle haben den angegebenen Typ. Muss einer der folgenden optionalen Werte sein. Wenn nicht angegeben, ist der Standardwert all.

    • all: Alle Showcase-Modelle.
    • animated: Animierte Showcase-Modelle.
    • static: Statische Showcase-Modelle.

Rückgabewerte

  • Name
    id
    Type
    string
    Description

    Die eindeutige Kennung für das Showcase-Modell. Obwohl wir eine k-sortierbare UUID als Implementierungsdetail für die Task-ID verwenden, sollten Sie kein bestimmtes Format für die ID annehmen.

  • Name
    result_id
    Type
    string
    Description

    Die eindeutige Kennung für das zurückgegebene Modellergebnis. Diese ID ist mit dem Modell verknüpft und kann direkt in anderen API-Tasks wie der Neuvernetzung verwendet werden.

  • Name
    model_url
    Type
    object
    Description

    Die URL des herunterladbaren 3D-Modells mit Texturen. Standardmäßig wird das glb-Format zurückgegeben.

  • Name
    conversion_status
    Type
    string
    Description

    Der Dateityp-Konvertierungsstatus der zurückgegebenen Modelle.

    • <leerer String>: Nicht konvertiert (Standard glb).
    • success: Konvertierung erfolgreich.
    • failed: Konvertierung fehlgeschlagen.
  • Name
    community_url
    Type
    string
    Description

    Der Community-Browsing-Link des Showcase-Modells.

  • Name
    author
    Type
    string
    Description

    Der Autor des Showcase-Modells.

  • Name
    topology
    Type
    string
    Description

    Die topology des Showcase-Modells (quad oder triangle).

  • Name
    name
    Type
    string
    Description

    Der Name des Showcase-Modells.

  • Name
    object_prompt
    Type
    string
    Description

    Die Beschreibung des Showcase-Modells.

  • Name
    categories
    Type
    array
    Description

    Die Kategorien des Showcase-Modells.

  • Name
    tags
    Type
    array
    Description

    Die Tags des Showcase-Modells.

  • Name
    mode
    Type
    string
    Description

    Der mode des Showcase-Modells.

  • Name
    created_at
    Type
    timestamp
    Description

    Der Zeitstempel der Erstellung des Showcase-Modells (in Millisekunden).

  • Name
    updated_at
    Type
    timestamp
    Description

    Der Zeitstempel der Aktualisierung des Showcase-Modells (in Millisekunden).

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
    }
  ]
}