---
title: "POST /v2/agent/{agentId}/intentions"
method: POST
path: "/v2/agent/{agentId}/intentions"
---

# POST /v2/agent/{agentId}/intentions

`POST /v2/agent/{agentId}/intentions`

Adiciona uma nova intenção ao agente

## Path parameters

- `agentId` string, required

## Request body

- object
  - `description` string, required — Descrição da intenção
  - `details` string — Detalhamento e instruções de quando o agente deve usar essa intenção.
  - `instructions` string — Instruções para o agente caso o atributo type seja INSTRUCTIONS.
  - `fields` object[]
    - `name` string, required — Nome do campo
    - `jsonName` string, required — Nome JSON do campo
    - `description` string, required — Descrição do campo
    - `type` 'STRING' | 'URL' | 'DATE_TIME' | 'DATE' | 'NUMBER' | 'BOOLEAN', required — Tipo do campo
    - `required` boolean, required — Campo obrigatório
  - `type` 'WEBHOOK' | 'INSTRUCTIONS', required — Tipo de intenção
  - `httpMethod` 'GET' | 'POST', required — Método HTTP
  - `url` string, required — URL do webhook
  - `headers` object[]
    - `name` string, required — Nome do cabeçalho
    - `value` string, required — Valor do cabeçalho
  - `params` object[]
    - `name` string, required — Nome do parâmetro
    - `value` string, required — Valor do parâmetro
  - `variables` object[]
    - `valueExpression` string, required — Expressão do valor a ser adicionado no campo padrão ou customizado
    - `defaultFieldKey` string — Nome do campo padrão. Aceitos são: chat_id, contact_name, contact_phone, contact_email, contact_gender, contact_birthday, contact_job_title, contact_org_name, contact_org_state, contact_org_city
    - `customField` object — Caso não seja um campo padrão informado em defaultFieldKey, informe o customField obtido em Listar campos.
      - `id` string — Id do campo a ser atualizado
      - `name` string — Nome do campo
      - `description` string — descrição do campo
      - `type` 'STRING' | 'DATE' | 'DATE_TIME' | 'NUMBER' | 'BOOLEAN' | 'MONEY'
      - `jsonName` string — nome do arquivo JSON
  - `requestBody` string — String contendo um JSON que será enviado no corpo da requisição
  - `autoGenerateParams` boolean, required — Geração automática de parâmetros
  - `autoGenerateBody` boolean, required — Geração automática do corpo da requisição

## Response `200`

Intenção adicionada com sucesso

- object
  - `success` boolean

## Other responses

- `400` — Erro inesperado
- `403` — Erro de token

---

[API](https://skmtc.net/gptmaker/apis/openapi-gpt-maker.md) · [All operations](https://skmtc.net/gptmaker/apis/openapi-gpt-maker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gptmaker/openapi-gpt-maker/versions/bda09b3eba6e/schema)