SIA Image Doc

Orientações para Criação do Mockup Base

Softwares Recomendados

CorelDRAW

Exporte em formato SVG 1.1, mantendo nomes e grupos de objetos. Evite transparências e filtros.

Inkscape

Utilize camadas separadas e exporte em SVG Plano. Converta textos em caminhos.

Photoshop / Illustrator

Crie a base visual e converta vetores. Exporte como SVG convertendo textos em curvas.

Boas Práticas para o SVG

Organize em camadas separadas
Cada parte da roupa (mangas, gola, corpo) deve estar em um grupo distinto.
Nomeie corretamente as camadas
Use nomes identificáveis sem espaços. Exemplo: mangaEsquerda, gola, corpo.
Trabalhe em RGB com fundo transparente
Configure o documento adequadamente para garantir compatibilidade.
Evite efeitos complexos
Transparências, sombras rasterizadas e mesclagens podem não ser compatíveis com SVG.
Converta textos em curvas
Garanta que todas as fontes estejam convertidas antes da exportação.

Checklist de Exportação

Converter todos os textos em curvas Remover filtros, transparências e gradientes complexos Verificar nomes das camadas (IDs sem espaços) Utilizar SVG 1.1 ou SVG Plano Testar o SVG no navegador Exportar sombras/texturas complexas como PNG separado

Seguindo essas orientações, o mockup ficará compatível com a SIA e permitirá a geração automática dos produtos nas telas de visualização.

Mockup

Rotas para consulta e edição de mockups.

GET /mockup/:id

Busca o mockup pelo id referenciado.

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Id do mockup que deseja buscar.

              GET
              /mockup/DUIAS8Y3HEWAUSDU9801

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Exemplo de Resposta

                {

                  "mockup":
                "<svg>...</svg>"

                }

GET /mockup/company/:id

Busca os mockups pelo id da empresa.

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Id da empresa que deseja buscar todos os mockups

              GET
              /mockup/company/DUIAS8Y3HEWAUSDU9801

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Exemplo de Resposta

                [
  {

                    "filename": "mockup_name.svg",

                    "file":
                "<svg>...</svg>"

                  },

                  {

                    "filename": "mockup_name2.svg",

                    "file":
                "<svg>...</svg>"

                  }
]
              

GET /mockup/png/:id

Busca o PNG de um Mockup

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Localização	Descrição
id	string	Sim	Parâmetro	Id do mockup que deseja buscar o PNG
x	number	Não	Query	Tamanho do eixo X (padrão: 600)
y	number	Não	Query	Tamanho do eixo y (padrão: 500)

              GET
              /mockup/png/DUIAS8Y3HEWAUSDU9801?x=1280&y=720

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Exemplo de Resposta

Buffer Image

POST /mockup

Cadastra um novo mockup para a IA.

Parâmetros do Body

Parâmetro	Tipo	Obrigatório	Descrição
filename	string	Sim	Nome do arquivo que vai ser enviado. Necessário incluir o ".svg" na extensão.
extension	string	Sim	Extensão do arquivo.
company_id	string	Sim	Id da empresa que está cadastrando o mockup.
file	string	Sim	Base64 do arquivo do mockup.
is_private	boolean	Não	Define se somente o usuário que criou pode usar.

              POST /mockup

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui

Exemplo de Body

                {

                  "filename":
                "filename.svg",

                  "extension":
                "svg",

                  "company_id":
                "DUIAS8Y3HEWAUSDU9801",

                  "file":
                "Base64 File",

                  "is_private":
                false

                }

              

Exemplo de Resposta

Status Code 201.

POST /mockup/edit/:id

Faz a edição de um mockup.

Parâmetros de Rota

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Id do mockup que deseja editar.

Parâmetros do Body

Parâmetro	Tipo	Obrigatório	Descrição
part	string	Sim	Nome da parte que será editada.
properties.color	string	Não	Cor principal do elemento (geralmente usada como fill)
properties.fill	string	Não	Cor de preenchimento direta (substitui gradientes)
properties.fillOpacity	number	Não	Transparência do preenchimento (0 = transparente, 1 = opaco)
properties.stroke	string	Não	Cor do traçado ou borda do elemento
properties.strokeWidth	number	Não	Espessura da borda/traçado em pixels
properties.strokeOpacity	number	Não	Transparência do traçado (0 = invisível, 1 = opaco)
properties.strokeDasharray	string	Não	Padrão de tracejado (ex: "5,3" cria linha pontilhada)
properties.strokeLinecap	'butt' \| 'round' \| 'square'	Não	Estilo das extremidades do traço
properties.strokeLinejoin	'miter' \| 'round' \| 'bevel'	Não	Como os cantos das linhas se conectam
properties.opacity	number	Não	Opacidade geral do elemento (afeta tudo nele)
properties.filter	string	Não	Define filtros SVG (ex: "url(#sombra)" ou "blur(5px)")
properties.mixBlendMode	string	Não	Modo de mesclagem (ex: "multiply", "overlay")
properties.fillRule	'nonzero' \| 'evenodd'	Não	Define regra de preenchimento para formas complexas
properties.content	string	Não	Essa propriedade substitui toda a parte cujo ID foi referênciado. Necessário enviar um SVG válido!

              GET
              /mockup/edit/DUIAS8Y3HEWAUSDU9801

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Exemplo de Body

                [
  {

                    "part":
                "mangaEsquerda",

                    "properties": {

                      "color": "rgb(255,0,0)",

                      "stroke": "red",

                    }

                  },

                  {

                    "part":
                "mangaDireita",

                    "properties": {

                      "color": "#ff0000",

                      "stroke": "rgba(255,0,0,1)",

                    }

                  },

                  {

                    "part":
                "golaEsquerda",

                    "properties": {

                      "content": "<svg>...</svg>"

                    }

                  },

                  {

                    "part":
                "golaDireita",

                    "properties": {

                      "content": "<svg>...</svg>"

                    }

                  }
]

