Enterprise API

Enterprise API — це функція, яка дозволяє інтегрувати можливості Meshy Enterprise у вашу власну програму. Ці можливості API доступні лише для користувачів з нашим тарифним планом enterprise. У цьому розділі ви знайдете всю інформацію, необхідну для початку роботи з цим API.

GET/openapi/v1/showcases

List Showcases

Ця кінцева точка дозволяє шукати та повертати моделі зі спільноти showcase, доступні для завантаження. Ви можете повернути до 10 моделей максимум за один запит, і кожен запит коштуватиме 1 credit.

Параметри

Необов'язкові атрибути

  • Name
    page_size
    Type
    integer
    Description

    Кількість моделей showcase для повернення. Має бути додатним числом від 1 до 10 включно. Зверніть увагу, що запит може повернути менше моделей, ніж запитано, якщо не знайдено достатньо збігів. Жодної моделі не буде повернено, якщо збігів не знайдено. За замовчуванням буде повернено 3 моделі, якщо page_size не вказано.

  • 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: Усі моделі showcase.
    • animated: Анімовані моделі showcase.
    • static: Статичні моделі showcase.

Повертає

  • Name
    id
    Type
    string
    Description

    Унікальний ідентифікатор моделі showcase. Хоча ми використовуємо k-sortable UUID як деталь реалізації для ідентифікатора завдання, ви не повинні припускати будь-який формат для id.

  • Name
    result_id
    Type
    string
    Description

    Унікальний ідентифікатор повернутого результату моделі. Цей ID пов'язаний з моделлю і може бути використаний безпосередньо в інших завданнях API, таких як remesh.

  • Name
    model_url
    Type
    object
    Description

    URL завантажуваної 3D-моделі з текстурами. За замовчуванням повертає формат glb.

  • Name
    conversion_status
    Type
    string
    Description

    Статус конвертації типу файлу повернутих моделей.

    • <empty string>: Не конвертовано (за замовчуванням glb).
    • success: Конвертація успішна.
    • failed: Конвертація не вдалася.
  • Name
    community_url
    Type
    string
    Description

    Посилання на перегляд моделі showcase у спільноті.

  • Name
    author
    Type
    string
    Description

    Автор моделі showcase.

  • Name
    topology
    Type
    string
    Description

    Topology моделі showcase (quad або triangle).

  • Name
    name
    Type
    string
    Description

    Назва моделі showcase.

  • Name
    object_prompt
    Type
    string
    Description

    Опис моделі showcase.

  • Name
    categories
    Type
    array
    Description

    Категорії моделі showcase.

  • Name
    tags
    Type
    array
    Description

    Теги моделі showcase.

  • Name
    mode
    Type
    string
    Description

    Mode моделі showcase.

  • Name
    created_at
    Type
    timestamp
    Description

    Мітка часу створення моделі showcase (у мілісекундах).

  • Name
    updated_at
    Type
    timestamp
    Description

    Мітка часу оновлення моделі showcase (у мілісекундах).

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