Enterprise API

Enterprise API — это функция, позволяющая интегрировать корпоративные возможности Meshy в ваше собственное приложение. Эти функции API доступны только пользователям с корпоративным тарифным планом. В этом разделе вы найдете всю информацию, необходимую для начала работы с этим API.

GET/openapi/v1/showcases

List Showcases

Этот эндпоинт позволяет искать и возвращать модели из витрины сообщества, доступные для загрузки. Вы можете вернуть до 10 моделей максимум за один запрос, и каждый запрос будет стоить 1 credit.

Параметры

Необязательные атрибуты

  • 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

    Уникальный идентификатор модели витрины. Хотя в качестве технической реализации идентификатора задачи мы используем 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

    Статус конвертации типа файла для возвращенных моделей.

    • <пустая строка>: Не сконвертировано (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
    }
  ]
}