Enterprise API

Enterprise API는 Meshy의 Enterprise 기능을 여러분의 애플리케이션에 통합할 수 있도록 해주는 기능입니다. 이 API 기능은 Enterprise 등급 요금제를 사용하는 사용자만 이용할 수 있습니다. 이 섹션에서는 이 API를 시작하는 데 필요한 모든 정보를 확인할 수 있습니다.

GET/openapi/v1/showcases

쇼케이스 목록 조회

이 엔드포인트를 사용하면 다운로드 가능한 커뮤니티 쇼케이스 모델을 검색하고 반환할 수 있습니다. 한 번의 요청으로 최대 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

    쇼케이스 모델의 고유 식별자입니다. task 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

    반환된 모델의 파일 형식 변환 상태입니다.

    • <빈 문자열>: 변환되지 않음(기본 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
    }
  ]
}