Exemplo de Resposta

                {

                  "mockup":
                "<svg>...</svg>"

                }

IA

A api possui rotas de uso da IA.

GET /ia/realistic-image/:id

Gera uma imagem realista com base no mockup fornecido da peça de roupa.

              GET
              /ia/realistic-image/DUIAS8Y3HEWAUSDU9801

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Id do mockup que deseja gerar a imagem realista.

Exemplo de Resposta

Buffer Image

GET /ia/realistic-model-image/:id

Gera uma imagem realista de um(a) modelo usando a peça de roupa com base no mockup fornecido.

              GET
              /ia/realistic-model-image/DUIAS8Y3HEWAUSDU9801

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
id	string	Sim	Id do mockup que deseja gerar a imagem realista.

Exemplo de Resposta

Buffer Image

GET /ia/realistic-parade-video/:mockup_id

Gera um vídeo realista de um(a) modelo usando a peça de roupa em um desfile com base no mockup fornecido.

              GET
              /ia/realistic-parade-video/DUIAS8Y3HEWAUSDU9801

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
mockup_id	string	Sim	Id do mockup que deseja gerar o vídeo de desfile.

Exemplo de Resposta

                {

                  "id":
                "video_68e94b9170f081919fc10c2f5fe237780aafff7a0f61772f",

                  "object":
                "video",

                  "created_at":
                1760119697,

                  "status":
                "queued",

                  "completed_at":
                null,

                  "error":
                null,

                  "expires_at":
                null,

                  "model":
                "sia_video_1",

                  "progress":
                0,

                  "remixed_from_video_id": null,

                  "seconds":
                "8",

                  "size":
                "1280x720"

                }
              

GET /ia/get-video/:video_id

Busca o vídeo gerado pela rota de geração de vídeo com base no ID dele.

              GET
              /ia/realistic-parade-video/video_68e94b9170f081919fc10c2f5fe237780aafff7a0f61772f

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui
            

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
video_id	string	Sim	Id do vídeo gerado.

Exemplo de Resposta

Para essa rota existe dois tipos de resposta possíveis:

Exemplo 1

Quando o vídeo ainda não foi gerado:

                {

                  "id":
                "video_68e94b9170f081919fc10c2f5fe237780aafff7a0f61772f",

                  "object":
                "video",

                  "created_at":
                1760119697,

                  "status":
                "in_progress",

                  "completed_at":
                null,

                  "error":
                null,

                  "expires_at":
                null,

                  "model":
                "sia_video_1",

                  "progress":
                99,

                  "remixed_from_video_id": null,

                  "seconds":
                "8",

                  "size":
                "1280x720"

                }
              

Exemplo 2

Quando o vídeo já foi gerado:

Buffer video

POST /ia/chat

Inicia uma conversa com a estilista virtual.

              GET /ia/chat

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui

Parâmetros do Body

Parâmetro	Tipo	Obrigatório	Descrição
message	string	Sim	Mensagem enviada para estilista virtual.

Exemplo de Body

                {

                  "question":
                "Pergunta do usuário",

                }

Exemplo de Resposta

                {

                  "question":
                "Qual o seu nome?",

                  "asnwer":
                "Meu nome é SIA! Estou aqui pronta para lhe ajudar, basta
                  apenas mandar o seu questionamento!",

                }
              

Teste

Rotas de testes da API.

GET /health

Verifica se a API está funcionando.

              GET /health

              Host:
              gqwh08zm-3456.brs.devtunnels.ms

              Authorization: Bearer seu_token_aqui

Exemplo de Resposta

                {

                  "status":
                "Ok",

                  "message":
                "SIA Image is working perfectly!",

                  "version":
                "1.2510.21"

                }
              

Autenticação

Nossa API usa autenticação baseada em tokens. Para acessar os endpoints protegidos, você precisa incluir um token de acesso no cabeçalho de autorização de suas requisições.

POST /auth/login

Autentica um usuário e retorna um token de acesso válido por 3 horas.

Parâmetros do Header

Parâmetro	Tipo	Obrigatório	Descrição
email	string	Sim	Email do usuário
password	string	Sim	Senha do usuário

Exemplo de Resposta

                {

                  "token":
                "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

                  "expires_in":
                "3h"

                }
              

SIA Image Doc

Orientações

Mockup

IA

Teste

Autenticação

Documentação da API

Orientações para Criação do Mockup Base

Softwares Recomendados

CorelDRAW

Inkscape

Photoshop / Illustrator

Boas Práticas para o SVG

Checklist de Exportação

Teste do Mockup SVG

Pré-visualização do SVG

Mockup

Parâmetros de Consulta

Parâmetros de Consulta

Parâmetros de Consulta

Parâmetros do Body

Parâmetros de Rota

Parâmetros do Body

IA

Parâmetros de Consulta

Parâmetros de Consulta

Parâmetros de Consulta

Parâmetros de Consulta

Exemplo 1

Exemplo 2

Parâmetros do Body

Teste

Autenticação

Parâmetros do Header