Transforme uma foto de origem numa figura colecionável 3D de cabeça grande em duas
etapas: protótipo gera uma imagem de conceito estilizada a partir da sua foto de
entrada, depois construir transforma essa imagem de conceito num modelo 3D com textura.
As duas etapas estão ligadas através de input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Gere uma única imagem conceptual no estilo de figura de vinil a partir da foto de origem. O ID da tarefa retornado é o que você passa como input_task_id para o endpoint de construção. Consulte O Objeto de Tarefa de Protótipo de Figura de Vinil para a forma da resposta.
Parâmetros
Name
image_url
Type
string
Obrigatório
Description
Foto de origem para a Meshy estilizar como uma figura de vinil de cabeça grande. Atualmente, suportamos os formatos .jpg, .jpeg, .png e .webp.
Existem duas maneiras de fornecer a imagem:
URL publicamente acessível: Um URL que é acessível a partir da internet pública.
Data URI: Um Data URI codificado em base64 da imagem. Exemplo de um Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Nome da tarefa opcional para fins de exibição. Máximo de 100 caracteres.
Name
remove_background
Type
boolean
predefinição false
Description
Quando definido como true, a imagem do protótipo é retornada como um PNG RGBA transparente com o fundo removido, para que possa compor o sujeito em qualquer fundo.
Retornos
A propriedade result da resposta contém o ID da tarefa id da nova tarefa de protótipo de figura de vinil criada. Consulte o endpoint Obter uma Tarefa ou subscreva o stream até que a tarefa atinja SUCCEEDED, depois passe esse ID para o endpoint de construção 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 é um formato suportado (.jpg, .jpeg, .png, .webp).
Dimensões da imagem fora do intervalo: A imagem é muito pequena, excede o tamanho máximo do ficheiro ou excede o número máximo de píxeis.
URL inacessível: O image_url não pôde ser descarregado (404 ou timeout).
Data URI inválido: A string base64 está malformada.
Conteúdo sinalizado: A imagem de entrada foi sinalizada por moderação NSFW ou de propriedade intelectual.
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
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>" }'
Resposta
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Exemplo de Protótipo
Comece com uma foto de origem, depois gere a imagem do protótipo usada pela etapa de construção.
Gere a figura de vinil 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, portanto, o formato do objeto de resposta e a lista de URLs de saída correspondem exatamente. Consulte O Objeto da Tarefa de Construção de Figura de Vinil para o formato 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 OpenAPI. O protótipo deve ter sido criado com a mesma chave de API, deve ter alcançado SUCCEEDED e deve ter produzido exatamente uma imagem candidata.
Tarefas de protótipo criadas através da aplicação web 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 fonte com 404.
Name
name
Type
string
Description
Nome de tarefa opcional para fins de exibição. Máximo de 100 caracteres.
Retornos
A propriedade result da resposta contém o id da tarefa da nova tarefa de construção de figura de vinil criada. Consulte o endpoint Obter uma Tarefa ou subscreva o stream até que a tarefa atinja SUCCEEDED, depois descarregue o GLB com textura de model_urls.glb (ou o par OBJ + MTL de model_urls.obj e model_urls.mtl se o seu pipeline preferir OBJ).
Modos de Falha
Name
400 - Bad Request
Description
O pedido foi 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.
Pai não bem-sucedido: 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 nenhuma imagem candidata.
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
404 - Not Found
Description
A tarefa de protótipo referenciada não existe, pertence a um utilizador diferente ou foi criada através da aplicação web (apenas tarefas de protótipo em modo API encadeiam na 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" }'
Recupere uma tarefa de protótipo ou construção dado um id de tarefa válido. O caminho do URL
deve corresponder à fase da tarefa — uma tarefa de construção obtida através de
/prototype/:id retorna 404, e vice-versa.
Cancelar 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á estão IN_PROGRESS são canceladas sem reembolso (o trabalhador pode já estar a consumir recursos). Tarefas que já atingiram um estado terminal (SUCCEEDED, FAILED, CANCELED) não podem ser canceladas.
O caminho do URL deve corresponder à fase da tarefa — DELETE em
/prototype/:buildId retorna 404.
Parâmetros do Caminho
Name
id
Type
path
Description
Identificador único para a tarefa de figura de vinil a cancelar.
Retornos
Retorna 204 No Content em caso de sucesso com um corpo vazio.
Modos de Falha
Name
400 - Bad Request
Description
A tarefa já está num estado terminal e não pode ser cancelada.
Name
404 - Not Found
Description
A tarefa não existe, pertence a um utilizador diferente, ou a sua fase não corresponde ao caminho do URL.
Transmitir atualizações em tempo real para uma tarefa de figura de vinil via Server-Sent Events (SSE). O caminho do URL deve corresponder à fase da tarefa — abrir uma transmissão em /prototype/:buildId/stream emite um único event: error payload com status_code: 404 e fecha a transmissão.
Parâmetros
Name
id
Type
path
Description
Identificador único para a tarefa de figura de vinil a transmitir.
Retornos
Retorna uma transmissão de objetos de tarefa Protótipo de Figura de Vinil ou Construção de Figura de Vinil como Server-Sent Events. Para tarefas PENDING ou IN_PROGRESS, a transmissão de resposta incluirá apenas os campos necessários progress e status.
Obtenha uma lista paginada das suas tarefas de figuras de vinil para uma única fase.
O caminho da URL seleciona a fase — /prototype retorna tarefas de protótipo;
/build retorna tarefas de construção. Tarefas da outra fase não estão incluídas
em nenhuma das respostas.
Parâmetros de Caminho
Name
stage
Type
path
Obrigatório
Description
Ou prototype ou build. A coleção retorna apenas tarefas
cuja fase corresponde à URL — buscar /prototype nunca retorna
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 do tamanho da página. O máximo permitido é 50 itens.
Name
sort_by
Type
string
predefinição -created_at
Description
Campo para ordenar. Valores disponíveis:
+created_at: Ordenar por tempo de criação em ordem ascendente.
-created_at: Ordenar por tempo de criação em ordem descendente.
O objeto de Tarefa do Protótipo de Figura de Vinil é uma unidade de trabalho que a Meshy acompanha
para gerar uma imagem conceitual no estilo de figura de vinil a partir de uma foto de origem.
O resultado desta fase é encadeado na
etapa de construção através de input_task_id.
Propriedades
Name
id
Type
string
Description
Identificador único para a tarefa. Embora usemos um UUID ordenável por k 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 de tarefa. O valor é creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
O nome da tarefa fornecido quando a tarefa foi criada. String vazia se nenhum nome foi fornecido.
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 foi iniciada, esta propriedade será 0. Uma vez que a tarefa tenha sido concluída com sucesso, isto se tornará 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
o padrão RFC 3339.
Por exemplo, sexta-feira, 1 de setembro de 2023 às 12:00:00 PM 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 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
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 é significativo apenas se o estado da tarefa for PENDING.
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_PROGRESS, ou SUCCEEDED. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).
Name
image_urls
Type
array of strings
Description
URLs para download dos candidatos a imagem conceitual gerados por esta tarefa de protótipo. Atualmente, a API sempre retorna exatamente um candidato; o campo é um array para que revisões futuras possam apresentar múltiplos candidatos sem uma alteração disruptiva.
Exemplo de Objeto de Tarefa do Protótipo de Figura de Vinil
O objeto de Tarefa de Construção de Figura de Vinil é uma unidade de trabalho que a Meshy acompanha
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 usado por Imagem para 3D,
portanto, os campos de saída espelham o objeto de tarefa desse endpoint.
Propriedades
Name
id
Type
string
Description
Identificador único para a 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 quando a tarefa foi criada. String vazia se nenhum nome foi fornecido.
Name
status
Type
string
Description
Status 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 foi iniciada, esta propriedade será 0. Uma vez que a tarefa tenha sido concluída com sucesso, isto se tornará 100.
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.
Name
finished_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi concluída, em milissegundos.
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. Significativo apenas quando o status é PENDING.
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. Retorna 0 para tarefas FAILED (os créditos são reembolsados em caso de falha).
Name
prompt
Type
string
Description
Sempre vazio para construção de figura de vinil. Presente para compatibilidade entre endpoints com a forma compartilhada V2ImageTo3DTaskResponse usada por Imagem para 3D.
Name
negative_prompt
Type
string
Description
Sempre vazio para construção de figura de vinil. Presente para compatibilidade entre endpoints.
Name
texture_prompt
Type
string
Description
Sempre vazio para construção de figura de vinil. Presente para compatibilidade entre endpoints.
Name
texture_image_url
Type
string
Description
Sempre vazio para construção de figura de vinil. Presente para compatibilidade entre endpoints.
Name
model_urls
Type
object
Description
URLs para download do modelo 3D gerado. A construção da figura de vinil emite um GLB texturizado mais o par OBJ + MTL para pipelines que preferem Wavefront OBJ. A forma do campo corresponde ao objeto model_urls de Imagem para 3D para que futuras adições de formato sejam integradas sem uma alteração disruptiva.
Name
glb
Type
string
Description
URL para download do arquivo GLB texturizado.
Name
obj
Type
string
Description
URL para download do arquivo Wavefront OBJ (geometria + UV).
Name
mtl
Type
string
Description
URL para download do arquivo de material MTL acompanhante do OBJ. Combine com obj e a entrada de texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL para download da imagem em miniatura do arquivo do modelo.
Name
texture_urls
Type
array
Description
Uma matriz 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 download da imagem do mapa de cor base.
Exemplo de Objeto de Tarefa de Construção de Figura de Vinil