Enterprise API

Enterprise API adalah fitur yang memungkinkan Anda mengintegrasikan kemampuan Enterprise Meshy ke dalam aplikasi Anda sendiri. Fitur API ini hanya tersedia untuk pengguna pada paket tingkat enterprise kami. Pada bagian ini, Anda akan menemukan semua informasi yang Anda butuhkan untuk memulai dengan API ini.

GET/openapi/v1/showcases

List Showcases

Endpoint ini memungkinkan Anda mencari dan mengembalikan model showcase komunitas yang tersedia untuk diunduh. Anda dapat mengembalikan hingga maksimum 10 model dalam satu permintaan, dan setiap permintaan akan dikenakan biaya 1 credit.

Parameters

Optional attributes

  • Name
    page_size
    Type
    integer
    Description

    Jumlah model showcase yang akan dikembalikan. Harus berupa angka positif antara 1 dan 10 inklusif. Perlu diketahui bahwa permintaan mungkin mengembalikan lebih sedikit model yang cocok daripada jumlah yang diminta jika tidak ditemukan cukup kecocokan. Tidak ada model yang akan dikembalikan jika tidak ditemukan kecocokan. Default adalah 3 model jika page_size tidak diberikan.

  • Name
    sort_by
    Type
    string
    Description

    Metode untuk mengurutkan hasil pencarian yang diperoleh. Jika tidak diberikan, hasil akan diurutkan berdasarkan waktu pembuatan dari yang paling baru ke yang paling lama (-created_at).

    • +created_at: Urutkan berdasarkan waktu pembuatan secara ascending.
    • -created_at: Urutkan berdasarkan waktu pembuatan secara descending.
    • +updated_at: Urutkan berdasarkan waktu pembaruan secara ascending.
    • -updated_at: Urutkan berdasarkan waktu pembaruan secara descending.
    • +downloads: Urutkan berdasarkan jumlah unduhan secara ascending.
    • -downloads: Urutkan berdasarkan jumlah unduhan secara descending.
  • Name
    search
    Type
    string
    Description

    Teks untuk dicari di dalam nama model yang dipublikasikan oleh komunitas (CC0). Jika tidak diberikan, maka model komunitas teratas secara keseluruhan (berdasarkan sort_by) akan dikembalikan.

  • Name
    format
    Type
    string
    Description

    Format model 3d yang diinginkan untuk hasil yang dikembalikan. Semua model yang diambil akan berada dalam format yang ditentukan. Harus salah satu dari nilai opsional di bawah ini. Jika tidak diberikan, akan menjadi glb secara default.

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

    Tipe model yang diinginkan untuk hasil yang dikembalikan. Semua model yang diambil akan berada dalam tipe yang ditentukan. Harus salah satu dari nilai opsional di bawah ini. Jika tidak diberikan, akan menjadi all secara default.

    • all: Semua model showcase.
    • animated: Model showcase beranimasi.
    • static: Model showcase statis.

Returns

  • Name
    id
    Type
    string
    Description

    Pengenal unik untuk model showcase. Meskipun kami menggunakan UUID yang dapat diurutkan-k (k-sortable) sebagai detail implementasi untuk id tugas, Anda tidak seharusnya mengasumsikan format tertentu untuk id tersebut.

  • Name
    result_id
    Type
    string
    Description

    Pengenal unik untuk hasil model yang dikembalikan. ID ini terhubung dengan model dan dapat digunakan langsung dalam tugas API lainnya seperti remesh.

  • Name
    model_url
    Type
    object
    Description

    URL model 3D yang dapat diunduh beserta texture-nya. Secara default mengembalikan format glb.

  • Name
    conversion_status
    Type
    string
    Description

    Status konversi jenis file dari model yang dikembalikan.

    • <empty string>: Tidak dikonversi (default glb).
    • success: Konversi berhasil.
    • failed: Konversi gagal.
  • Name
    community_url
    Type
    string
    Description

    Tautan penelusuran komunitas untuk model showcase.

  • Name
    author
    Type
    string
    Description

    Penulis model showcase.

  • Name
    topology
    Type
    string
    Description

    Topology dari model showcase (quad atau triangle).

  • Name
    name
    Type
    string
    Description

    Nama model showcase.

  • Name
    object_prompt
    Type
    string
    Description

    Deskripsi model showcase.

  • Name
    categories
    Type
    array
    Description

    Kategori dari model showcase.

  • Name
    tags
    Type
    array
    Description

    Tag dari model showcase.

  • Name
    mode
    Type
    string
    Description

    Mode dari model showcase.

  • Name
    created_at
    Type
    timestamp
    Description

    Stempel waktu pembuatan model showcase (milidetik).

  • Name
    updated_at
    Type
    timestamp
    Description

    Stempel waktu pembaruan model showcase (milidetik).

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