Enterprise API

Enterprise API je funkce, která vám umožňuje integrovat Enterprise možnosti Meshy do vaší vlastní aplikace. Tyto funkce API jsou dostupné pouze uživatelům s naším enterprise tarifem. V této části najdete všechny informace, které potřebujete k tomu, abyste s tímto API mohli začít.

GET/openapi/v1/showcases

List Showcases

Tento koncový bod vám umožňuje vyhledávat a vracet modely z komunitní výstavní galerie (showcase), které jsou dostupné ke stažení. V jednom požadavku můžete vrátit maximálně 10 modelů a každý požadavek stojí 1 kredit.

Parametry

Volitelné atributy

  • Name
    page_size
    Type
    integer
    Description

    Počet výstavních modelů, které se mají vrátit. Musí to být kladné číslo v rozmezí 1 až 10 včetně. Upozorňujeme, že je možné, že požadavek vrátí méně modelů, než bylo požadováno, pokud není nalezeno dostatek shod. Pokud nejsou nalezeny žádné shody, nebudou vráceny žádné modely. Výchozí hodnota jsou 3 modely, pokud page_size není zadáno.

  • Name
    sort_by
    Type
    string
    Description

    Metoda řazení získaných výsledků vyhledávání. Pokud není zadáno, výsledky se seřadí podle času vytvoření od nejnovějšího po nejstarší (-created_at).

    • +created_at: Řazení podle času vytvoření vzestupně.
    • -created_at: Řazení podle času vytvoření sestupně.
    • +updated_at: Řazení podle času aktualizace vzestupně.
    • -updated_at: Řazení podle času aktualizace sestupně.
    • +downloads: Řazení podle počtu stažení vzestupně.
    • -downloads: Řazení podle počtu stažení sestupně.
  • Name
    search
    Type
    string
    Description

    Text, který se má vyhledat v názvech modelů zveřejněných komunitou (CC0). Pokud není zadáno, budou vráceny nejlepší celkové komunitní modely (na základě sort_by).

  • Name
    format
    Type
    string
    Description

    Požadovaný formát 3D modelu pro vrácené výsledky. Všechny získané modely budou v zadaném formátu. Musí být jednou z níže uvedených volitelných hodnot. Pokud není zadáno, výchozí hodnota je glb.

    • glb: formát glb.
    • fbx: formát fbx.
    • obj: formát obj.
    • usdz: formát usdz.
  • Name
    showcase_type
    Type
    string
    Description

    Požadovaný typ modelu pro vrácené výsledky. Všechny získané modely budou zadaného typu. Musí být jednou z níže uvedených volitelných hodnot. Pokud není zadáno, výchozí hodnota je all.

    • all: Všechny výstavní modely.
    • animated: Animované výstavní modely.
    • static: Statické výstavní modely.

Návratové hodnoty

  • Name
    id
    Type
    string
    Description

    Jedinečný identifikátor výstavního modelu. Ačkoliv jako implementační detail pro id úlohy používáme k-sortable UUID, neměli byste předpokládat žádný konkrétní formát id.

  • Name
    result_id
    Type
    string
    Description

    Jedinečný identifikátor vráceného výsledku modelu. Toto ID je propojeno s modelem a lze jej přímo použít v jiných úlohách API, jako je remesh.

  • Name
    model_url
    Type
    object
    Description

    URL adresa 3D modelu s texturami ke stažení. Výchozí návratová hodnota je ve formátu glb.

  • Name
    conversion_status
    Type
    string
    Description

    Stav konverze typu souboru vrácených modelů.

    • <prázdný řetězec>: Nekonvertováno (výchozí glb).
    • success: Konverze úspěšná.
    • failed: Konverze se nezdařila.
  • Name
    community_url
    Type
    string
    Description

    Odkaz na procházení výstavního modelu v komunitě.

  • Name
    author
    Type
    string
    Description

    Autor výstavního modelu.

  • Name
    topology
    Type
    string
    Description

    Topology výstavního modelu (quad nebo triangle).

  • Name
    name
    Type
    string
    Description

    Název výstavního modelu.

  • Name
    object_prompt
    Type
    string
    Description

    Popis výstavního modelu.

  • Name
    categories
    Type
    array
    Description

    Kategorie výstavního modelu.

  • Name
    tags
    Type
    array
    Description

    Štítky výstavního modelu.

  • Name
    mode
    Type
    string
    Description

    Mode výstavního modelu.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko vytvoření výstavního modelu (v milisekundách).

  • Name
    updated_at
    Type
    timestamp
    Description

    Časové razítko aktualizace výstavního modelu (v milisekundách).

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