API de ímã de geladeira do Creative Lab

A foto a ser transformada em uma imagem de conceito de ímã de geladeira, 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.

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 do protótipo. true retorna um PNG RGBA transparente que mantém o ímã inteiro, para que você possa colocá-lo sobre qualquer fundo. O build também começa a partir da imagem sem o fundo. Se o Meshy não conseguir remover o fundo, ele retorna a imagem com o fundo, e a tarefa ainda é concluída com sucesso.

A opção remove_background do build é independente.

A solicitaçã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.
• O 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.

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

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

Uma das situações a seguir 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 e tente novamente.

Sua equipe tem a opção IP Filtering ativada, e o 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 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 Meshy encontrou um erro de servidor, por exemplo, por não conseguir executar a verificação de propriedade intelectual na imagem. O Meshy não cria a tarefa e reembolsa quaisquer créditos cobrados. Tente a solicitaçã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/fridge-magnet/v1/prototype, com o status SUCCEEDED.

Um ID que não corresponda a uma de suas tarefas de protótipo de ímã de geladeira da API retorna 404, incluindo um protótipo feito 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 contorno do ímã quando a Meshy não o traça a partir do assunto. A Meshy o usa quando remove_background é false, ou quando não consegue encontrar o contorno do assunto.

Valores disponíveis:

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

O comprimento da aresta do quadrado delimitador do ímã, em milímetros, até 400. 0 usa o padrão.

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

Quanto abaixar o relevo, em milímetros, de 0 a 20. A Meshy subtrai esse valor da altura do relevo em todos os pontos, até a base.

A espessura da placa de base plana atrás do relevo, em milímetros, de 0 a 20. A base padrão de 2 mm dá ao ímã corpo suficiente para aderir à geladeira, de modo que o relevo não pareça frágil.

Se deve fechar a parte de trás do ímã, o lado onde você cola o ímã. false deixa a parte de trás 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 a utilizam, e linear a ignora. 0 usa o padrão.

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

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

Quanto ampliar o relevo e sua textura dentro do contorno, em relação ao centro, até 10. Um valor acima de 1 amplia o assunto, e um valor abaixo de 1 o reduz. Isso não altera a altura do relevo. 0 usa o padrão.

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 ímã a partir do assunto, de modo que o ímã siga o formato do assunto. false usa o contorno badge_shape em vez disso. A Meshy também usa badge_shape quando não consegue encontrar o contorno do assunto.

Isso é separado do parâmetro remove_background do protótipo, que define se a imagem do protótipo tem 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, então uma malha mais fina adicionaria faces sem adicionar detalhe. 0 usa o padrão.

O formato de arquivo que o build retorna.

Valores disponíveis:

• glb: um arquivo model.glb, em model_urls.glb
• obj: um arquivo zip com model.obj, model.mtl e texture.png, em model_urls.obj
• zip: um arquivo zip com todos os arquivos que a Meshy gera, em model_urls.bundle_zip

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 falhou ou foi cancelada, crie uma nova tarefa de protótipo.
• A tarefa de protótipo teve sucesso, mas não tem imagem. Crie uma nova tarefa de protótipo.
• Um campo de options está fora do intervalo ou não é um valor disponível.

A mensagem de erro informa qual problema foi encontrado.

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

Um dos seguintes casos 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 seu plano, depois tente novamente.

input_task_id não corresponde a nenhuma tarefa de protótipo de ímã de geladeira criada pela sua conta com a API. Um protótipo feito no aplicativo web também retorna 404. Envie o ID 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.
• 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.

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

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

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

Nenhuma tarefa de ímã de geladeira com esse 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.

Um destes se aplica:

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

Nenhuma tarefa de ímã de geladeira com esse 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 da tarefa retornado na resposta de criação.

O estágio a listar, 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 recente primeiro
• +created_at: mais antigo primeiro

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

O tipo da tarefa, sempre creative-lab-fridge-magnet-prototype.

O name que você enviou ao criar a tarefa, ou "" se você não enviou 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 é concluída com sucesso.

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 ser concluída. 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 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.

Por que a tarefa falhou. 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 que falhou é 0, porque 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 a imagem conceitual. O array tem uma URL depois que a tarefa é concluída com sucesso, e fica vazio até então.

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

O tipo da tarefa, sempre creative-lab-fridge-magnet-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.

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

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. Uma requisição que retorna um erro não é cobrada. Uma tarefa que falha é 0, porque a Meshy a reembolsa. Cancelar só reembolsa uma tarefa enquanto ela está PENDING. Se a Meshy não conseguir ler a cobrança, uma resposta de get ou stream omite o campo, e uma requisição de lista retorna 500. Nesse caso, tente a requisição novamente.

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