API atual/Referência completa/Venddor Intelligence na vitrine

Histórico e edição

Lê uma conversa já existente e apaga a partir de uma mensagem para editá-la.

Estas rotas tratam da conversa já existente: ler o histórico e voltar atrás para editar uma mensagem.

Ler o histórico

GET/api/v1/storefront/intelligence/sessions/{id}/messagesAutenticada

Histórico de uma conversa

Devolve a conversa para o widget redesenhá-la depois de um recarregamento. Só voltam mensagens do cliente e do assistente; cartões de escolha aparecem no estado atual (um cartão já respondido volta como respondido).

Parâmetros de caminho

iduuidobrigatório

O session_id da conversa.

Parâmetros de consulta

limitintegerpadrão: 50

Quantas mensagens trazer (as mais recentes). De 1 a 200; valor inválido volta ao padrão.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/intelligence/sessions/11111111-1111-4111-8111-111111111111/messages?limit=50" \
  -H "X-Session-ID: $SESSION_ID"

Resposta

200Conversa

json

{
  "session_id": "11111111-1111-4111-8111-111111111111",
  "messages": [
    {
      "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d",
      "role": "user",
      "content": "Tem parecido mais barato?",
      "created_at": "2026-10-11T14:02:10Z"
    },
    {
      "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
      "role": "assistant",
      "content": "Encontrei duas opções mais baratas. ...",
      "created_at": "2026-10-11T14:02:14Z"
    }
  ],
  "total": 2
}

Campos da resposta

session_iduuid

A conversa pedida.

messagesobject[]

Da mais antiga para a mais nova.

messages[].iduuid

Id da mensagem.

messages[].rolestring

userassistant

user (cliente) ou assistant.

messages[].contentstring

Texto em Markdown, com os cartões sf:choice no estado atual.

messages[].created_atstring

RFC 3339, UTC.

totalinteger

Quantas mensagens vieram nesta resposta (não o total da conversa).

A resposta nunca é guardada em cache (Cache-Control: private, no-store).

Erros

Status	Quando	Corpo
404	Conversa inexistente ou de outro cliente. A mesma resposta nos dois casos, de propósito.	`{"error":"não encontrei essa conversa"}`
500	Falha ao ler a conversa.	`{"error":"não consegui recuperar a conversa agora"}`
503	Assistente indisponível na plataforma.	`{"error":"assistente indisponível"}`

Editar uma mensagem

POST/api/v1/storefront/intelligence/sessions/{id}/truncateAutenticada

Apaga a conversa a partir de uma mensagem

Apaga a mensagem indicada e todas as seguintes. Usada na edição de uma mensagem do cliente: depois de truncar, reenvie o texto editado por Conversar com o mesmo session_id, e a conversa continua do ponto da edição com contexto limpo.

Parâmetros de caminho

iduuidobrigatório

O session_id da conversa.

Corpo da requisição

from_message_iduuidobrigatório

Mensagem a partir da qual apagar, inclusive. Use o user_message_id do evento done.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/intelligence/sessions/11111111-1111-4111-8111-111111111111/truncate" \
  -H "X-Session-ID: $SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "from_message_id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}'

Resposta

200Conversa truncada

json

{ "ok": true }

Erros

Status	Quando	Corpo
400	`from_message_id` ausente.	`{"error":"from_message_id required"}`
500	Falha ao truncar.	`{"error":"could not truncate session"}`

Veja também

Histórico e edição

Lê uma conversa já existente e apaga a partir de uma mensagem para editá-la.

Estas rotas tratam da conversa já existente: ler o histórico e voltar atrás para editar uma mensagem.

Ler o histórico

GET/api/v1/storefront/intelligence/sessions/{id}/messagesAutenticada

Histórico de uma conversa

Parâmetros de caminho

iduuidobrigatório

O session_id da conversa.

Parâmetros de consulta

limitintegerpadrão: 50

Quantas mensagens trazer (as mais recentes). De 1 a 200; valor inválido volta ao padrão.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/intelligence/sessions/11111111-1111-4111-8111-111111111111/messages?limit=50" \
  -H "X-Session-ID: $SESSION_ID"

Resposta

200Conversa

json

{
  "session_id": "11111111-1111-4111-8111-111111111111",
  "messages": [
    {
      "id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d",
      "role": "user",
      "content": "Tem parecido mais barato?",
      "created_at": "2026-10-11T14:02:10Z"
    },
    {
      "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
      "role": "assistant",
      "content": "Encontrei duas opções mais baratas. ...",
      "created_at": "2026-10-11T14:02:14Z"
    }
  ],
  "total": 2
}

Campos da resposta

session_iduuid

A conversa pedida.

messagesobject[]

Da mais antiga para a mais nova.

messages[].iduuid

Id da mensagem.

messages[].rolestring

userassistant

user (cliente) ou assistant.

messages[].contentstring

Texto em Markdown, com os cartões sf:choice no estado atual.

messages[].created_atstring

RFC 3339, UTC.

totalinteger

Quantas mensagens vieram nesta resposta (não o total da conversa).

A resposta nunca é guardada em cache (Cache-Control: private, no-store).

Erros

Status	Quando	Corpo
404	Conversa inexistente ou de outro cliente. A mesma resposta nos dois casos, de propósito.	`{"error":"não encontrei essa conversa"}`
500	Falha ao ler a conversa.	`{"error":"não consegui recuperar a conversa agora"}`
503	Assistente indisponível na plataforma.	`{"error":"assistente indisponível"}`

Editar uma mensagem

POST/api/v1/storefront/intelligence/sessions/{id}/truncateAutenticada

Apaga a conversa a partir de uma mensagem

Parâmetros de caminho

iduuidobrigatório

O session_id da conversa.

Corpo da requisição

from_message_iduuidobrigatório

Mensagem a partir da qual apagar, inclusive. Use o user_message_id do evento done.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/intelligence/sessions/11111111-1111-4111-8111-111111111111/truncate" \
  -H "X-Session-ID: $SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "from_message_id": "6a7b8c9d-0e1f-4a2b-9c3d-4e5f6a7b8c9d"
}'

Resposta

200Conversa truncada

json

{ "ok": true }

Erros

Status	Quando	Corpo
400	`from_message_id` ausente.	`{"error":"from_message_id required"}`
500	Falha ao truncar.	`{"error":"could not truncate session"}`