Enterprise API

Enterprise API är en funktion som låter dig integrera Meshys Enterprise-funktioner i din egen applikation. Dessa API-funktioner är endast tillgängliga för användare på vår Enterprise-nivåplan. I detta avsnitt hittar du all information du behöver för att komma igång med detta API.

GET/openapi/v1/showcases

List Showcases

Denna endpoint låter dig söka efter och returnera community-showcasemodeller som är tillgängliga för nedladdning. Du kan returnera upp till maximalt 10 modeller i en enda förfrågan, och varje förfrågan kostar 1 credit.

Parametrar

Valfria attribut

  • Name
    page_size
    Type
    integer
    Description

    Antalet showcasemodeller att returnera. Måste vara ett positivt tal mellan 1 och 10 inklusive. Observera att det är möjligt att förfrågan kan returnera färre än det begärda antalet matchande modeller om det inte finns tillräckligt många träffar. Inga modeller returneras om inga träffar hittas. Standard är 3 modeller om page_size inte anges.

  • Name
    sort_by
    Type
    string
    Description

    Metod för att sortera de erhållna sökresultaten. Om detta inte anges kommer resultaten att sorteras efter skapandetid från senaste till äldsta (-created_at).

    • +created_at: Sortera efter skapandetid i stigande ordning.
    • -created_at: Sortera efter skapandetid i fallande ordning.
    • +updated_at: Sortera efter uppdateringstid i stigande ordning.
    • -updated_at: Sortera efter uppdateringstid i fallande ordning.
    • +downloads: Sortera efter antal nedladdningar i stigande ordning.
    • -downloads: Sortera efter antal nedladdningar i fallande ordning.
  • Name
    search
    Type
    string
    Description

    Text att söka efter bland namn på community-publicerade (CC0) modeller. Om detta inte anges returneras de mest populära community-modellerna totalt sett (baserat på sort_by).

  • Name
    format
    Type
    string
    Description

    Önskat 3d-modellformat för returnerade resultat. Alla hämtade modeller kommer att vara i det angivna formatet. Måste vara ett av nedanstående valfria värden. Om detta inte anges blir det glb som standard.

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

    Önskad modelltyp för returnerade resultat. Alla hämtade modeller kommer att vara av den angivna typen. Måste vara ett av nedanstående valfria värden. Om detta inte anges blir det all som standard.

    • all: Alla showcasemodeller.
    • animated: Animerade showcasemodeller.
    • static: Statiska showcasemodeller.

Returer

  • Name
    id
    Type
    string
    Description

    Den unika identifieraren för showcasemodellen. Även om vi använder k-sorterbar UUID som implementationsdetalj för uppgifts-id, bör du inte anta något specifikt format för id:t.

  • Name
    result_id
    Type
    string
    Description

    Den unika identifieraren för det returnerade modellresultatet. Detta ID är kopplat till modellen och kan användas direkt i andra API-uppgifter som remesh.

  • Name
    model_url
    Type
    object
    Description

    URL:en till den nedladdningsbara 3D-modellen med texturer. Returnerar som standard glb-format.

  • Name
    conversion_status
    Type
    string
    Description

    Filtypskonverteringsstatusen för de returnerade modellerna.

    • <tom sträng>: Ej konverterad (standard glb).
    • success: Konvertering lyckades.
    • failed: Konvertering misslyckades.
  • Name
    community_url
    Type
    string
    Description

    Länken för att bläddra i community för showcasemodellen.

  • Name
    author
    Type
    string
    Description

    Författaren till showcasemodellen.

  • Name
    topology
    Type
    string
    Description

    Topologin för showcasemodellen (quad eller triangle).

  • Name
    name
    Type
    string
    Description

    Namnet på showcasemodellen.

  • Name
    object_prompt
    Type
    string
    Description

    Beskrivningen av showcasemodellen.

  • Name
    categories
    Type
    array
    Description

    Kategorierna för showcasemodellen.

  • Name
    tags
    Type
    array
    Description

    Taggarna för showcasemodellen.

  • Name
    mode
    Type
    string
    Description

    Läget (mode) för showcasemodellen.

  • Name
    created_at
    Type
    timestamp
    Description

    Tidsstämpeln för när showcasemodellen skapades (millisekunder).

  • Name
    updated_at
    Type
    timestamp
    Description

    Tidsstämpeln för när showcasemodellen senast uppdaterades (millisekunder).

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