Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Mandar mensagem à IA de construção

POST
/connectors/{connectorId}/build/messages
curl --request POST \
  --url https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/build/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "text": "example", "maskedSecret": false }'

Guarda a mensagem (com segredos colados mascarados) e põe a resposta da IA na fila; a conversa volta com answering true. Com o teto atingido, nada é mandado e a conversa volta com stopped true.

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
connectorId
required

Id do conector

string format: uuid

Id do conector

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
text
required

A mensagem da pessoa, já mascarada pela tela

string
>= 1 characters <= 2000 characters
maskedSecret

Se a tela escondeu um segredo colado antes de mandar

boolean

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

A conversa

Media typeapplication/json
object
connectorId
required
string format: uuid
messages
required
Array
One of:
object
id
required
string
kind
required
string
Allowed values: text
author
required
string
Allowed values: person ai
text
required
string
spend
required
object
currency
required

Moeda dos valores (BRL)

string
conversationSpent
required

Gasto desta conversa de construção, em reais

number
conversationCap
required

Teto por conversa de construção, em reais

number
monthSpent
required

Gasto da loja no mês com copiloto e construção, em reais

number
monthCap
required

Teto mensal da loja, em reais

number
stopped
required

O teto da conversa ou o mensal foi atingido: a conversa para

boolean
answering
required

A IA está respondendo a última mensagem

boolean

Example 

{
  "messages": [
    {
      "kind": "text",
      "author": "person"
    }
  ]
}

400

Seção intitulada “400”

Entrada inválida (validation_failed)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

401

Seção intitulada “401”

Token ausente, inválido ou expirado (connect.unauthorized)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

403

Seção intitulada “403”

Papel sem acesso ou Connect não liberado (connect.forbidden_role, connect.feature_disabled)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

409

Seção intitulada “409”

A IA ainda responde a mensagem anterior (connect.build_turn_in_progress)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

503

Seção intitulada “503”

IA de construção não disponível neste ambiente (connect.build_unavailable)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}