Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Perguntar ao Copiloto

POST
/copilot/messages
curl --request POST \
  --url https://api-connect.zoppy.com.br/copilot/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "text": "example", "maskedSecret": false, "context": { "path": "example", "params": { "additionalProperty": "example" } } }'

O Copiloto lê o contexto da tela e da loja, só para leitura, e responde. Pedido de construir ou corrigir vira uma proposta de troca para o modo construção.

Authorizations

Seção intitulada “Authorizations”

Request Bodyrequired

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

A mensagem, já mascarada pela tela

string
>= 1 characters <= 2000 characters
maskedSecret

Se a tela escondeu um segredo colado

boolean
context
required
object
path
required

O caminho da tela aberta, como /app/connectors//runs/

string
<= 300 characters
params
required

Os itens abertos na tela (connectorId, runId)

object
key
additional properties
string
<= 64 characters

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

A conversa com a resposta

Media typeapplication/json
object
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
string
monthSpent
required

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

number
monthCap
required

Teto mensal, em reais

number
buildConversationCap
required

Teto por conversa de construção, em reais

number
capReached
required

O teto mensal foi atingido: copiloto e construção param

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"
  }
}

429

Seção intitulada “429”

Teto mensal de IA da loja atingido (connect.ai_month_cap_reached)

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"
  }
}