API Empresarial

A API Empresarial é uma funcionalidade que lhe permite integrar as capacidades Empresariais da Meshy na sua própria aplicação. Estas funcionalidades da API só estão disponíveis para utilizadores no nosso plano de nível empresarial. Nesta secção, encontrará todas as informações de que necessita para começar a utilizar esta API.

GET/openapi/v1/showcases

Listar Showcases

Este endpoint permite-lhe pesquisar e devolver modelos de showcase da comunidade que estão disponíveis para descarregar. Pode devolver até um máximo de 10 modelos num único pedido, e cada pedido custará 1 credit.

Parâmetros

Atributos opcionais

Name
page_size
Type
integer
Description
O número de modelos de showcase a devolver. Deve ser um número positivo entre 1 e 10, inclusive. Note que é possível que o pedido devolva menos do que o número solicitado de modelos correspondentes, caso não sejam encontradas correspondências suficientes. Não será devolvido nenhum modelo se não forem encontradas correspondências. O valor predefinido é 3 modelos caso page_size não seja 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 hora de criação, do mais recente para o mais antigo (-created_at).
- +created_at: Ordenar por hora de criação, em ordem ascendente.
- -created_at: Ordenar por hora de criação, em ordem descendente.
- +updated_at: Ordenar por hora de atualização, em ordem ascendente.
- -updated_at: Ordenar por hora de atualização, em ordem descendente.
- +downloads: Ordenar por número de descarregamentos, em ordem ascendente.
- -downloads: Ordenar por número de descarregamentos, em ordem descendente.
Name
search
Type
string
Description
Texto a pesquisar dentro dos nomes dos modelos publicados na comunidade (CC0). Se não for fornecido, serão devolvidos os principais modelos gerais da comunidade (com base em sort_by).
Name
format
Type
string
Description
Formato de modelo 3D pretendido para os resultados devolvidos. Todos os modelos obtidos estarão no formato especificado. Deve ser um dos valores opcionais abaixo. Se não for fornecido, será glb por predefinição.
- glb: formato glb.
- fbx: formato fbx.
- obj: formato obj.
- usdz: formato usdz.
Name
showcase_type
Type
string
Description
Tipo de modelo pretendido para os resultados devolvidos. Todos os modelos obtidos serão do tipo especificado. Deve ser um dos valores opcionais abaixo. Se não for fornecido, será all por predefinição.
- all: Todos os modelos de showcase.
- animated: Modelos de showcase animados.
- static: Modelos de showcase estáticos.

Devolve

Name
id
Type
string
Description
O identificador único do modelo de showcase. Embora utilizemos um UUID k-sortable como detalhe de implementação para o id da tarefa, não deve assumir qualquer formato para o id.
Name
result_id
Type
string
Description
O identificador único do resultado do modelo devolvido. Este ID está associado ao modelo e pode ser utilizado diretamente noutras tarefas da API, como o remesh.
Name
model_url
Type
object
Description
O URL do modelo 3D descarregável com texturas. Por predefinição, devolve o formato glb.
Name
conversion_status
Type
string
Description
O estado de conversão do tipo de ficheiro dos modelos devolvidos.
- <string vazia>: Não convertido (glb por predefinição).
- success: Conversão bem-sucedida.
- failed: Conversão falhada.
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
    }
  ]
}