API de luminária do Creative Lab

A foto na qual basear a luminária, como uma URL pública ou um data URI (data:image/jpeg;base64,<seus dados de imagem codificados em base64>).

A imagem deve ser um arquivo JPG, JPEG, PNG ou WebP de no máximo 20 MB.

O tipo de assunto na foto, que define como a Meshy o estiliza.

Valores disponíveis:

• character: um único personagem ou objeto, como uma figura, um animal ou um mascote
• landscape: uma cena externa ou panorama, como uma montanha, uma paisagem urbana ou uma floresta

Um nome para a tarefa, com até 100 caracteres. Ele retorna no campo name da tarefa. Um nome mais longo retorna 400.

Se o fundo deve ser removido da imagem de protótipo. true retorna um PNG RGBA transparente, para que você possa colocar o assunto em qualquer fundo. A Meshy também constrói o modelo 3D a partir da imagem sem seu fundo. Se a Meshy não conseguir remover o fundo, ela usa a imagem com o fundo original, e a tarefa ainda é concluída com sucesso.

A requisição não pode ser executada. Por exemplo:

• image_url está ausente.
• A imagem não é um arquivo JPG, JPEG, PNG ou WebP.
• A imagem é muito pequena, excede 20 MB ou excede a contagem máxima de pixels.
• A Meshy não consegue baixar a imagem, por exemplo porque a URL retorna 404 ou expira o tempo de espera.
• O data URI não é um base64 válido.
• A imagem foi sinalizada como NSFW.
• image_subject não é character nem landscape.

A mensagem de erro informa qual problema foi encontrado. Corrija a requisição e envie-a novamente.

A chave de API está ausente ou inválida. Verifique o cabeçalho Authorization.

Uma destas situações se aplica:

• A conta não tem créditos suficientes.
• A chave de API, o espaço de trabalho ou o membro atingiu seu limite de créditos.
• A conta está no plano gratuito.

Verifique seus créditos e plano, depois tente novamente.

Sua equipe tem a Filtragem de IP ativada, e a Meshy sinalizou a imagem por propriedade intelectual de terceiros. Envie uma imagem sobre a qual você tenha os direitos de uso.

Um destes limites foi atingido:

• Você enviou mais requisições do que seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Veja Limites de taxa.
• Há muitas tarefas suas na fila ou em execução. Aguarde algumas terminarem e tente novamente.
• Em um plano ilimitado sem créditos restantes, você atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde uma tarefa terminar ou adicione créditos.

A Meshy encontrou um erro de servidor, por exemplo porque não conseguiu executar a verificação de propriedade intelectual na imagem. A Meshy não cria a tarefa e reembolsa quaisquer créditos cobrados. Tente a requisição novamente.

O ID da tarefa de protótipo a ser construída. Deve ser uma tarefa criada pela sua conta com POST /openapi/creative-lab/lamp/v1/prototype, com o status SUCCEEDED.

Um ID que não seja de uma das suas tarefas de protótipo de Lamp pela API retorna 404, incluindo um protótipo criado no aplicativo web.

Um nome para a tarefa, com até 100 caracteres. Ele retorna no campo name da tarefa. Um nome mais longo retorna 400.

O tamanho da maior dimensão da cúpula da luminária, em milímetros, de 50 a 400. A Meshy escala o modelo de forma uniforme para se ajustar. 0 usa o padrão, e qualquer outro valor fora do intervalo retorna 400.

A espessura de parede da cúpula da luminária, em milímetros, até 10. 0 usa o padrão, e um valor negativo ou um valor acima de 10 retorna 400.

A porcentagem da altura do modelo a ser cortada de forma plana na parte inferior, de 1 a 100. A parte inferior plana permite que a cúpula da luminária se apoie na mesa de impressão e deixa espaço para a fixação. Um valor fora do intervalo retorna 400.

O ajuste predefinido da fixação de luz, que define como a Meshy constrói a parte inferior.

Valores disponíveis:

• bambu_mh001_60mm: uma cúpula de luminária com a parte inferior aberta e uma placa de base com um furo de fixação de 60 mm, ambos em model_urls.lamp_stl, e o suporte de fixação em model_urls.base_stl
• none: uma única cúpula de luminária selada em model_urls.lamp_stl, sem model_urls.base_stl

