Enterprise API

Enterprise APIは、Meshyのエンタープライズ機能をお客様自身のアプリケーションに統合できる機能です。これらのAPI機能は、エンタープライズ層プランをご利用のユーザーのみが利用可能です。このセクションでは、このAPIを使い始めるために必要なすべての情報をご紹介します。

GET/openapi/v1/showcases

ショーケースの一覧取得

このエンドポイントでは、ダウンロード可能なコミュニティのショーケースモデルを検索して取得できます。1回のリクエストで最大10件のモデルを返すことができ、リクエストごとに1クレジットが消費されます。

パラメーター

任意の属性

  • Name
    page_size
    Type
    integer
    Description

    返却するショーケースモデルの数です。1以上10以下の正の数を指定する必要があります。該当するモデルが十分に見つからない場合、リクエストされた数より少ないモデルが返される場合があります。該当するモデルが見つからない場合は、モデルは返されません。page_sizeが指定されない場合、デフォルトは3モデルです。

  • Name
    sort_by
    Type
    string
    Description

    取得した検索結果を並べ替える方法です。指定しない場合、結果は作成時刻の新しい順(-created_at)で並べ替えられます。

    • +created_at: 作成時刻の昇順で並べ替えます。
    • -created_at: 作成時刻の降順で並べ替えます。
    • +updated_at: 更新時刻の昇順で並べ替えます。
    • -updated_at: 更新時刻の降順で並べ替えます。
    • +downloads: ダウンロード数の昇順で並べ替えます。
    • -downloads: ダウンロード数の降順で並べ替えます。
  • Name
    search
    Type
    string
    Description

    コミュニティに公開された(CC0)モデル名の中から検索するテキストです。指定しない場合、コミュニティ全体の上位モデル(sort_byに基づく)が返されます。

  • Name
    format
    Type
    string
    Description

    返却結果に希望する3Dモデルのフォーマットです。取得されるすべてのモデルは指定されたフォーマットになります。以下のいずれかの値を指定する必要があります。指定しない場合、デフォルトはglbです。

    • glb: glbフォーマット。
    • fbx: fbxフォーマット。
    • obj: objフォーマット。
    • usdz: usdzフォーマット。
  • Name
    showcase_type
    Type
    string
    Description

    返却結果に希望するモデルタイプです。取得されるすべてのモデルは指定されたタイプになります。以下のいずれかの値を指定する必要があります。指定しない場合、デフォルトはallです。

    • all: すべてのショーケースモデル。
    • animated: アニメーション付きのショーケースモデル。
    • static: 静的なショーケースモデル。

返り値

  • Name
    id
    Type
    string
    Description

    ショーケースモデルの一意な識別子です。タスクIDの実装詳細としてk-sortable UUIDを使用していますが、このIDのフォーマットについていかなる前提も置くべきではありません。

  • Name
    result_id
    Type
    string
    Description

    返却されたモデル結果の一意な識別子です。このIDはモデルに紐づいており、リメッシュなどの他のAPIタスクで直接使用できます。

  • Name
    model_url
    Type
    object
    Description

    テクスチャ付きのダウンロード可能な3Dモデルのurlです。デフォルトではglbフォーマットが返されます。

  • Name
    conversion_status
    Type
    string
    Description

    返却されたモデルのファイルタイプ変換ステータスです。

    • <empty string>: 未変換(デフォルトのglb)。
    • success: 変換に成功しました。
    • failed: 変換に失敗しました。
  • Name
    community_url
    Type
    string
    Description

    ショーケースモデルのコミュニティ閲覧リンクです。

  • Name
    author
    Type
    string
    Description

    ショーケースモデルの作者です。

  • Name
    topology
    Type
    string
    Description

    ショーケースモデルのtopology(quadまたはtriangle)です。

  • Name
    name
    Type
    string
    Description

    ショーケースモデルの名前です。

  • Name
    object_prompt
    Type
    string
    Description

    ショーケースモデルの説明です。

  • Name
    categories
    Type
    array
    Description

    ショーケースモデルのカテゴリーです。

  • Name
    tags
    Type
    array
    Description

    ショーケースモデルのタグです。

  • Name
    mode
    Type
    string
    Description

    ショーケースモデルのmodeです。

  • Name
    created_at
    Type
    timestamp
    Description

    ショーケースモデルの作成タイムスタンプ(ミリ秒)です。

  • Name
    updated_at
    Type
    timestamp
    Description

    ショーケースモデルの更新タイムスタンプ(ミリ秒)です。

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