API Creative Lab Lamp

A fotografia na qual basear o abajur, como um URL público ou um data URI (data:image/jpeg;base64,<os seus dados de imagem codificados em base64>).

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

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

Valores disponíveis:

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

Um nome para a tarefa, com até 100 carateres. É devolvido no campo name da tarefa. Um nome mais longo devolve 400.

Se deve remover o fundo da imagem de protótipo. true devolve um PNG RGBA transparente, para que possa colocar o assunto sobre qualquer fundo. A Meshy também constrói o modelo 3D a partir da imagem sem o seu fundo. Se a Meshy não conseguir remover o fundo, utiliza a imagem com o seu fundo, e a tarefa ainda assim é bem-sucedida.

O pedido não pode ser executado. Por exemplo:

• image_url está em falta.
• A imagem não é um ficheiro JPG, JPEG, PNG ou WebP.
• A imagem é demasiado pequena, excede 20 MB, ou excede o número máximo de píxeis.
• A Meshy não consegue transferir a imagem, por exemplo porque o URL devolve 404 ou expira o tempo de espera.
• O data URI não é um base64 válido.
• A imagem foi assinalada como NSFW.
• image_subject não é character nem landscape.

A mensagem de erro indica qual o problema encontrado. Corrija o pedido e envie-o novamente.

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

Aplica-se uma destas situações:

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

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

A sua equipa tem a Filtragem de IP ativada, e a Meshy assinalou a imagem por propriedade intelectual de terceiros. Envie uma imagem que tenha o direito de utilizar.

Um destes limites foi atingido:

• Enviou mais pedidos do que o seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
• Demasiadas das suas tarefas estão em fila de espera ou em execução. Aguarde que algumas terminem e tente novamente.
• Num plano ilimitado sem créditos restantes, atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde que uma tarefa termine, 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 que tenha cobrado. Tente novamente o pedido.

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

Um ID que não corresponda a uma das suas tarefas de protótipo de candeeiro da API devolve 404, incluindo um protótipo criado na aplicação web.

Um nome para a tarefa, até 100 carateres. É devolvido no campo name da tarefa. Um nome mais longo devolve 400.

O tamanho da maior dimensão do abajur, em milímetros, de 50 a 400. A Meshy dimensiona o modelo de forma uniforme para o ajustar. 0 utiliza o valor predefinido, e qualquer outro valor fora do intervalo devolve 400.

A espessura de parede do abajur, em milímetros, até 10. 0 utiliza o valor predefinido, e um valor negativo ou um valor acima de 10 devolve 400.

A percentagem da altura do modelo a cortar de forma plana na parte inferior, de 1 a 100. A base plana permite que o abajur assente na base de impressão e deixa espaço para a fixação. Um valor fora do intervalo devolve 400.

A predefinição da fixação de luz, que define como a Meshy constrói a parte inferior.

Valores disponíveis:

• bambu_mh001_60mm: um abajur com a base aberta e uma placa de base que tem um orifício de fixação de 60 mm, ambos em model_urls.lamp_stl, e o suporte de fixação em model_urls.base_stl
• none: um único abajur selado em model_urls.lamp_stl, sem model_urls.base_stl

A distância a mover o orifício de fixação ao longo do eixo X a partir do centro do abajur, em milímetros, de -80 a 80. Aplica-se apenas quando light_source_preset não é none.

A distância a mover o orifício de fixação ao longo do eixo Z (profundidade) a partir do centro do abajur, 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 aplicar ao modelo antes de a Meshy o processar, 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 aplicar ao modelo antes de a Meshy o processar, em graus, de -360 a 360.

A rotação em torno do eixo Z a aplicar ao modelo antes de a Meshy o processar, em graus, de -360 a 360.

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

Os ficheiros que a criação devolve.

Valores disponíveis:

• stl: model_urls.lamp_stl, o abajur com a sua placa de base quando existe uma predefinição de fixação, e model_urls.base_stl quando light_source_preset não é none
• zip: um ficheiro zip em model_urls.bundle_zip, com lamp.stl, e base.stl e result.json quando aplicável

O pedido não pode ser executado. Por exemplo:

• input_task_id está em falta ou não é um ID de tarefa válido.
• O estado 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 nenhum modelo 3D. Crie uma nova tarefa de protótipo.
• Um campo de options está fora do seu 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 indica qual o problema encontrado.

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

Aplica-se uma das seguintes situações:

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

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

input_task_id não corresponde a nenhuma tarefa de protótipo de candeeiro criada pela sua conta com a API. Um protótipo criado na aplicação web também devolve 404. Envie o ID de result de uma resposta de criação de protótipo.

