Enterprise API

Enterprise API adalah ciri yang membolehkan anda mengintegrasikan keupayaan Enterprise Meshy ke dalam aplikasi anda sendiri. Ciri API ini hanya tersedia untuk pengguna pada pelan tier enterprise kami. Dalam bahagian ini, anda akan menemui semua maklumat yang anda perlukan untuk bermula dengan API ini.

GET/openapi/v1/showcases

Senaraikan Showcase

Endpoint ini membolehkan anda mencari dan mengembalikan model showcase komuniti yang tersedia untuk dimuat turun. Anda boleh mengembalikan maksimum 10 model dalam satu permintaan, dan setiap permintaan akan mengenakan kos 1 credit.

Parameter

Atribut pilihan

Name
page_size
Type
integer
Description
Bilangan model showcase yang akan dikembalikan. Mestilah nombor positif antara 1 dan 10 termasuk kedua-duanya. Ambil perhatian bahawa adalah mungkin permintaan mengembalikan bilangan model yang sepadan kurang daripada yang diminta jika tidak terdapat cukup padanan yang dijumpai. Tiada model akan dikembalikan jika tiada padanan dijumpai. Lalai adalah 3 model jika page_size tidak diberikan.
Name
sort_by
Type
string
Description
Kaedah untuk menyusun hasil carian yang diperoleh. Jika tidak diberikan, hasil akan disusun mengikut masa penciptaan dari yang paling baru kepada yang paling awal (-created_at).
- +created_at: Susun mengikut masa penciptaan dalam susunan menaik.
- -created_at: Susun mengikut masa penciptaan dalam susunan menurun.
- +updated_at: Susun mengikut masa kemas kini dalam susunan menaik.
- -updated_at: Susun mengikut masa kemas kini dalam susunan menurun.
- +downloads: Susun mengikut bilangan muat turun dalam susunan menaik.
- -downloads: Susun mengikut bilangan muat turun dalam susunan menurun.
Name
search
Type
string
Description
Teks untuk dicari dalam nama model komuniti yang diterbitkan (CC0). Jika tidak diberikan, model komuniti teratas keseluruhan (berdasarkan sort_by) akan dikembalikan.
Name
format
Type
string
Description
Format model 3D yang dikehendaki untuk hasil yang dikembalikan. Semua model yang diperoleh akan berada dalam format yang ditentukan. Mestilah salah satu daripada nilai pilihan di bawah. Jika tidak diberikan, lalai adalah glb.
- glb: format glb.
- fbx: format fbx.
- obj: format obj.
- usdz: format usdz.
Name
showcase_type
Type
string
Description
Jenis model yang dikehendaki untuk hasil yang dikembalikan. Semua model yang diperoleh akan berada dalam jenis yang ditentukan. Mestilah salah satu daripada nilai pilihan di bawah. Jika tidak diberikan, lalai adalah all.
- all: Semua model showcase.
- animated: Model showcase beranimasi.
- static: Model showcase statik.

Mengembalikan

Name
id
Type
string
Description
Pengecam unik untuk model showcase. Walaupun kami menggunakan UUID yang boleh disusun-k sebagai perincian pelaksanaan untuk id tugas, anda tidak seharusnya menganggap sebarang format untuk id tersebut.
Name
result_id
Type
string
Description
Pengecam unik untuk hasil model yang dikembalikan. ID ini dikaitkan dengan model dan boleh digunakan secara terus dalam tugas API lain seperti remesh.
Name
model_url
Type
object
Description
URL bagi model 3D yang boleh dimuat turun berserta texture. Secara lalai mengembalikan format glb.
Name
conversion_status
Type
string
Description
Status penukaran jenis fail bagi model yang dikembalikan.
- <empty string>: Tidak ditukar (glb lalai).
- success: Penukaran berjaya.
- failed: Penukaran gagal.
Name
community_url
Type
string
Description
Pautan penyemakan imbas komuniti untuk model showcase.
Name
author
Type
string
Description
Pengarang model showcase.
Name
topology
Type
string
Description
Topology model showcase (quad atau triangle).
Name
name
Type
string
Description
Nama model showcase.
Name
object_prompt
Type
string
Description
Penerangan model showcase.
Name
categories
Type
array
Description
Kategori model showcase.
Name
tags
Type
array
Description
Tag model showcase.
Name
mode
Type
string
Description
Mode model showcase.
Name
created_at
Type
timestamp
Description
Cap masa penciptaan model showcase (milisaat).
Name
updated_at
Type
timestamp
Description
Cap masa kemas kini model showcase (milisaat).

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