A distância para mover o furo de fixação ao longo do eixo X a partir do centro da cúpula da luminária, em milímetros, de -80 a 80. Aplica-se apenas quando light_source_preset não é none.

A distância para mover o furo de fixação ao longo do eixo Z (profundidade) a partir do centro da cúpula da luminária, em milímetros, de -80 a 80. Aplica-se apenas quando light_source_preset não é none.

A rotação em torno do eixo X a ser aplicada ao modelo antes de a Meshy processá-lo, em graus, de -360 a 360. A Meshy aplica as três rotações como ângulos de Euler XYZ em torno do centro do modelo.

A rotação em torno do eixo Y a ser aplicada ao modelo antes de a Meshy processá-lo, em graus, de -360 a 360.

A rotação em torno do eixo Z a ser aplicada ao modelo antes de a Meshy processá-lo, em graus, de -360 a 360.

Se deve adicionar um arquivo result.json ao pacote zip, com o nome do pipeline executado, avisos e caminhos de arquivos. Requer que output.format esteja definido como zip. true com stl retorna 400.

Os arquivos que o build retorna.

Valores disponíveis:

• stl: model_urls.lamp_stl, a cúpula da luminária com sua placa de base quando há um ajuste predefinido de fixação, e model_urls.base_stl quando light_source_preset não é none
• zip: um arquivo zip em model_urls.bundle_zip, com lamp.stl, e base.stl e result.json quando se aplicam

A solicitação não pode ser executada. Por exemplo:

• input_task_id está ausente ou não é um ID de tarefa válido.
• O status da tarefa de protótipo não é SUCCEEDED. Se ainda estiver em execução, aguarde e tente novamente. Se tiver falhado ou sido cancelada, crie uma nova tarefa de protótipo.
• A tarefa de protótipo foi bem-sucedida, mas não tem modelo 3D. Crie uma nova tarefa de protótipo.
• Um campo de options está fora do intervalo ou não é um valor disponível.
• output.format não é stl nem zip, ou include_result_json é true sem zip.

A mensagem de erro informa qual problema foi encontrado.

A chave de API está ausente ou é inválida. Verifique o cabeçalho Authorization.

Um destes se aplica:

• A conta não tem créditos suficientes.
• A chave de API, o espaço de trabalho ou o membro atingiu seu limite de créditos.
• A conta está no plano gratuito.

Verifique seus créditos e plano, depois tente novamente.

input_task_id não corresponde a nenhuma tarefa de protótipo de Lamp criada pela sua conta por meio da API. Um protótipo criado no aplicativo web também retorna 404. Envie o ID de result de uma resposta de criação de protótipo.

Um destes limites foi atingido:

• Você enviou mais solicitações do que seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
• Muitas das suas tarefas estão na fila ou em execução. Aguarde algumas terminarem e tente novamente.
• Em um plano ilimitado sem créditos restantes, você atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde uma tarefa terminar ou adicione créditos.

O ID da tarefa retornado na resposta de criação.

id não é um ID de tarefa válido. Envie o ID result da resposta de criação.

Sua equipe tem IP Filtering ativado, e a Meshy sinalizou a imagem da tarefa de prototype por propriedade intelectual de terceiros. Tarefas de build e equipes no plano Enterprise não recebem esse erro. Crie uma tarefa de prototype a partir de uma imagem sobre a qual você tem os direitos de uso.

Nenhuma tarefa de Lamp com este ID pertence à sua conta, ou o estágio da tarefa não corresponde ao caminho. Verifique o ID e use /prototype ou /build para corresponder à tarefa.

A Meshy não conseguiu executar a verificação de propriedade intelectual. Tente novamente a solicitação.

O ID da tarefa a ser cancelada.

Uma destas situações se aplica:

• id não é um ID de tarefa válido. Envie o ID result da resposta de criação.
• A tarefa já possui um status final (SUCCEEDED, FAILED ou CANCELED), portanto não pode ser cancelada.

Nenhuma tarefa de luminária com este ID pertence à sua conta, ou o estágio da tarefa não corresponde ao caminho. Verifique o ID e use /prototype ou /build para corresponder à tarefa.

O ID do task retornado na resposta de criação.

O estágio a ser listado, prototype ou build.

