API de Porta-chaves do Creative Lab

A fotografia a transformar numa imagem conceptual de porta-chaves, como URL pública ou data URI (data:image/jpeg;base64,<your base64-encoded image data>).

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

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

Identifica a tarefa no seu painel e nas listas de tarefas, e não aparece no porta-chaves. Para colocar um nome no porta-chaves, utilize name_text.

Um nome a adicionar ao porta-chaves, como o nome de um animal de estimação ou de uma pessoa, até 10 caracteres. A Meshy conta caracteres, não bytes, pelo que um nome de 10 caracteres em chinês, japonês ou coreano cabe. Um nome mais longo devolve 400. Deixe em branco para um porta-chaves sem nome.

O nome aparece na face do porta-chaves como um detalhe colorido plano, não como texto em relevo ou recortado.

A Meshy remove os espaços em branco circundantes e os caracteres de formatação invisíveis. O objeto de tarefa de protótipo devolve o resultado como name_text, para que possa verificar o texto antes de pagar pelo build.

A Meshy adiciona o nome na fase de protótipo. O build mantém-no e ignora um name_text enviado para o endpoint de build.

Se deve remover o fundo da imagem do protótipo. true devolve um PNG RGBA transparente que mantém todo o medalhão, para que possa colocá-lo em qualquer fundo. O build também parte da imagem sem o seu fundo. Se a Meshy não conseguir remover o fundo, devolve a imagem com o seu fundo, e a tarefa continua a ser bem-sucedida.

A opção remove_background do build é independente.

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, ultrapassa os 20 MB, ou excede o número máximo de pixels.
• A Meshy não consegue transferir a imagem, por exemplo porque o URL devolve 404 ou expira o tempo limite.
• O data URI não é um base64 válido.
• name_text tem mais de 10 caracteres. A Meshy rejeita-o em vez de o encurtar, e não cobra pelo pedido.
• A imagem ou o name_text foi assinalado como NSFW.

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 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.

A sua equipa tem a Filtragem de IP ativada, e a Meshy assinalou a imagem por propriedade intelectual de terceiros. Envie uma imagem sobre a qual tem direitos de utilização. A Meshy verifica apenas a imagem quanto a propriedade intelectual, não o name_text.

Foi atingido um dos seguintes limites:

• Enviou mais pedidos do que o permitido pelo seu limite de taxa. Aguarde alguns segundos e tente novamente. Consulte Limites de taxa.
• Tem demasiadas tarefas 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 cobrados. Tente o pedido novamente.

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

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

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

O contorno do porta-chaves quando a Meshy não o traça a partir do motivo. A Meshy usa-o quando remove_background é false, ou quando não consegue encontrar o contorno do motivo.

Valores disponíveis:

• circle
• rounded-rect
• hexagon
• shield
• star

O comprimento da aresta do quadrado delimitador do porta-chaves, em milímetros, até 400. 0 usa o valor predefinido.

A altura máxima do relevo acima da base, em milímetros, de 0 a 20.

Quanto baixar o relevo, em milímetros, de 0 a 20. A Meshy subtrai este valor à altura do relevo em todo o lado, até à base.

A espessura da placa de base plana por trás do relevo, em milímetros, de 0 a 20.

Se deve fechar a parte posterior do porta-chaves. false deixa a parte posterior aberta, como uma casca.

A curva que mapeia os valores do mapa de profundidade para a altura do relevo.

Valores disponíveis:

• linear
• gamma
• s-curve

A intensidade da curva, até 10. As curvas gamma e s-curve usam-na, e linear ignora-a. 0 usa o valor predefinido.

Se deve inverter o mapa de profundidade, para que as áreas mais escuras se tornem relevo mais elevado.

Quanto suavizar o mapa de profundidade antes de a Meshy construir o relevo, de 0 a 10.

Quanto ampliar o relevo e a sua textura dentro do contorno, em torno do centro, até 10. Um valor superior a 1 aumenta o motivo, e um valor inferior a 1 reduz-o. Não altera a altura do relevo. 0 usa o valor predefinido.

O valor do mapa de profundidade abaixo do qual a Meshy define a profundidade como zero, de 0 a 1.

Se deve traçar o contorno do porta-chaves a partir do motivo, para que o porta-chaves siga a forma do motivo. false usa o contorno de badge_shape em vez disso. A Meshy também usa badge_shape quando não consegue encontrar o contorno do motivo.

Isto é independente do parâmetro remove_background do protótipo, que define se a imagem do protótipo tem um fundo transparente.

A resolução de malha do modelo exportado, de 64 a 512. A Meshy constrói a geometria a partir de um mapa de profundidade de 512 pixels, pelo que uma malha mais fina acrescentaria faces sem acrescentar detalhe. 0 usa o valor predefinido.

O formato de ficheiro que o build devolve.

Valores disponíveis:

• glb: um ficheiro model.glb, em model_urls.glb
• obj: um ficheiro zip com model.obj, model.mtl e texture.png, em model_urls.obj
• zip: um ficheiro zip com todos os ficheiros gerados pela Meshy, em model_urls.bundle_zip

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 a ser executada, aguarde e tente novamente. Se tiver falhado ou sido cancelada, crie uma nova tarefa de protótipo.
• A tarefa de protótipo foi concluída com sucesso mas não tem imagem. Crie uma nova tarefa de protótipo.
• Um campo de options está fora do seu intervalo ou não é um valor disponível.

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 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.

input_task_id não corresponde a nenhuma tarefa de protótipo de Keychain criada pela sua conta através da 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 das suas tarefas estão em fila 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 proveniente da resposta de criação.

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

A sua equipa tem a opção IP Filtering 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 os direitos de utilização.

Não existe nenhuma tarefa do porta-chaves com este ID associada à sua conta, ou a fase da tarefa não corresponde ao caminho. Verifique o ID e utilize /prototype ou /build para corresponder à tarefa.

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

O ID da tarefa a cancelar.

Aplica-se uma destas 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.

Nenhuma tarefa Keychain com este ID pertence à sua conta, ou a fase da tarefa não corresponde ao caminho. Verifique o ID e utilize /prototype ou /build para corresponder à tarefa.

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

O estágio 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-keychain-prototype.

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

O nome que a Meshy adicionou ao porta-chaves, depois de remover espaços em branco e caracteres de formatação invisíveis. É omitido quando não enviou name_text. Para verificar se o seu cliente HTTP codificou o texto corretamente, compare-o com o que enviou.

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 devolve 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 obtenção (get) ou de stream omite o campo, e um pedido de listagem devolve 500. Nesse caso, repita o pedido.

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 de tarefa, sempre creative-lab-keychain-build.

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

O estado da tarefa.

Valores disponíveis:

• PENDING: à espera 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. 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. 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 a Meshy a reembolsa. Cancelar só reembolsa uma tarefa enquanto esta estiver PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream omite o campo, e um pedido de lista devolve 500. Nesse caso, tente novamente o pedido.

URLs de download para o ficheiro de modelo, com uma entrada para o output.format que pediu. {} até a tarefa ser bem-sucedida.