API Enterprise

API Enterprise é um recurso que permite integrar os recursos Enterprise da Meshy à sua própria aplicação. Esses recursos de API estão disponíveis apenas para usuários do nosso plano de nível enterprise. Nesta seção, você encontrará todas as informações necessárias para começar a usar essa API.

GET/openapi/v1/showcases

Listar Showcases

Este endpoint permite pesquisar e retornar modelos de showcase da comunidade disponíveis para download. Você pode retornar até 10 modelos no máximo em uma única solicitação, e cada solicitação custará 1 credit.

Parâmetros

Atributos opcionais

Name
page_size
Type
integer
Description
O número de modelos de showcase a retornar. Deve ser um número positivo entre 1 e 10, inclusive. Observe que é possível que a solicitação retorne menos do que o número solicitado de modelos correspondentes, caso não haja correspondências suficientes encontradas. Nenhum modelo será retornado se nenhuma correspondência for encontrada. O padrão é 3 modelos se page_size não for fornecido.
Name
sort_by
Type
string
Description
Método para ordenar os resultados de pesquisa obtidos. Se não for fornecido, os resultados serão ordenados por horário de criação, do mais recente ao mais antigo (-created_at).
- +created_at: Ordenar por horário de criação em ordem crescente.
- -created_at: Ordenar por horário de criação em ordem decrescente.
- +updated_at: Ordenar por horário de atualização em ordem crescente.
- -updated_at: Ordenar por horário de atualização em ordem decrescente.
- +downloads: Ordenar por número de downloads em ordem crescente.
- -downloads: Ordenar por número de downloads em ordem decrescente.
Name
search
Type
string
Description
Texto a ser pesquisado nos nomes de modelos publicados pela comunidade (CC0). Se não for fornecido, os principais modelos gerais da comunidade (com base em sort_by) serão retornados.
Name
format
Type
string
Description
Formato de modelo 3D desejado para os resultados retornados. Todos os modelos obtidos estarão no formato especificado. Deve ser um dos valores opcionais abaixo. Se não for fornecido, o padrão será glb.
- glb: formato glb.
- fbx: formato fbx.
- obj: formato obj.
- usdz: formato usdz.
Name
showcase_type
Type
string
Description
Tipo de modelo desejado para os resultados retornados. Todos os modelos obtidos serão do tipo especificado. Deve ser um dos valores opcionais abaixo. Se não for fornecido, o padrão será all.
- all: Todos os modelos de showcase.
- animated: Modelos de showcase animados.
- static: Modelos de showcase estáticos.

Retornos

Name
id
Type
string
Description
O identificador exclusivo do modelo de showcase. Embora usemos UUID k-sortable como detalhe de implementação para o id da tarefa, você não deve presumir nenhum formato para o id.
Name
result_id
Type
string
Description
O identificador exclusivo do resultado do modelo retornado. Este ID está vinculado ao modelo e pode ser usado diretamente em outras tarefas de API, como remesh.
Name
model_url
Type
object
Description
A URL do modelo 3D para download com texturas. Retorna por padrão o formato glb.
Name
conversion_status
Type
string
Description
O status de conversão do tipo de arquivo dos modelos retornados.
- <string vazia>: Não convertido (padrão glb).
- success: Conversão bem-sucedida.
- failed: Falha na conversão.
Name
community_url
Type
string
Description
O link de navegação na comunidade do modelo de showcase.
Name
author
Type
string
Description
O autor do modelo de showcase.
Name
topology
Type
string
Description
A topology do modelo de showcase (quad ou triangle).
Name
name
Type
string
Description
O nome do modelo de showcase.
Name
object_prompt
Type
string
Description
A descrição do modelo de showcase.
Name
categories
Type
array
Description
As categorias do modelo de showcase.
Name
tags
Type
array
Description
As tags do modelo de showcase.
Name
mode
Type
string
Description
O mode do modelo de showcase.
Name
created_at
Type
timestamp
Description
O carimbo de data/hora da criação do modelo de showcase (milissegundos).
Name
updated_at
Type
timestamp
Description
O carimbo de data/hora da atualização do modelo de showcase (milissegundos).

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