A página a ser retornada, de 1 a 255. 0 retorna a primeira página. Um valor fora do intervalo 0 a 255 retorna 400.

Número de tarefas por página, até 100. Um valor de 101 a 255 retorna 100 tarefas, e 0 usa o padrão. Um valor fora do intervalo 0 a 255 retorna 400.

A ordem de classificação.

Valores disponíveis:

• -created_at: mais recentes primeiro
• +created_at: mais antigos primeiro

O ID da tarefa. Não dependa do seu formato.

O tipo da tarefa, sempre creative-lab-lamp-prototype.

O name que você enviou ao criar a tarefa, ou "" caso não tenha enviado nenhum.

O status da tarefa.

Valores disponíveis:

• PENDING: aguardando na fila
• IN_PROGRESS: gerando o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

Porcentagem do trabalho concluído, de 0 a 100. É 0 até a tarefa começar e 100 quando ela é bem-sucedida.

Hora em que a tarefa foi criada, em milissegundos Unix.

Hora em que um worker iniciou a tarefa, em milissegundos Unix. null até então.

Hora em que a tarefa atingiu um status final, em milissegundos Unix. null até então.

Hora em que o resultado da tarefa expira, em milissegundos Unix. São 3 dias após finished_at, ou 3 dias após created_at até a tarefa terminar. Para contas Enterprise, que mantêm os resultados da API indefinidamente, é cerca de 100 anos depois. Veja Retenção de recursos.

A posição da tarefa na fila enquanto ela está PENDING. 1 significa que ela começa em seguida. 0 depois que a tarefa sai da fila, e sempre 0 em resultados de listagem.

Motivo da falha da tarefa. null, a menos que status seja FAILED. Veja Erros.

Número de créditos cobrados pela tarefa, após qualquer reembolso. Uma solicitação que retorna um erro não é cobrada. Uma tarefa com falha é 0, pois a Meshy a reembolsa. Cancelar reembolsa uma tarefa apenas enquanto ela está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream deixa o campo de fora, e uma solicitação de listagem retorna 500. Nesse caso, tente a solicitação novamente.

URLs de download para o modelo 3D gerado a partir da imagem conceitual. {} até a tarefa ser bem-sucedida.

URL de download para uma imagem de pré-visualização do modelo 3D. "" até a tarefa ser bem-sucedida.

URLs de download para a imagem conceitual. O array tem uma URL após a tarefa ser bem-sucedida, e fica vazio até então.

O ID da tarefa. Não dependa do seu formato.

O tipo da tarefa, sempre creative-lab-lamp-build.

O name que você enviou ao criar a tarefa, ou "" se você não enviou um.

O status da tarefa.

Valores disponíveis:

• PENDING: aguardando na fila
• IN_PROGRESS: gerando o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

Porcentagem do trabalho concluído, de 0 a 100. É 0 até a tarefa começar e 100 quando ela é bem-sucedida.

Horário em que a tarefa foi criada, em milissegundos Unix.

Horário em que um worker iniciou a tarefa, em milissegundos Unix. null até então.

Horário em que a tarefa atingiu um status final, em milissegundos Unix. null até então.

Horário em que o resultado da tarefa expira, em milissegundos Unix. É 3 dias após finished_at, ou 3 dias após created_at até a tarefa terminar. Para contas Enterprise, que mantêm os resultados da API indefinidamente, é cerca de 100 anos depois. Veja Retenção de recursos.

A posição da tarefa na fila enquanto ela está PENDING. 1 significa que ela começa em seguida. 0 depois que a tarefa sai da fila, e sempre 0 em resultados de lista.

O motivo da falha da tarefa. null a menos que status seja FAILED. Veja Erros.

Número de créditos cobrados pela tarefa, após qualquer reembolso. Uma requisição que retorna um erro não é cobrada. Uma tarefa com falha é 0, pois o Meshy a reembolsa. Cancelar só reembolsa uma tarefa enquanto ela está PENDING. Se o Meshy não conseguir ler a cobrança, uma resposta de get ou stream deixa o campo de fora, e uma requisição de lista retorna 500. Nesse caso, tente a requisição novamente.

URLs de download para os arquivos prontos para impressão. Quais chaves aparecem depende de output.format e options.light_source_preset.