Enterprise API

Enterprise API is een functie waarmee je de Enterprise-mogelijkheden van Meshy in je eigen applicatie kunt integreren. Deze API-functies zijn alleen beschikbaar voor gebruikers met een enterprise-abonnement. In dit gedeelte vind je alle informatie die je nodig hebt om aan de slag te gaan met deze API.

GET/openapi/v1/showcases

List Showcases

Deze endpoint stelt je in staat om community-showcasemodellen te doorzoeken en op te vragen die beschikbaar zijn voor download. Je kunt maximaal 10 modellen in één verzoek opvragen, en elk verzoek kost 1 credit.

Parameters

Optionele attributen

Name
page_size
Type
integer
Description
Het aantal showcasemodellen dat moet worden geretourneerd. Moet een positief getal zijn tussen 1 en 10 (inclusief). Let op: het is mogelijk dat het verzoek minder dan het gevraagde aantal overeenkomende modellen retourneert als er niet genoeg overeenkomsten worden gevonden. Er worden geen modellen geretourneerd als er geen overeenkomsten worden gevonden. Standaard worden 3 modellen geretourneerd als page_size niet is opgegeven.
Name
sort_by
Type
string
Description
Methode om de verkregen zoekresultaten te sorteren. Als dit niet is opgegeven, worden de resultaten gesorteerd op aanmaaktijd, van meest recent naar minst recent (-created_at).
- +created_at: Sorteer op aanmaaktijd in oplopende volgorde.
- -created_at: Sorteer op aanmaaktijd in aflopende volgorde.
- +updated_at: Sorteer op bijwerktijd in oplopende volgorde.
- -updated_at: Sorteer op bijwerktijd in aflopende volgorde.
- +downloads: Sorteer op aantal downloads in oplopende volgorde.
- -downloads: Sorteer op aantal downloads in aflopende volgorde.
Name
search
Type
string
Description
Tekst om te zoeken binnen namen van door de community gepubliceerde (CC0) modellen. Als dit niet is opgegeven, worden de belangrijkste algemene community-modellen (op basis van sort_by) geretourneerd.
Name
format
Type
string
Description
Gewenst 3D-modelformaat voor de geretourneerde resultaten. Alle opgehaalde modellen worden in het opgegeven formaat geleverd. Moet een van de onderstaande optionele waarden zijn. Als dit niet is opgegeven, is de standaardwaarde glb.
- glb: glb-formaat.
- fbx: fbx-formaat.
- obj: obj-formaat.
- usdz: usdz-formaat.
Name
showcase_type
Type
string
Description
Gewenst modeltype voor de geretourneerde resultaten. Alle opgehaalde modellen zijn van het opgegeven type. Moet een van de onderstaande optionele waarden zijn. Als dit niet is opgegeven, is de standaardwaarde all.
- all: Alle showcasemodellen.
- animated: Geanimeerde showcasemodellen.
- static: Statische showcasemodellen.

Resultaten

Name
id
Type
string
Description
De unieke identificatie voor het showcasemodel. Hoewel we een k-sortable UUID gebruiken als implementatiedetail voor de task id, mag je geen enkele aanname doen over het formaat van de id.
Name
result_id
Type
string
Description
De unieke identificatie voor het geretourneerde modelresultaat. Deze ID is gekoppeld aan het model en kan direct worden gebruikt in andere API-taken zoals remesh.
Name
model_url
Type
object
Description
De URL van het downloadbare 3D-model met textures. Standaard wordt het glb-formaat geretourneerd.
Name
conversion_status
Type
string
Description
De bestandstype-conversiestatus van de geretourneerde modellen.
- <lege string>: Niet geconverteerd (standaard glb).
- success: Conversie geslaagd.
- failed: Conversie mislukt.
Name
community_url
Type
string
Description
De community-browselink van het showcasemodel.
Name
author
Type
string
Description
De auteur van het showcasemodel.
Name
topology
Type
string
Description
De topology van het showcasemodel (quad of triangle).
Name
name
Type
string
Description
De naam van het showcasemodel.
Name
object_prompt
Type
string
Description
De beschrijving van het showcasemodel.
Name
categories
Type
array
Description
De categorieën van het showcasemodel.
Name
tags
Type
array
Description
De tags van het showcasemodel.
Name
mode
Type
string
Description
De mode van het showcasemodel.
Name
created_at
Type
timestamp
Description
De tijdstempel van het aanmaken van het showcasemodel (milliseconden).
Name
updated_at
Type
timestamp
Description
De tijdstempel van het bijwerken van het showcasemodel (milliseconden).

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