[POST] Criar variáveis

Cria uma nova variável para um agente. Esse recurso permite que o agente extraia e armazene tipos específicos de informações durante as conversas.


Endpoint

POST /v1.1/api/agent-service-data-of-interest/create


📤 Exemplo de Requisição (cURL)

curl --location 'https://api.zaia.app/v1.1/api/agent-service-data-of-interest/create' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "agentId": 15792,
  "dataType": "string",
  "description": "Nome do cliente extraído na conversa",
  "disableExtraction": false,
  "key": "client_name"
}'

Autenticação

  • Tipo: Bearer Token

  • Header: Authorization: Bearer <API_KEY>

  • Obrigatório: Sim


Requisição

Método HTTP

POST

Content-Type

application/json

Corpo da Requisição

{
  "agentId": 15792,
  "dataType": "string",
  "description": "Nome do cliente extraído na conversa",
  "disableExtraction": false,
  "key": "client_name"
}
Campo
Tipo
Obrigatório
Descrição

agentId

number

Sim

ID do agente ao qual a configuração pertence

dataType

"string" | "number" | "boolean"

Sim

Tipo de dado a ser extraído

description

string

Sim

Descrição legível explicando o dado

disableExtraction

boolean

Sim

Define se a extração automática estará desativada

key

string

Sim

Identificador único da configuração

📥 Respostas

✅ 200 - Sucesso

{
  "dataType": "string",
  "description": "Nome do cliente extraído na conversa",
  "disableExtraction": false,
  "id": "doi_12345",
  "key": "client_name"
}

❌ 404 - Não encontrado

"Agent not found"

❌ 401 - Unauthorized

"Unauthorized - Invalid or missing API key"

Códigos de Resposta

Status
Descrição

200

Data of interest criada com sucesso

404

Agente não encontrado ou não acessível pelo usuário autenticado

401

API key inválida ou ausente


Notas

  • O agente precisa pertencer ao time/usuário associado à API key.

  • O agente precisa estar com status ativo.

  • O campo id é gerado automaticamente pelo sistema.

Atualizado