Enterprise API

Ang Enterprise API ay isang feature na nagbibigay-daan sa iyong isama ang mga kakayahan ng Enterprise ng Meshy sa iyong sariling application. Ang mga feature ng API na ito ay available lamang sa mga user na nasa enterprise tier plan namin. Sa seksyong ito, makikita mo ang lahat ng impormasyon na kailangan mo para makapagsimula sa API na ito.

GET/openapi/v1/showcases

List Showcases

Ang endpoint na ito ay nagbibigay-daan sa iyong maghanap at ibalik ang mga showcase model ng komunidad na available para sa pag-download. Maaari kang magbalik ng hanggang 10 maximum na mga model sa isang kahilingan, at ang bawat kahilingan ay magkakaroon ng gastos na 1 credit.

Mga Parameter

Opsyonal na attributes

  • Name
    page_size
    Type
    integer
    Description

    Ang bilang ng mga showcase model na ibabalik. Dapat isang positibong numero sa pagitan ng 1 at 10 kasama. Pansinin na posible na ang kahilingan ay magbalik ng mas kaunti sa hinihinging bilang ng mga tumutugmang model kung hindi sapat ang mga natagpuang tugma. Walang mga model na ibabalik kung walang tugmang natagpuan. Ang default ay 3 na mga model kung hindi ibinigay ang page_size.

  • Name
    sort_by
    Type
    string
    Description

    Paraan sa pag-sort ng mga nakuhang resulta ng paghahanap. Kung hindi ibinigay, ang mga resulta ay isasaayos ayon sa oras ng paglikha mula sa pinakabago hanggang pinakaluma (-created_at).

    • +created_at: Isaayos ayon sa oras ng paglikha sa pataas na pagkakasunod-sunod.
    • -created_at: Isaayos ayon sa oras ng paglikha sa pababang pagkakasunod-sunod.
    • +updated_at: Isaayos ayon sa oras ng pag-update sa pataas na pagkakasunod-sunod.
    • -updated_at: Isaayos ayon sa oras ng pag-update sa pababang pagkakasunod-sunod.
    • +downloads: Isaayos ayon sa bilang ng mga download sa pataas na pagkakasunod-sunod.
    • -downloads: Isaayos ayon sa bilang ng mga download sa pababang pagkakasunod-sunod.
  • Name
    search
    Type
    string
    Description

    Teksto na hahanapin sa loob ng mga pangalan ng model na naka-publish sa komunidad (CC0). Kung hindi ibinigay, ang mga nangungunang model ng komunidad sa kabuuan (batay sa sort_by) ang ibabalik.

  • Name
    format
    Type
    string
    Description

    Ang nais na 3d model format para sa mga resultang ibabalik. Ang lahat ng mga model na makukuha ay magiging sa tinukoy na format. Dapat isa sa mga opsyonal na value sa ibaba. Kung hindi ibinigay, ang glb ang gagamitin bilang default.

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

    Ang nais na uri ng model para sa mga resultang ibabalik. Ang lahat ng mga model na makukuha ay magiging sa tinukoy na uri. Dapat isa sa mga opsyonal na value sa ibaba. Kung hindi ibinigay, ang all ang gagamitin bilang default.

    • all: Lahat ng mga showcase model.
    • animated: Mga animated na showcase model.
    • static: Mga static na showcase model.

Ibinabalik

  • Name
    id
    Type
    string
    Description

    Ang natatanging identifier para sa showcase model. Bagama't gumagamit kami ng k-sortable UUID bilang implementation detail para sa task id, hindi mo dapat ipagpalagay ang anumang format para sa id.

  • Name
    result_id
    Type
    string
    Description

    Ang natatanging identifier para sa ibinalik na resulta ng model. Ang ID na ito ay naka-link sa model at maaaring gamitin nang direkta sa iba pang mga API task tulad ng remesh.

  • Name
    model_url
    Type
    object
    Description

    Ang URL ng downloadable na 3D model na may mga texture. Ang default ay nagbabalik ng glb format.

  • Name
    conversion_status
    Type
    string
    Description

    Ang status ng conversion ng filetype ng mga ibinalik na model.

    • <empty string>: Hindi na-convert (default glb).
    • success: Matagumpay ang conversion.
    • failed: Nabigo ang conversion.
  • Name
    community_url
    Type
    string
    Description

    Ang link sa pagba-browse sa komunidad ng showcase model.

  • Name
    author
    Type
    string
    Description

    Ang author ng showcase model.

  • Name
    topology
    Type
    string
    Description

    Ang topology ng showcase model (quad o triangle).

  • Name
    name
    Type
    string
    Description

    Ang pangalan ng showcase model.

  • Name
    object_prompt
    Type
    string
    Description

    Ang paglalarawan ng showcase model.

  • Name
    categories
    Type
    array
    Description

    Ang mga kategorya ng showcase model.

  • Name
    tags
    Type
    array
    Description

    Ang mga tag ng showcase model.

  • Name
    mode
    Type
    string
    Description

    Ang mode ng showcase model.

  • Name
    created_at
    Type
    timestamp
    Description

    Ang timestamp ng paglikha ng showcase model (milliseconds).

  • Name
    updated_at
    Type
    timestamp
    Description

    Ang timestamp ng pag-update ng showcase model (milliseconds).

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