Kurumsal API

Kurumsal API, Meshy'nin Kurumsal özelliklerini kendi uygulamanıza entegre etmenizi sağlayan bir özelliktir. Bu API özellikleri yalnızca kurumsal katman planımızdaki kullanıcılar için kullanılabilir. Bu bölümde, bu API ile başlamak için ihtiyacınız olan tüm bilgileri bulacaksınız.

GET/openapi/v1/showcases

Vitrinleri Listele

Bu uç nokta, indirilmeye hazır topluluk vitrin modellerini aramanıza ve döndürmenize olanak tanır. Tek bir istekte en fazla 10 model döndürebilirsiniz ve her istek 1 credit'e mal olur.

Parametreler

Opsiyonel özellikler

  • Name
    page_size
    Type
    integer
    Description

    Döndürülecek vitrin modeli sayısı. 1 ile 10 arasında (dahil) pozitif bir sayı olmalıdır. Yeterli eşleşme bulunamazsa isteğin talep edilen sayıdan daha az eşleşen model döndürebileceğini unutmayın. Eşleşme bulunamazsa hiçbir model döndürülmez. page_size sağlanmazsa varsayılan olarak 3 model döndürülür.

  • Name
    sort_by
    Type
    string
    Description

    Elde edilen arama sonuçlarını sıralama yöntemi. Sağlanmazsa, sonuçlar oluşturulma zamanına göre en yeniden en eskiye sıralanır (-created_at).

    • +created_at: Oluşturulma zamanına göre artan sırada sıralar.
    • -created_at: Oluşturulma zamanına göre azalan sırada sıralar.
    • +updated_at: Güncellenme zamanına göre artan sırada sıralar.
    • -updated_at: Güncellenme zamanına göre azalan sırada sıralar.
    • +downloads: İndirme sayısına göre artan sırada sıralar.
    • -downloads: İndirme sayısına göre azalan sırada sıralar.
  • Name
    search
    Type
    string
    Description

    Topluluk tarafından yayınlanan (CC0) model adları içinde aranacak metin. Sağlanmazsa, genel olarak en üst sıradaki topluluk modelleri (sort_by'ye göre) döndürülür.

  • Name
    format
    Type
    string
    Description

    Döndürülen sonuçlar için istenen 3d model formatı. Alınan tüm modeller belirtilen formatta olacaktır. Aşağıdaki opsiyonel değerlerden biri olmalıdır. Sağlanmazsa, varsayılan olarak glb olacaktır.

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

    Döndürülen sonuçlar için istenen model türü. Alınan tüm modeller belirtilen türde olacaktır. Aşağıdaki opsiyonel değerlerden biri olmalıdır. Sağlanmazsa, varsayılan olarak all olacaktır.

    • all: Tüm vitrin modelleri.
    • animated: Animasyonlu vitrin modelleri.
    • static: Statik vitrin modelleri.

Döndürülenler

  • Name
    id
    Type
    string
    Description

    Vitrin modeli için benzersiz tanımlayıcı. Görev kimliği için uygulama detayı olarak k-sıralanabilir UUID kullansak da, kimlik için herhangi bir format varsaymamalısınız.

  • Name
    result_id
    Type
    string
    Description

    Döndürülen model sonucu için benzersiz tanımlayıcı. Bu kimlik modele bağlıdır ve remesh gibi diğer API görevlerinde doğrudan kullanılabilir.

  • Name
    model_url
    Type
    object
    Description

    Dokularla birlikte indirilebilir 3D modelin URL'si. Varsayılan olarak glb formatı döndürülür.

  • Name
    conversion_status
    Type
    string
    Description

    Döndürülen modellerin dosya türü dönüştürme durumu.

    • <empty string>: Dönüştürülmedi (varsayılan glb).
    • success: Dönüştürme başarılı.
    • failed: Dönüştürme başarısız.
  • Name
    community_url
    Type
    string
    Description

    Vitrin modelinin topluluk göz atma bağlantısı.

  • Name
    author
    Type
    string
    Description

    Vitrin modelinin yazarı.

  • Name
    topology
    Type
    string
    Description

    Vitrin modelinin topology'si (quad veya triangle).

  • Name
    name
    Type
    string
    Description

    Vitrin modelinin adı.

  • Name
    object_prompt
    Type
    string
    Description

    Vitrin modelinin açıklaması.

  • Name
    categories
    Type
    array
    Description

    Vitrin modelinin kategorileri.

  • Name
    tags
    Type
    array
    Description

    Vitrin modelinin etiketleri.

  • Name
    mode
    Type
    string
    Description

    Vitrin modelinin mode'u.

  • Name
    created_at
    Type
    timestamp
    Description

    Vitrin modelinin oluşturulma zaman damgası (milisaniye).

  • Name
    updated_at
    Type
    timestamp
    Description

    Vitrin modelinin güncellenme zaman damgası (milisaniye).

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