Skip to main content
GET
/
v2
/
agent
/
{agentId}
/
intentions
cURL
curl --request GET \
  --url https://api.gptmaker.ai/v2/agent/{agentId}/intentions \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "details": "<string>",
    "fields": [
      {
        "name": "<string>",
        "jsonName": "<string>",
        "description": "<string>",
        "type": "STRING",
        "required": true
      }
    ],
    "type": "WEBHOOK",
    "httpMethod": "GET",
    "url": "<string>",
    "headers": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "params": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "variables": [
      {
        "valueExpression": "<string>",
        "defaultFieldKey": "<string>",
        "customField": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "type": "STRING",
          "jsonName": "<string>"
        }
      }
    ],
    "requestBody": "<string>",
    "autoGenerateParams": true,
    "autoGenerateBody": true
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

ID do agente

Query Parameters

page
integer<int32>

Número da página

pageSize
integer<int32>

Tamanho da página

query
string

Filtro pela descrição da intenção

Response

Lista de intenções

id
string

ID da intenção

description
string

Descrição da intenção

instructions
string

Quando usar a intenção

details
string

Instruções dos dados de saída

fields
object[]
type
enum<string>

Tipo de intenção

Available options:
WEBHOOK
httpMethod
enum<string>

Método HTTP

Available options:
GET,
POST
url
string

URL do webhook

headers
object[]
params
object[]
variables
object[]
requestBody
string

String contendo um JSON que será enviado no corpo da requisição

autoGenerateParams
boolean

Geração automática de parâmetros

autoGenerateBody
boolean

Geração automática do corpo da requisição