Enterprise API

Enterprise API to funkcja, która pozwala zintegrować możliwości Enterprise Meshy z Twoją własną aplikacją. Te funkcje API są dostępne wyłącznie dla użytkowników korzystających z naszego planu enterprise. W tej sekcji znajdziesz wszystkie informacje potrzebne do rozpoczęcia pracy z tym API.

GET/openapi/v1/showcases

List Showcases

Ten punkt końcowy pozwala wyszukiwać i zwracać modele showcase społeczności dostępne do pobrania. Możesz zwrócić maksymalnie 10 modeli w jednym żądaniu, a każde żądanie będzie kosztować 1 credit.

Parametry

Atrybuty opcjonalne

Name
page_size
Type
integer
Description
Liczba modeli showcase do zwrócenia. Musi być liczbą dodatnią pomiędzy 1 a 10 włącznie. Zwróć uwagę, że żądanie może zwrócić mniej modeli niż żądana liczba, jeśli nie znaleziono wystarczającej liczby dopasowań. Jeśli nie znaleziono żadnych dopasowań, nie zostaną zwrócone żadne modele. Domyślnie zwracane są 3 modele, jeśli page_size nie zostanie podane.
Name
sort_by
Type
string
Description
Metoda sortowania uzyskanych wyników wyszukiwania. Jeśli nie zostanie podana, wyniki będą sortowane według czasu utworzenia od najnowszych do najstarszych (-created_at).
- +created_at: Sortuj według czasu utworzenia rosnąco.
- -created_at: Sortuj według czasu utworzenia malejąco.
- +updated_at: Sortuj według czasu aktualizacji rosnąco.
- -updated_at: Sortuj według czasu aktualizacji malejąco.
- +downloads: Sortuj według liczby pobrań rosnąco.
- -downloads: Sortuj według liczby pobrań malejąco.
Name
search
Type
string
Description
Tekst do wyszukania w nazwach modeli opublikowanych przez społeczność (CC0). Jeśli nie zostanie podany, zwrócone zostaną najlepsze ogólne modele społeczności (na podstawie sort_by).
Name
format
Type
string
Description
Żądany format modelu 3D dla zwracanych wyników. Wszystkie pobrane modele będą w podanym formacie. Musi być jedną z poniższych opcjonalnych wartości. Jeśli nie zostanie podany, domyślnie będzie to glb.
- glb: format glb.
- fbx: format fbx.
- obj: format obj.
- usdz: format usdz.
Name
showcase_type
Type
string
Description
Żądany typ modelu dla zwracanych wyników. Wszystkie pobrane modele będą w podanym typie. Musi być jedną z poniższych opcjonalnych wartości. Jeśli nie zostanie podany, domyślnie będzie to all.
- all: Wszystkie modele showcase.
- animated: Animowane modele showcase.
- static: Statyczne modele showcase.

Zwraca

Name
id
Type
string
Description
Unikalny identyfikator modelu showcase. Chociaż jako szczegół implementacyjny identyfikatora zadania używamy k-sortowalnego UUID, nie powinieneś zakładać żadnego konkretnego formatu dla id.
Name
result_id
Type
string
Description
Unikalny identyfikator zwróconego wyniku modelu. To ID jest powiązane z modelem i może być użyte bezpośrednio w innych zadaniach API, takich jak remesh.
Name
model_url
Type
object
Description
URL do pobrania modelu 3D wraz z teksturami. Domyślnie zwraca format glb.
Name
conversion_status
Type
string
Description
Status konwersji typu pliku zwróconych modeli.
- <pusty ciąg>: Brak konwersji (domyślnie glb).
- success: Konwersja zakończona pomyślnie.
- failed: Konwersja nie powiodła się.
Name
community_url
Type
string
Description
Link do przeglądania modelu showcase w społeczności.
Name
author
Type
string
Description
Autor modelu showcase.
Name
topology
Type
string
Description
Topology modelu showcase (quad lub triangle).
Name
name
Type
string
Description
Nazwa modelu showcase.
Name
object_prompt
Type
string
Description
Opis modelu showcase.
Name
categories
Type
array
Description
Kategorie modelu showcase.
Name
tags
Type
array
Description
Tagi modelu showcase.
Name
mode
Type
string
Description
Mode modelu showcase.
Name
created_at
Type
timestamp
Description
Znacznik czasu utworzenia modelu showcase (w milisekundach).
Name
updated_at
Type
timestamp
Description
Znacznik czasu aktualizacji modelu showcase (w milisekundach).

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