VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

AI Builder

Geração de temas por conversa com IA: sessões, referências, modelos, aplicação com desfazer, ajustes do provedor e banners.

O AI Builder deixa o lojista descrever o visual que quer numa conversa ("loja de artesanato, tons terrosos, fonte elegante") e recebe de volta um tema completo: cores, fontes, menus, páginas, seções da home e até categorias e produtos de demonstração. A proposta fica numa sessão até alguém aplicá-la à loja. Também há modelos prontos, análise de site de referência e geração de banners.

Pontos principais
  • Conversar não altera a loja. Só aplicar uma sessão ou um modelo grava.
  • Aplicar pode criar páginas, menus, produtos e banners. O desfazer restaura só o tema.
  • A IA precisa estar ligada e com chave nos ajustes; senão a mensagem devolve 200 com um aviso do assistente.
  • As sessões são da loja: todo administrador com o privilégio manage_theme vê todas.
  • Ids são UUIDs, mas um id malformado devolve 500, não 400.

Como funciona

O fluxo normal tem seis passos, e só o penúltimo mexe na loja.

Sessão→Referências→Conversa→Visualizar→Aplicar→Desfazer (opcional)
  1. Configure o provedor
    PUT /settings com a chave e enabled: true; valide com POST /test-connection.
  2. Abra uma sessão
    POST /sessions.
  3. Dê referências (opcional)
    POST /files com session_id, POST /analyze-url, POST /extract-colors.
  4. Converse
    POST /sessions/{id}/message, ou /stream para ver o progresso. Repita para refinar.
  5. Confira
    POST /sessions/{id}/preview mostra a proposta atual.
  6. Aplique
    POST /sessions/{id}/apply. Se não gostar, POST /sessions/{id}/rollback restaura o tema.

Estados da sessão (campo status):

ValorSignificado
activeEm conversa. É o estado após criar e após um rollback.
appliedA proposta foi aplicada à loja. Não pode ser aplicada de novo (409).
discardedDescartada.

Conceitos-chave

Provedor de IA

A loja escolhe em active_provider entre anthropic e openai_compatible (um modelo próprio, por endereço). As chaves ficam guardadas por loja e voltam mascaradas.

Proposta (current_output)

É o resultado estruturado da IA: theme, extended_theme, layouts, pages_content, navigation, appearance_settings, homepage_sections, catalog e reasoning. Valores monetários do catálogo estão em centavos (inteiros).

Modelos

Uma proposta pode ser guardada como modelo e aplicada em qualquer momento, sem nova conversa. Aplicar um modelo não guarda retrato, então não há desfazer.

Segurança das chaves

GET /settings e PUT /settings nunca devolvem uma chave inteira. Só POST /settings/reveal-key revela, uma por vez, e deixa registro de auditoria.

Relação com o Theme Builder

O AI Builder escreve o tema da loja e, quando a proposta traz homepage_sections, as seções da home do Theme Builder.

Endpoints

MétodoCaminhoPara que servePágina
POST/api/v1/admin/ai-builder/sessionsCriar uma sessãoSessões de conversa
GET/api/v1/admin/ai-builder/sessionsListar as sessões da lojaSessões de conversa
GET/api/v1/admin/ai-builder/sessions/{id}Obter uma sessãoSessões de conversa
PATCH/api/v1/admin/ai-builder/sessions/{id}Renomear uma sessãoSessões de conversa
DELETE/api/v1/admin/ai-builder/sessions/{id}Excluir uma sessãoSessões de conversa
POST/api/v1/admin/ai-builder/sessions/{id}/messageEnviar uma mensagem e esperar a respostaConversar com a IA
POST/api/v1/admin/ai-builder/sessions/{id}/streamEnviar uma mensagem e acompanhar o progressoConversar com a IA
POST/api/v1/admin/ai-builder/sessions/{id}/previewVisualizar a proposta da sessãoAplicar e desfazer
POST/api/v1/admin/ai-builder/sessions/{id}/applyAplicar a proposta à lojaAplicar e desfazer
POST/api/v1/admin/ai-builder/sessions/{id}/rollbackRestaurar o tema anteriorAplicar e desfazer
POST/api/v1/admin/ai-builder/sessions/{id}/save-templateSalvar a proposta como modeloAplicar e desfazer
POST/api/v1/admin/ai-builder/filesEnviar um arquivo de referênciaArquivos e análise de referência
DELETE/api/v1/admin/ai-builder/files/{id}Excluir um arquivo de referênciaArquivos e análise de referência
POST/api/v1/admin/ai-builder/analyze-urlAnalisar o visual de um siteArquivos e análise de referência
POST/api/v1/admin/ai-builder/extract-colorsExtrair a paleta de uma imagemArquivos e análise de referência
GET/api/v1/admin/ai-builder/templatesListar todos os modelosModelos de tema
GET/api/v1/admin/ai-builder/templates/publicListar só os modelos públicosModelos de tema
GET/api/v1/admin/ai-builder/templates/{id}Obter um modeloModelos de tema
DELETE/api/v1/admin/ai-builder/templates/{id}Excluir um modeloModelos de tema
POST/api/v1/admin/ai-builder/templates/{id}/applyAplicar um modelo à lojaModelos de tema
POST/api/v1/admin/ai-builder/templates/seedCriar os modelos de fábricaModelos de tema
GET/api/v1/admin/ai-builder/settingsObter os ajustesAjustes do AI Builder
PUT/api/v1/admin/ai-builder/settingsSalvar os ajustesAjustes do AI Builder
POST/api/v1/admin/ai-builder/settings/reveal-keyRevelar uma chaveAjustes do AI Builder
POST/api/v1/admin/ai-builder/test-connectionTestar a conexão com o provedorAjustes do AI Builder
POST/api/v1/admin/ai-builder/generate-bannerGerar um banner a partir de um textoGerar banners
POST/api/v1/admin/ai-builder/generate-theme-bannersGerar o conjunto de 3 banners do temaGerar banners

Erros comuns

  • Tratar 200 de /message como sucesso. Se a IA estiver desligada ou sem chave, a resposta é 200 com uma mensagem do assistente avisando.
  • Aplicar sem visualizar e esperar que o desfazer reverta tudo. Ele restaura só o tema; páginas, menus, produtos e banners criados ficam.
  • Aplicar um modelo em produção contando com desfazer. Não há retrato nessa rota.
  • Enviar PUT /settings parcial. Todos os campos são gravados; os omitidos voltam ao vazio. Leia, altere e devolva o objeto completo.
  • Mandar attachment_ids esperando anexar arquivos. O campo é ignorado: envie o arquivo com session_id.
  • Ler o status HTTP do /stream. O fluxo começa com 200; falhas chegam como evento error.
  • Esperar banners sob medida de generate-theme-banners. Os três textos são fixos e ignoram os dados da loja.

Próximos passos

Ajustes
Comece configurando o provedor.
Conversar com a IA
Mensagens e fluxo de progresso.
Aplicar e desfazer
O que a aplicação grava e o que o desfazer restaura.
Theme Builder
Edição manual do tema por seções.
Anterior
Loja pronta para agentes
Próxima
Sessões de conversa
Nesta página
  • Como funciona
  • Conceitos-chave
  • Provedor de IA
  • Proposta (currentoutput)
  • Modelos
  • Segurança das chaves
  • Relação com o Theme Builder
  • Endpoints
  • Erros comuns
  • Próximos passos