meshy-5 será descontinuado a 10/10/2026. lowpoly será descontinuado a 30/10/2026. Mude de modelo antes destas datas para evitar erros nos pedidos.
Creative Lab — API de Figura de Vinil
Transforme uma fotografia de origem numa figura colecionável 3D de vinil de cabeça grande, em duas
fases: o protótipo gera uma imagem de conceito estilizada a partir da sua fotografia de
entrada e, depois, a construção transforma essa imagem de conceito num modelo 3D texturizado.
As duas fases estão ligadas através de input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Gera uma única imagem conceptual em estilo vinyl figure a partir da
fotografia de origem. O ID da tarefa devolvido é o que deve passar como
input_task_id para o endpoint de build. Consulte
The Vinyl Figure Prototype Task Object
para conhecer o formato da resposta.
Parâmetros
Name
image_url
Type
string
Obrigatório
Description
Fotografia de origem para a Meshy estilizar como uma vinyl figure de cabeça grande. Atualmente suportamos os formatos .jpg, .jpeg, .png e .webp.
Existem duas formas de fornecer a imagem:
URL publicamente acessível: Um URL acessível a partir da internet pública.
Data URI: Um data URI da imagem codificado em base64. Exemplo de um data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Nome opcional da tarefa para fins de apresentação. Máximo de 100 carateres.
Name
remove_background
Type
boolean
predefinição false
Description
Quando definido como true, a imagem do protótipo é devolvida como um PNG RGBA transparente com o fundo removido, para que possa compor o sujeito sobre qualquer fundo.
Retorna
A propriedade result da resposta contém o id da tarefa da tarefa de protótipo de vinyl figure recém-criada. Consulte periodicamente o endpoint Get a Task ou subscreva o stream até a tarefa atingir SUCCEEDED e, em seguida, passe esse ID ao endpoint de build como input_task_id.
Modos de Falha
Name
400 - Bad Request
Description
O pedido foi inaceitável. Causas comuns:
Parâmetro em falta: image_url é obrigatório.
Formato de imagem inválido: O image_url fornecido não está num formato suportado (.jpg, .jpeg, .png, .webp).
Dimensões da imagem fora do intervalo: A imagem é demasiado pequena, excede o tamanho máximo de ficheiro ou excede o número máximo de píxeis.
URL inacessível: Não foi possível transferir o image_url (404 ou timeout).
Data URI inválido: A string em base64 está mal formada.
Conteúdo assinalado: A imagem de entrada foi assinalada por moderation de conteúdo NSFW ou de propriedade intelectual.
Name
401 - Unauthorized
Description
A autenticação falhou. 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.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Response
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source photo, then generate the prototype image used by the build stage.
Gera a figura vinyl 3D final com textura a partir de uma tarefa de protótipo bem-sucedida. A construção executa o mesmo pipeline de imagem para 3D que
Imagem para 3D, pelo que o formato do objeto de resposta e a lista de URLs de saída correspondem exatamente. Consulte
O Objeto de Tarefa de Construção de Figura Vinyl
para conhecer a forma da resposta.
Parâmetros
Name
input_task_id
Type
string
Obrigatório
Description
O ID da tarefa de um protótipo criado através deste mesmo endpoint da OpenAPI. O protótipo tem de ter sido criado com a mesma chave de API, tem de ter atingido SUCCEEDED e tem de ter produzido exatamente uma imagem candidata.
Tarefas de protótipo criadas através da webapp não são aceites — o endpoint de construção aceita apenas tarefas de protótipo produzidas por POST /openapi/creative-lab/vinyl-figure/v1/prototype e recusa qualquer outra origem com 404.
Name
name
Type
string
Description
Nome de tarefa opcional para fins de exibição. Máximo de 100 carateres.
Retorna
A propriedade result da resposta contém o id da tarefa da nova tarefa de construção de figura vinyl criada. Faça polling ao endpoint Obter uma Tarefa ou subscreva o stream até a tarefa atingir SUCCEEDED, e depois descarregue o GLB com textura a partir de model_urls.glb (ou o par OBJ + MTL a partir de model_urls.obj e model_urls.mtl se o seu pipeline a jusante preferir OBJ).
Modos de Falha
Name
400 - Bad Request
Description
O pedido era inaceitável. Causas comuns:
Parâmetro em falta: input_task_id é obrigatório.
UUID inválido: O input_task_id não é um UUID válido.
Tarefa principal não concluída: A tarefa de protótipo referenciada ainda não atingiu SUCCEEDED.
Sem candidato: A tarefa de protótipo foi bem-sucedida mas não produziu qualquer imagem candidata.
Name
401 - Unauthorized
Description
A autenticação falhou. Verifique a sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
404 - Not Found
Description
A tarefa de protótipo referenciada não existe, pertence a outro utilizador, ou foi criada através da webapp (apenas tarefas de protótipo em modo API encadeiam para a construção).
Name
429 - Too Many Requests
Description
Excedeu o seu limite de taxa.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Obtenha uma tarefa de protótipo ou de construção dado um id de tarefa válido. O caminho do URL
tem de corresponder à fase da tarefa — uma tarefa de construção obtida através de
/prototype/:id devolve 404, e vice-versa.
Cancele uma tarefa de figura de vinil. Se a tarefa ainda estiver PENDING, os
créditos consumidos no momento da criação são reembolsados. Tarefas que já
estejam IN_PROGRESS são canceladas sem reembolso (o worker pode já estar
a consumir recursos). Tarefas que já tenham atingido um estado terminal
(SUCCEEDED, FAILED, CANCELED) não podem ser canceladas.
O caminho do URL deve corresponder à fase da tarefa — DELETE em
/prototype/:buildId devolve 404.
Parâmetros de Caminho
Name
id
Type
path
Description
Identificador único da tarefa de figura de vinil a cancelar.
Retorna
Devolve 204 No Content em caso de sucesso, com um corpo vazio.
Modos de Falha
Name
400 - Bad Request
Description
A tarefa já se encontra num estado terminal e não pode ser cancelada.
Name
404 - Not Found
Description
A tarefa não existe, pertence a outro utilizador, ou a sua fase não corresponde ao caminho do URL.
Transmita atualizações em tempo real para uma tarefa de figura de vinil através de Server-Sent Events
(SSE). O caminho do URL deve corresponder à fase da tarefa — abrir um stream em
/prototype/:buildId/stream emite um único payload event: error com
status_code: 404 e fecha o stream.
Parâmetros
Name
id
Type
path
Description
Identificador único da tarefa de figura de vinil a transmitir.
Retorna
Retorna um stream de objetos de tarefa Vinyl Figure Prototype
ou Vinyl Figure Build como Server-Sent Events. Cada frame transporta o objeto de tarefa completo para a fase — a mesma estrutura que o
endpoint Get devolve — pelo que, enquanto a tarefa está PENDING ou IN_PROGRESS, os
campos de saída simplesmente ainda não estão preenchidos (null, [] ou {}) e
finished_at é null.
Obtenha uma lista paginada das suas tarefas de figuras de vinil para uma única fase.
O caminho do URL seleciona a fase — /prototype devolve tarefas de protótipo;
/build devolve tarefas de construção. As tarefas da outra fase não são incluídas
em nenhuma das respostas.
Parâmetros de Caminho
Name
stage
Type
path
Obrigatório
Description
prototype ou build. A coleção devolve apenas as tarefas
cuja fase corresponde ao URL — obter /prototype nunca devolve
tarefas de construção e vice-versa.
Parâmetros de Consulta
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 de tamanho da página. O máximo permitido é 100 itens.
Name
sort_by
Type
string
predefinição -created_at
Description
Campo pelo qual ordenar. Valores disponíveis:
+created_at: Ordenar pela hora de criação em ordem ascendente.
-created_at: Ordenar pela hora de criação em ordem descendente.
O objeto Task de Protótipo de Figura em Vinil é uma unidade de trabalho que a Meshy acompanha
para gerar uma imagem de conceito ao estilo de figura em vinil a partir de uma fotografia de origem.
O resultado desta fase é encadeado com a fase de construção através de input_task_id.
Propriedades
Name
id
Type
string
Description
Identificador único da tarefa. Embora utilizemos um UUID k-sortable para os ids das tarefas 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. O valor é creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
O nome da tarefa fornecido no momento da criação da tarefa. Cadeia vazia se não tiver sido fornecido nenhum nome.
Name
status
Type
string
Description
Estado da tarefa. Os valores possíveis são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progresso da tarefa. Se a tarefa ainda não tiver começado, esta propriedade será 0. Assim que a tarefa for concluída com sucesso, passará a ser 100.
Name
created_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi criada, em milissegundos.
Um carimbo de data/hora representa o número de milissegundos decorridos desde 1 de janeiro de 1970 UTC, seguindo
a norma RFC 3339.
Por exemplo, sexta-feira, 1 de setembro de 2023 às 12:00:00 GMT é representado como 1693569600000. Isto aplica-se
a todos os carimbos de data/hora na Meshy API.
Name
started_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi iniciada, em milissegundos. Se a tarefa ainda não tiver sido 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 tiver sido concluída, esta propriedade será 0.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora de quando o resultado da tarefa expira, em milissegundos.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes.
O valor deste campo só é relevante se o estado da tarefa for PENDING.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas com falha. Consulte 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_PROGRESS ou SUCCEEDED. Devolve 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).
Name
image_urls
Type
array of strings
Description
URLs transferíveis para os candidatos a imagem de conceito gerados por esta tarefa de protótipo. Atualmente, a API devolve sempre exatamente um candidato; o campo é uma matriz para que futuras revisões possam apresentar múltiplos candidatos sem uma alteração incompatível.
O objeto Vinyl Figure Build Task é uma unidade de trabalho que a Meshy mantém
para gerar uma figura de vinil 3D texturizada a partir de uma tarefa de protótipo bem-sucedida.
Executa o mesmo pipeline de imagem para 3D utilizado por Imagem para 3D,
pelo que os campos de saída espelham o objeto de tarefa desse endpoint.
Propriedades
Name
id
Type
string
Description
Identificador único da tarefa.
Name
type
Type
string
Description
Tipo da tarefa. O valor é creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
O nome da tarefa fornecido no momento da criação. Cadeia vazia se não tiver sido fornecido nenhum nome.
Name
status
Type
string
Description
Estado da tarefa. Os valores possíveis são um de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress da tarefa. Se a tarefa ainda não tiver sido iniciada, esta propriedade será 0. Assim que a tarefa for bem-sucedida, passará a 100.
Name
created_at
Type
timestamp
Description
Carimbo de data/hora da criação da tarefa, em milissegundos.
Name
started_at
Type
timestamp
Description
Carimbo de data/hora do início da tarefa, em milissegundos.
Name
finished_at
Type
timestamp
Description
Carimbo de data/hora da conclusão da tarefa, em milissegundos.
Name
expires_at
Type
timestamp
Description
Carimbo de data/hora em que o resultado da tarefa expira, em milissegundos.
Name
preceding_tasks
Type
integer
Description
A contagem de tarefas precedentes. Só tem significado quando o estado é PENDING.
Name
task_error
Type
object
Description
Detalhes do erro para tarefas falhadas. Consulte 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. Devolve 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).
Name
prompt
Type
string
Description
Sempre vazio para o vinyl figure build. Presente para compatibilidade entre endpoints com a estrutura partilhada V2ImageTo3DTaskResponse utilizada por Imagem para 3D.
Name
negative_prompt
Type
string
Description
Sempre vazio para o vinyl figure build. Presente para compatibilidade entre endpoints.
Name
texture_prompt
Type
string
Description
Sempre vazio para o vinyl figure build. Presente para compatibilidade entre endpoints.
Name
texture_image_url
Type
string
Description
Sempre vazio para o vinyl figure build. Presente para compatibilidade entre endpoints.
Name
model_urls
Type
object
Description
URLs para descarregar o modelo 3D gerado. O vinyl figure build produz um GLB texturizado, além do par OBJ + MTL para pipelines que preferem o formato Wavefront OBJ. A forma deste campo corresponde ao objeto model_urls do Imagem para 3D, de modo que futuras adições de formato se integrem sem alterações disruptivas.
Name
glb
Type
string
Description
URL para descarregar o ficheiro GLB texturizado.
Name
obj
Type
string
Description
URL para descarregar o ficheiro Wavefront OBJ (geometria + UV).
Name
mtl
Type
string
Description
URL para descarregar o ficheiro de material MTL companheiro do OBJ. Utilize em conjunto com obj e a entrada de texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL para descarregar a imagem de miniatura do ficheiro do modelo.
Name
texture_urls
Type
array
Description
Um array de objetos de URL de textura gerados por esta tarefa. Atualmente contém um único objeto com o mapa de cor base.
Name
base_color
Type
string
Description
URL para descarregar a imagem do mapa de cor base.