Um destes limites foi atingido:

• Enviou mais pedidos do que o seu limite de taxa permite. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
• Demasiadas tarefas suas estão em fila de espera ou em execução. Aguarde que algumas terminem e tente novamente.
• Num plano ilimitado sem créditos restantes, atingiu o número de tarefas que podem ser executadas sem créditos. Aguarde que uma tarefa termine, ou adicione créditos.

O ID da tarefa a partir da resposta de criação.

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

A sua equipa tem a Filtragem de IP ativada, e a Meshy sinalizou a imagem da tarefa de protótipo por propriedade intelectual de terceiros. As tarefas de build e as equipas no plano Enterprise não recebem este erro. Crie uma tarefa de protótipo a partir de uma imagem sobre a qual tem direitos de utilização.

Não existe nenhuma tarefa Lamp com este ID associada à sua conta, ou a fase da tarefa não corresponde ao caminho. Verifique o ID e utilize /prototype ou /build de acordo com a tarefa.

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

O ID da tarefa a cancelar.

Aplica-se uma das seguintes situações:

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

Não existe nenhuma tarefa de candeeiro com este ID associada à sua conta, ou a fase da tarefa não corresponde ao caminho. Verifique o ID e use /prototype ou /build para corresponder à tarefa.

O ID da tarefa proveniente da resposta de criação.

A fase a listar, prototype ou build.

A página a devolver, de 1 a 255. 0 devolve a primeira página. Um valor fora do intervalo 0 a 255 devolve 400.

Número de tarefas por página, até 100. Um valor entre 101 e 255 devolve 100 tarefas, e 0 utiliza o valor predefinido. Um valor fora do intervalo 0 a 255 devolve 400.

A ordem de ordenação.

Valores disponíveis:

• -created_at: mais recente primeiro
• +created_at: mais antigo primeiro

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

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

O name que enviou ao criar a tarefa, ou "" se não tiver enviado nenhum.

O estado da tarefa.

Valores disponíveis:

• PENDING: a aguardar na fila
• IN_PROGRESS: a gerar o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

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

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

Momento em que um worker iniciou a tarefa, em milissegundos Unix. null até isso acontecer.

Momento em que a tarefa atingiu um estado final, em milissegundos Unix. null até isso acontecer.

Momento 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. Consulte Retenção de recursos.

A posição da tarefa na fila enquanto está PENDING. 1 significa que é a próxima a começar. 0 depois de a tarefa sair da fila, e sempre 0 em resultados de listagem.

O motivo pelo qual a tarefa falhou. null a menos que status seja FAILED. Consulte Erros.

Número de créditos cobrados pela tarefa, após qualquer reembolso. Um pedido que retorna um erro não é cobrado. Uma tarefa falhada tem o valor 0, porque a Meshy reembolsa-a. Cancelar só reembolsa uma tarefa enquanto esta está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream omite o campo, e um pedido de listagem retorna 500. Nesse caso, repita o pedido.

URLs de transferência para o modelo 3D gerado a partir da imagem de conceito. {} até a tarefa ser bem-sucedida.

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

URLs de transferência para a imagem de conceito. O array tem um URL depois de a tarefa ser bem-sucedida, e está vazio até lá.

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

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

O name que enviou ao criar a tarefa, ou "" se não tiver enviado nenhum.

O estado da tarefa.

Valores disponíveis:

• PENDING: a aguardar na fila
• IN_PROGRESS: a gerar o resultado
• SUCCEEDED: final, com o resultado
• FAILED: final, com o motivo em task_error
• CANCELED: final, sem resultado

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

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

Momento em que um worker iniciou a tarefa, em milissegundos Unix. null até isso acontecer.

Momento em que a tarefa atingiu um estado final, em milissegundos Unix. null até isso acontecer.

Momento 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. Consulte Retenção de recursos.

A posição da tarefa na fila enquanto está PENDING. 1 significa que é a próxima a começar. 0 depois de a tarefa sair da fila, e sempre 0 em resultados de listas.

O motivo pelo qual a tarefa falhou. null a menos que status seja FAILED. Consulte Erros.

Número de créditos cobrados pela tarefa, após qualquer reembolso. Um pedido que devolva um erro não é cobrado. Uma tarefa falhada é 0, porque o Meshy a reembolsa. O cancelamento só reembolsa uma tarefa enquanto esta está PENDING. Se o Meshy não conseguir ler a cobrança, uma resposta get ou stream omite o campo, e um pedido de lista devolve 500. Nesse caso, tente novamente o pedido.

URLs de transferência para os ficheiros imprimíveis. As chaves que aparecem dependem de output.format e de options.light_source_preset.