API de Remesh
A API de Remesh permite-lhe remesh e exportar modelos 3D existentes gerados por outras APIs da Meshy (como Imagem para 3D ou Texto para 3D) em vários formatos. Esta secção fornece detalhes sobre como utilizar a API de Remesh.
Criar uma Tarefa de Remesh
Este endpoint cria uma nova tarefa de remesh.
Para conversão de formato e redimensionamento, utilize os Convert API e Resize API dedicados. Os parâmetros obsoletos abaixo continuarão a funcionar, mas recomendamos os novos endpoints para novas integrações.
Parâmetros
Apenas um de input_task_id ou model_url é necessário. Se ambos forem fornecidos, input_task_id tem prioridade.
- Name
- input_task_id
- Type
- string
- Obrigatório
- Description
O ID da tarefa concluída de Imagem para 3D ou Texto para 3D que deseja remesh. Esta tarefa deve ser uma das seguintes: Texto para 3D Pré-visualização, Texto para 3D Refinar, Imagem para 3D ou Retexturizar. Além disso, deve ter um status de
SUCCEEDED.
- Name
- model_url
- Type
- string
- Obrigatório
- Description
Por favor, forneça um modelo 3D para a Meshy remesh através de um URL publicamente acessível ou Data URI. Formatos suportados:
.glb,.gltf,.obj,.fbx,.stl.Para Data URIs, use o MIME type:
application/octet-stream.
- Name
- target_formats
- Type
- string[]
- predefinição ["glb"]
- Description
Uma lista de formatos alvo para o modelo remesh. Quando omitido, apenas GLB é gerado.
Valores disponíveis:
glb,fbx,obj,usdz,blend,stl,3mf.
- Name
- topology
- Type
- string
- predefinição triangle
- Description
Especifique a topology do modelo gerado.
Valores disponíveis:
quad: Gerar uma malha dominante em quad.triangle: Gerar uma malha de triângulos decimada.
- Name
- target_polycount
- Type
- integer
- predefinição 30,000
- Description
Especifique o número alvo de polígonos no modelo gerado. O número real de polígonos pode desviar do alvo dependendo da complexidade da geometria.
O intervalo de valores válidos varia dependendo do nível do utilizador:
- 100 a 300,000 (inclusive)
- Name
- decimation_mode
- Type
- integer
- Description
Ative a decimação adaptativa definindo um nível de contagem de polígonos. Quando definido,
target_polycounté ignorado.Valores disponíveis:
1: Adaptativo — ultra contagem de polígonos.2: Adaptativo — alta contagem de polígonos.3: Adaptativo — média contagem de polígonos.4: Adaptativo — baixa contagem de polígonos.
- Name
- resize_height
- Type
- number
- ⚠ obsoleto
- predefinição 0
- Description
Redimensionar o modelo para uma certa altura medida em metros. Recomendamos usar o Resize API dedicado em vez disso.
auto_size,resize_heighteresize_longest_sidesão mutuamente exclusivos.
- Name
- resize_longest_side
- Type
- number
- ⚠ obsoleto
- predefinição 0
- Description
Redimensionar o modelo para que a dimensão mais longa da caixa delimitadora seja igual ao valor especificado em metros. Recomendamos usar o Resize API dedicado em vez disso.
auto_size,resize_heighteresize_longest_sidesão mutuamente exclusivos.
- Name
- auto_size
- Type
- boolean
- ⚠ obsoleto
- predefinição false
- Description
Quando definido como
true, o serviço usa visão AI para estimar automaticamente a altura real do objeto e redimensionar o modelo de acordo. Recomendamos usar o Resize API dedicado em vez disso.auto_size,resize_heighteresize_longest_sidesão mutuamente exclusivos.
auto_size = true- Name
- origin_at
- Type
- string
- ⚠ obsoleto
- predefinição bottom
- Description
Posição da origem. Recomendamos usar o Resize API dedicado em vez disso.
Valores disponíveis:
bottom,center.
- Name
- convert_format_only
- Type
- boolean
- ⚠ obsoleto
- Description
Se
true, o serviço apenas mudará o formato do ficheiro do modelo de entrada, ignorando outras entradas comotopology,resize_heightetarget_polycount. Recomendamos usar o Convert API dedicado em vez disso.target_formatsdeve ser fornecido seconvert_format_onlyestiver definido comotrue.
- Name
- alpha_thumbnail
- Type
- boolean
- predefinição false
- Description
Quando definido como
true, a tarefa renderiza adicionalmente uma versão com fundo transparente (RGBA) da pré-visualização e retorna-a comoalpha_thumbnail_urlna resposta GET. O campothumbnail_urlexistente permanece inalterado.
Retornos
A propriedade result da resposta contém o id da nova tarefa de remesh criada.
Modos de Falha
- Name
400 - Bad Request- Description
O pedido foi inaceitável. Causas comuns:
- Parâmetro em falta: Ou
model_urlouinput_task_iddeve ser fornecido. - Tarefa de entrada inválida: O
input_task_iddeve referir-se a uma tarefa bem-sucedida de um modelo suportado. - Formato de modelo inválido: O
model_urlaponta para um ficheiro com uma extensão não suportada. - URL inacessível: O
model_urlnão pôde ser descarregado. - Topology inválida: O parâmetro
topologyé inválido. - Parâmetros mutuamente exclusivos:
auto_sizeeresize_heightnão podem ser definidos simultaneamente.
- Parâmetro em falta: Ou
- Name
401 - Unauthorized- Description
A autenticação falhou. Por favor, verifique a sua chave de API.
- Name
402 - Payment Required- Description
Créditos insuficientes para realizar esta tarefa.
- Name
429 - Too Many Requests- Description
Excedeu o seu limite de taxa.
Pedido
# Basic remesh with custom formats and resize
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb", "fbx"],
"topology": "quad",
"target_polycount": 50000,
"resize_height": 1.0,
"origin_at": "bottom"
}'
# Quad remesh with auto-size
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb", "fbx"],
"topology": "quad",
"target_polycount": 50000,
"auto_size": true
}'
Resposta
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
Recuperar uma Tarefa de Remesh
Este endpoint recupera uma tarefa de remesh pelo seu ID.
Parâmetros
- Name
- id
- Type
- path
- Description
O ID da tarefa de remesh a recuperar.
Retorna
O objeto Tarefa de Remesh.
Pedido
curl https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Resposta
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
}
Eliminar uma Tarefa de Remesh
Este endpoint elimina permanentemente uma tarefa de remesh, incluindo todos os modelos e dados associados. Esta ação é irreversível.
Parâmetros de Caminho
- Name
- id
- Type
- path
- Description
O ID da tarefa de remesh a eliminar.
Retornos
Retorna 200 OK em caso de sucesso.
Pedido
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Resposta
// Returns 200 Ok on success.
Listar Tarefas de Remesh
Este endpoint permite-lhe obter uma lista de tarefas de Remesh.
Parâmetros
- Name
- page_num
- Type
- integer
- predefinição 1
- Description
Número da página para paginação.
- Name
- page_size
- Type
- integer
- predefinição 10
- Description
Limite do tamanho da página. O máximo permitido é de
50itens.
- Name
- sort_by
- Type
- string
- Description
Campo para ordenar.
Valores disponíveis:
+created_at: Ordenar por data de criação em ordem ascendente.-created_at: Ordenar por data de criação em ordem descendente.
Retornos
Retorna uma lista paginada de Os Objetos de Tarefa de Remesh.
Request
curl https://api.meshy.ai/openapi/v1/remesh?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null
}
]
Transmitir uma Tarefa de Remesh
Este endpoint transmite atualizações em tempo real para uma tarefa de Remesh usando Server-Sent Events (SSE).
Parâmetros
- Name
- id
- Type
- path
- Description
Identificador único para a tarefa de Remesh a transmitir.
Retornos
Retorna um fluxo de Os Objetos da Tarefa de Remesh como Server-Sent Events.
Para tarefas PENDING ou IN_PROGRESS, o fluxo de resposta incluirá apenas os campos necessários progress e status.
Request
curl -N https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Error event example
event: error
data: {
"status_code": 404,
"message": "Task not found"
}
// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
}
O Objeto Tarefa de Remesh
O objeto Tarefa de Remesh representa uma unidade de trabalho que a Meshy utiliza para remesh e exportar um modelo 3D existente em vários formatos. O objeto tem as seguintes propriedades:
Propriedades
- Name
- id
- Type
- string
- Description
Identificador único para a tarefa. Embora usemos um UUID k-sortable para ids de tarefa como detalhe de implementação, não deve fazer quaisquer suposições sobre o formato do id.
- Name
- type
- Type
- string
- Description
Tipo da tarefa de Remesh. O valor é
remesh.
- Name
- model_urls
- Type
- object
- Description
URL para download do ficheiro do modelo 3D texturizado gerado pela Meshy. A propriedade para um formato será omitida se o formato não for gerado em vez de retornar uma string vazia.
- Name
glb- Type
- string
- Description
URL para download do ficheiro GLB.
- Name
fbx- Type
- string
- Description
URL para download do ficheiro FBX.
- Name
obj- Type
- string
- Description
URL para download do ficheiro OBJ.
- Name
usdz- Type
- string
- Description
URL para download do ficheiro USDZ.
- Name
blend- Type
- string
- Description
URL para download do ficheiro Blender.
- Name
stl- Type
- string
- Description
URL para download do ficheiro STL.
- Name
3mf- Type
- string
- Description
URL para download do ficheiro 3MF. Apenas presente quando
3mffoi solicitado através detarget_formats.
- Name
- thumbnail_url
- Type
- string
- Description
URL para download de uma imagem de pré-visualização renderizada a partir do modelo remesh.
- Name
- alpha_thumbnail_url
- Type
- string
- Description
URL para download de uma versão com fundo transparente (RGBA) de
thumbnail_url. Apenas presente quando a tarefa foi criada comalpha_thumbnail: truee a pré-visualização transparente foi renderizada com sucesso; caso contrário, este campo é omitido.
- Name
- progress
- Type
- integer
- Description
Progresso da tarefa. Se a tarefa ainda não foi iniciada, esta propriedade será
0. Uma vez que a tarefa tenha sido concluída com sucesso, isto se tornará100.
- Name
- status
- Type
- string
- Description
Estado da tarefa. Os valores possíveis são um de
PENDING,IN_PROGRESS,SUCCEEDED,FAILED.
- Name
- preceding_tasks
- Type
- integer
- Description
A contagem de tarefas precedentes.
O valor deste campo é significativo apenas se o estado da tarefa for
PENDING.
- Name
- created_at
- Type
- timestamp
- Description
Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.
- Name
- started_at
- Type
- timestamp
- Description
Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. Se a tarefa ainda não foi iniciada, esta propriedade será
0.
- Name
- finished_at
- Type
- timestamp
- Description
Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos. Se a tarefa ainda não foi concluída, esta propriedade será
0.
- Name
- task_error
- Type
- object
- Description
Detalhes do erro para tarefas falhadas. Veja Erros para a referência completa do objeto
task_error.
- Name
- consumed_credits
- Type
- integer
- Description
O número de créditos consumidos por esta tarefa. Presente quando o estado da tarefa é
PENDING,IN_PROGRESSouSUCCEEDED. Retorna0para tarefasFAILED(os créditos são reembolsados em caso de falha).
Exemplo de Objeto Tarefa de Remesh
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": {
"message": ""
},
"consumed_credits": 5
}