API Enterprise

La API Enterprise es una función que le permite integrar las capacidades Enterprise de Meshy en su propia aplicación. Estas funciones de la API solo están disponibles para usuarios con nuestro plan de nivel enterprise. En esta sección, encontrará toda la información que necesita para comenzar a utilizar esta API.

GET/openapi/v1/showcases

Listar Showcases

Este endpoint le permite buscar y devolver modelos de showcase de la comunidad que están disponibles para descargar. Puede devolver un máximo de 10 modelos en una sola solicitud, y cada solicitud costará 1 crédito.

Parámetros

Atributos opcionales

Name
page_size
Type
integer
Description
La cantidad de modelos de showcase a devolver. Debe ser un número positivo entre 1 y 10 inclusive. Tenga en cuenta que es posible que la solicitud devuelva menos del número solicitado de modelos coincidentes si no hay suficientes coincidencias encontradas. No se devolverá ningún modelo si no se encuentran coincidencias. El valor predeterminado es 3 modelos si no se proporciona page_size.
Name
sort_by
Type
string
Description
Método para ordenar los resultados de búsqueda obtenidos. Si no se proporciona, los resultados se ordenarán por hora de creación, del más reciente al más antiguo (-created_at).
- +created_at: Ordenar por hora de creación en orden ascendente.
- -created_at: Ordenar por hora de creación en orden descendente.
- +updated_at: Ordenar por hora de actualización en orden ascendente.
- -updated_at: Ordenar por hora de actualización en orden descendente.
- +downloads: Ordenar por número de descargas en orden ascendente.
- -downloads: Ordenar por número de descargas en orden descendente.
Name
search
Type
string
Description
Texto a buscar dentro de los nombres de modelos publicados por la comunidad (CC0). Si no se proporciona, se devolverán los principales modelos generales de la comunidad (según sort_by).
Name
format
Type
string
Description
Formato de modelo 3D deseado para los resultados devueltos. Todos los modelos obtenidos estarán en el formato especificado. Debe ser uno de los siguientes valores opcionales. Si no se proporciona, será glb de forma predeterminada.
- glb: formato glb.
- fbx: formato fbx.
- obj: formato obj.
- usdz: formato usdz.
Name
showcase_type
Type
string
Description
Tipo de modelo deseado para los resultados devueltos. Todos los modelos obtenidos serán del tipo especificado. Debe ser uno de los siguientes valores opcionales. Si no se proporciona, será all de forma predeterminada.
- all: Todos los modelos de showcase.
- animated: Modelos de showcase animados.
- static: Modelos de showcase estáticos.

Devuelve

Name
id
Type
string
Description
El identificador único del modelo de showcase. Aunque usamos un UUID ordenable por k como detalle de implementación para el id de la tarea, no debería asumir ningún formato para el id.
Name
result_id
Type
string
Description
El identificador único del resultado del modelo devuelto. Este ID está vinculado al modelo y se puede usar directamente en otras tareas de la API, como remesh.
Name
model_url
Type
object
Description
La URL del modelo 3D descargable con texturas. De forma predeterminada, devuelve el formato glb.
Name
conversion_status
Type
string
Description
El estado de conversión del tipo de archivo de los modelos devueltos.
- <cadena vacía>: No convertido (glb predeterminado).
- success: Conversión exitosa.
- failed: Conversión fallida.
Name
community_url
Type
string
Description
El enlace de navegación de la comunidad del modelo de showcase.
Name
author
Type
string
Description
El autor del modelo de showcase.
Name
topology
Type
string
Description
La topology del modelo de showcase (quad o triangle).
Name
name
Type
string
Description
El nombre del modelo de showcase.
Name
object_prompt
Type
string
Description
La descripción del modelo de showcase.
Name
categories
Type
array
Description
Las categorías del modelo de showcase.
Name
tags
Type
array
Description
Las etiquetas del modelo de showcase.
Name
mode
Type
string
Description
El mode del modelo de showcase.
Name
created_at
Type
timestamp
Description
La marca de tiempo de creación del modelo de showcase (milisegundos).
Name
updated_at
Type
timestamp
Description
La marca de tiempo de actualización del modelo de showcase (milisegundos).

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