Transforme uma foto de origem em uma figura 3D colecionável no estilo chibi em duas etapas:
prototype gera uma imagem conceitual estilizada a partir da sua foto de entrada, e então
build transforma essa imagem conceitual em um modelo 3D texturizado. As duas etapas
são vinculadas por meio do input_task_id.
Gere uma única imagem conceitual no estilo chibi a partir da foto de origem. O
ID de tarefa retornado é o que você passa como input_task_id para o
endpoint de build. Consulte
The Figure Prototype Task Object
para o formato da resposta.
Parâmetros
Name
image_url
Type
string
Obrigatório
Description
Foto de origem para a Meshy estilizar como uma figura chibi. Atualmente oferecemos suporte aos formatos .jpg, .jpeg, .png e .webp.
Existem duas maneiras de fornecer a imagem:
URL publicamente acessível: Uma URL que é acessível pela internet pública.
Data URI: Um Data URI da imagem codificado em base64. Exemplo de um Data URI: data:image/jpeg;base64,<seus dados de imagem codificados em base64>.
Name
name
Type
string
Description
Nome de tarefa opcional para fins de exibição. Máximo de 100 caracteres.
Name
remove_background
Type
boolean
padrão false
Description
Quando definido como true, a imagem prototípica é retornada como um PNG RGBA transparente com o fundo removido, para que você possa compor o assunto sobre qualquer fundo.
Retornos
A propriedade result da resposta contém o id da tarefa da tarefa de protótipo de figura recém-criada. Faça polling no endpoint Get a Task ou inscreva-se no stream até que a tarefa alcance SUCCEEDED, e então passe esse ID para o endpoint de build como input_task_id.
Modos de Falha
Name
400 - Bad Request
Description
A requisição não foi aceitável. Causas comuns:
Parâmetro ausente: image_url é obrigatório.
Formato de imagem inválido: O image_url fornecido não está em um formato suportado (.jpg, .jpeg, .png, .webp).
Dimensões de imagem fora do intervalo: A imagem é muito pequena, excede o tamanho máximo de arquivo, ou excede a contagem máxima de pixels.
URL inacessível: O image_url não pôde ser baixado (404 ou timeout).
Data URI inválido: A string base64 está malformada.
Conteúdo sinalizado: A imagem de entrada foi sinalizada pela moderation de NSFW ou propriedade intelectual.
Name
401 - Unauthorized
Description
A autenticação falhou. Por favor, verifique sua chave de API.
Name
402 - Payment Required
Description
Créditos insuficientes para realizar esta tarefa.
Name
429 - Too Many Requests
Description
Você excedeu seu limite de taxa.
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/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":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Exemplo de protótipo
Comece com um retrato de origem e, em seguida, gere a imagem prototípica usada pela etapa de build.
Gera a figura 3D texturizada final a partir de uma tarefa de protótipo bem-sucedida.
O build executa o mesmo pipeline de imagem para 3D usado em
Imagem para 3D, portanto o formato do objeto de resposta e a
lista de URLs de saída correspondem exatamente. Consulte
O Objeto de Tarefa de Build de Figure para o
formato da resposta.
Parâmetros
Name
input_task_id
Type
string
Obrigatório
Description
O ID da tarefa de uma tarefa de protótipo criada através deste mesmo endpoint OpenAPI. O protótipo deve ter sido criado com a mesma chave de API, deve ter atingido SUCCEEDED e deve ter produzido exatamente uma imagem candidata.
Tarefas de protótipo criadas através da webapp não são aceitas — o endpoint de build aceita apenas tarefas de protótipo produzidas por POST /openapi/creative-lab/figure/v1/prototype e recusa qualquer outra origem com 404.
Name
name
Type
string
Description
Nome opcional da tarefa para fins de exibição. Máximo de 100 caracteres.
Retornos
A propriedade result da resposta contém o id da tarefa da tarefa de build de figure recém-criada. Faça polling no endpoint Obter uma Tarefa ou inscreva-se no stream até que a tarefa atinja SUCCEEDED, então baixe o GLB texturizado em model_urls.glb (ou o par OBJ + MTL em model_urls.obj e model_urls.mtl caso o seu pipeline posterior prefira OBJ).
Modos de Falha
Name
400 - Bad Request
Description
A solicitação era inaceitável. Causas comuns:
Parâmetro ausente: input_task_id é obrigatório.
UUID inválido: O input_task_id não é um UUID válido.
Origem não concluída com sucesso: A tarefa de protótipo referenciada ainda não atingiu SUCCEEDED.
Nenhum candidato: A tarefa de protótipo foi bem-sucedida, mas não produziu nenhuma imagem candidata.
Name
401 - Unauthorized
Description
Falha na autenticação. Verifique 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 usuário diferente ou foi criada através da webapp (apenas tarefas de protótipo em modo API se encadeiam em um build).
Name
429 - Too Many Requests
Description
Você excedeu seu limite de taxa.
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Exemplo de build
A tarefa de build transforma a imagem de protótipo selecionada em um modelo 3D texturizado disponível para download.
Recupera uma tarefa de prototype ou build a partir de um id de tarefa válido. O caminho da URL
deve corresponder ao estágio da tarefa — uma tarefa de build buscada através de
/prototype/:id retorna 404, e vice-versa.
Cancela uma tarefa de figure. 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 worker pode já estar
consumindo recursos). Tarefas que já atingiram um estado terminal
(SUCCEEDED, FAILED, CANCELED) não podem ser canceladas.
O caminho da URL deve corresponder ao estágio da tarefa — DELETE em
/prototype/:buildId retorna 404.
Parâmetros de Caminho
Name
id
Type
path
Description
Identificador único da tarefa de figure a ser cancelada.
Retornos
Retorna 204 No Content em caso de sucesso, com corpo vazio.
Modos de Falha
Name
400 - Bad Request
Description
A tarefa já está em um estado terminal e não pode ser cancelada.
Name
404 - Not Found
Description
A tarefa não existe, pertence a um usuário diferente, ou seu estágio não corresponde ao caminho da URL.
Transmite atualizações em tempo real de uma tarefa de figure via Server-Sent Events (SSE).
O caminho da URL deve corresponder ao estágio da tarefa — abrir um stream em
/prototype/:buildId/stream emite um único payload event: error com
status_code: 404 e encerra o stream.
Parâmetros
Name
id
Type
path
Description
Identificador único da tarefa de figure a ser transmitida.
Retornos
Retorna um stream de objetos de tarefa Figure Prototype
ou Figure Build como
Server-Sent Events. Cada frame carrega o objeto de tarefa completo referente ao estágio — o mesmo formato que o
endpoint Get retorna — então, 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.
Recupera uma lista paginada das suas tarefas de figura para um único estágio. O caminho da
URL seleciona o estágio — /prototype retorna tarefas de protótipo; /build
retorna tarefas de build. Tarefas do outro estágio não são incluídas em nenhuma
das respostas.
Parâmetros de Caminho
Name
stage
Type
path
Obrigatório
Description
Pode ser prototype ou build. A coleção retorna apenas tarefas
cujo estágio corresponde à URL — buscar /prototype nunca retorna
tarefas de build e vice-versa.
Parâmetros de Consulta
Name
page_num
Type
integer
padrão 1
Description
Número da página para paginação.
Name
page_size
Type
integer
padrão 10
Description
Limite de itens por página. O máximo permitido é 100 itens.
Name
sort_by
Type
string
padrão -created_at
Description
Campo pelo qual ordenar. Valores disponíveis:
+created_at: Ordenar pelo horário de criação em ordem crescente.
-created_at: Ordenar pelo horário de criação em ordem decrescente.
O objeto Figure Prototype Task é uma unidade de trabalho que a Meshy monitora para gerar uma imagem conceitual em estilo chibi a partir de uma foto de origem. A saída dessa etapa é encadeada com a etapa de build por meio de input_task_id.
Properties
Name
id
Type
string
Description
Identificador único da tarefa. Embora usemos um UUID k-sortable para os ids de tarefa como detalhe de implementação, você não deve fazer suposições sobre o formato do id.
Name
type
Type
string
Description
Tipo da tarefa. O valor é creative-lab-figure-prototype.
Name
name
Type
string
Description
O nome da tarefa fornecido no momento da criação. String vazia se nenhum nome foi fornecido.
Name
status
Type
string
Description
Status da tarefa. Os valores possíveis são PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress da tarefa. Se a tarefa ainda não foi iniciada, essa propriedade será 0. Assim que a tarefa for concluída com sucesso, ela 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, 12:00:00 PM GMT é representado como 1693569600000. Isso se aplica
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, essa propriedade será 0.
Name
finished_at
Type
timestamp
Description
Carimbo de data/hora de quando a tarefa foi finalizada, em milissegundos. Se a tarefa ainda não foi finalizada, essa 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ó é significativo se o status da tarefa for PENDING.
Name
task_error
Type
object
Description
Detalhes de 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 essa tarefa. Presente quando o status 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 das candidatas a imagem conceitual geradas por essa tarefa de prototipagem. Atualmente, a API sempre retorna exatamente uma candidata; o campo é um array para que revisões futuras possam expor múltiplas candidatas sem uma alteração que quebre a compatibilidade.
O objeto da Tarefa de Construção da Figura é uma unidade de trabalho que o Meshy monitora para
gerar uma figura 3D texturizada a partir de uma tarefa de prototipagem bem-sucedida. Ele
executa o mesmo pipeline de imagem para 3D usado por Imagem para 3D,
então 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-figure-build.
Name
name
Type
string
Description
O nome da tarefa fornecido quando ela 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, essa propriedade será 0. Uma vez que a tarefa tenha sido concluída com sucesso, isso 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 finalizada, 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 de 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. 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. Presente para compatibilidade entre endpoints com o formato compartilhado V2ImageTo3DTaskResponse usado por Imagem para 3D.
Name
negative_prompt
Type
string
Description
Sempre vazio para construção de figura. Presente para compatibilidade entre endpoints.
Name
texture_prompt
Type
string
Description
Sempre vazio para construção de figura. Presente para compatibilidade entre endpoints.
Name
texture_image_url
Type
string
Description
Sempre vazio para construção de figura. Presente para compatibilidade entre endpoints.
Name
model_urls
Type
object
Description
URLs para download do modelo 3D gerado. A construção da figura emite um GLB texturizado além do par OBJ + MTL para pipelines que preferem o Wavefront OBJ. O formato do campo corresponde ao objeto model_urls do Imagem para 3D, de forma que futuras adições de formato se encaixem sem uma alteração de ruptura.
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 complementar 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 de miniatura do arquivo 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.