Listar ferramentas do agente

Este endpoint retorna todas as ferramentas de um Agente de IA pelo identificador do Agente de IA.

GET /AgentTool

Este endpoint retorna todas as ferramentas de um Agente de IA pelo identificador do Agente de IA.

Autenticação

Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.

Parâmetros

Nome	Local	Tipo	Obrigatório	Descrição	Restrições
`agentId`	`query`	`integer · int32`	Não	—	—

Corpo da requisição

Esta operação não recebe corpo de requisição.

Exemplo de requisição

curl --request GET \
  --url 'https://api.zild.ai/AgentTool?agentId={agentId}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'

Respostas

Status	Descrição	Corpo da resposta
`200`	Sucesso ao retornar a ferramenta	`application/json` · `array<AgentToolDto>`

Exemplo de resposta (200):

[
  {
    "id": 0,
    "agentToolType": 0,
    "agentId": 0,
    "prompt": "string",
    "description": "string",
    "name": "string",
    "apiUrl": "string",
    "agentToolHttpMethod": 0,
    "contentType": 0,
    "connectorType": 0,
    "connectorId": 0,
    "model": "string",
    "agentToolHeaders": [
      {
        "id": 0,
        "tenantId": 0,
        "agentToolId": 0,
        "key": "string",
        "value": "string",
        "agentToolVariableType": 0
      }
    ],
    "agentToolQueryParameters": [
      {
        "id": 0,
        "tenantId": 0,
        "agentToolId": 0,
        "key": "string",
        "value": "string",
        "agentToolVariableType": 0
      }
    ],
    "agentToolPathParameters": [
      {
        "id": 0,
        "tenantId": 0,
        "agentToolId": 0,
        "key": "string",
        "value": "string",
        "agentToolVariableType": 0
      }
    ],
    "agentToolFormParameters": [
      {
        "id": 0,
        "tenantId": 0,
        "agentToolId": 0,
        "key": "string",
        "value": "string",
        "parentAgentToolFormParameterId": 0,
        "agentToolFormParameterType": 0,
        "agentToolVariableType": 0
      }
    ],
    "subAgentId": 0,
    "handoffQueueId": 0,
    "handoffUserId": 0,
    "agent": {
      "id": 0,
      "name": "string",
      "description": "string",
      "agentType": 0,
      "agentFilesDtos": [
        {
          "id": "string",
          "fileName": "string"
        }
      ],
      "enabled": true,
      "isChat": true,
      "instructions": "string",
      "model": "string",
      "responseFormat": "string",
      "vectorStoreId": "string",
      "agentAIType": 0,
      "temperature": 0,
      "topP": 0,
      "integrationAgentId": "string",
      "language": 0,
      "dynamicVariables": [
        {
          "id": 0,
          "name": "string",
          "value": "string",
          "agentId": 0
        }
      ],
      "dataCollection": [
        {
          "id": 0,
          "name": "string",
          "value": "string",
          "agentId": 0
        }
      ],
      "communicationChannel": 0,
      "firstMessage": "string",
      "checklistId": 0,
      "queueId": 0,
      "createdAt": "2026-09-22T18:00:00Z",
      "voiceId": "string",
      "voiceModel": "string",
      "voiceSpeed": 0,
      "voiceTemperature": 0,
      "volume": 0,
      "phoneNumberId": "string",
      "phoneNumberType": 0,
      "customToolsIds": [
        "string"
      ],
      "builtInTools": {
        "endCall": {
          "name": "string",
          "params": {
            "systemToolType": null
          }
        },
        "transferToNumber": {
          "name": "string",
          "params": {
            "transfers": null
          }
        }
      },
      "maxDurationSeconds": 0,
      "elevenLabsReasoningEffort": "string",
      "elevenLabsMaxTokens": 0,
      "elevenLabsAsrProvider": "string",
      "elevenLabsTurnEagerness": "string",
      "elevenLabsSpellingPatience": "string",
      "elevenLabsTurnTimeout": 0,
      "elevenLabsSilenceEndCallTimeout": 0,
      "groupAgents": [
        {
          "id": 0,
          "groupId": 0,
          "agentId": 0,
          "permissionType": 0,
          "createdAt": "2026-09-22T18:00:00Z",
          "tenantId": 0
        }
      ],
      "currentUserPermission": 0,
      "agentCategoryId": 0,
      "logoIconUrl": "string",
      "webhookIds": [
        0
      ],
      "createdByUserId": 0,
      "ownedByUserId": 0,
      "defaultQuestions": [
        "string"
      ],
      "agentKnowledgeIds": [
        0
      ],
      "agentSkillIds": [
        0
      ]
    }
  }
]

Modelos de dados

AgentAIType

0 = AzureOpenAI; 1 = OpenAI; 2 = RetellAI; 3 = ElevenLabs; 4 = Lovable; 5 = n8n; 6 = Aws; 7 = MicrosoftCopilot; 8 = GoogleGemini; 9 = AnthropicClaude; 10 = Alteryx

integer

AgentDataCollectionDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`name`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`agentId`	`integer · int32`	Não	—	—

AgentDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`name`	`string`	Não	—	aceita null
`description`	`string`	Não	—	aceita null; maxLength: 500
`agentType`	`AgentType`	Não	—	—
`agentFilesDtos`	`array<AgentFilesDto>`	Não	—	aceita null
`enabled`	`boolean`	Não	—	—
`isChat`	`boolean`	Não	—	—
`instructions`	`string`	Não	—	aceita null
`model`	`string`	Não	—	aceita null
`responseFormat`	`string`	Não	—	aceita null
`vectorStoreId`	`string`	Não	—	aceita null
`agentAIType`	`AgentAIType`	Não	—	—
`temperature`	`number · double`	Não	—	aceita null
`topP`	`number · double`	Não	—	aceita null
`integrationAgentId`	`string`	Não	—	aceita null
`language`	`Language`	Não	—	—
`dynamicVariables`	`array<AgentDynamicVariableDto>`	Não	—	aceita null
`dataCollection`	`array<AgentDataCollectionDto>`	Não	—	aceita null
`communicationChannel`	`CommunicationChannel`	Não	—	—
`firstMessage`	`string`	Não	—	aceita null; maxLength: 1000
`checklistId`	`integer · int32`	Não	—	—
`queueId`	`integer · int32`	Não	—	—
`createdAt`	`string · date-time`	Não	—	—
`voiceId`	`string`	Não	—	aceita null
`voiceModel`	`string`	Não	—	aceita null
`voiceSpeed`	`number · double`	Não	—	—
`voiceTemperature`	`number · double`	Não	—	—
`volume`	`number · double`	Não	—	—
`phoneNumberId`	`string`	Não	—	aceita null
`phoneNumberType`	`PhoneNumberType`	Não	—	—
`customToolsIds`	`array<string>`	Não	—	aceita null
`builtInTools`	`BuiltInToolsDtos`	Não	—	—
`maxDurationSeconds`	`integer · int32`	Não	—	—
`elevenLabsReasoningEffort`	`string`	Não	—	aceita null
`elevenLabsMaxTokens`	`integer · int32`	Não	—	—
`elevenLabsAsrProvider`	`string`	Não	—	aceita null
`elevenLabsTurnEagerness`	`string`	Não	—	aceita null
`elevenLabsSpellingPatience`	`string`	Não	—	aceita null
`elevenLabsTurnTimeout`	`number · double`	Não	—	—
`elevenLabsSilenceEndCallTimeout`	`number · double`	Não	—	—
`groupAgents`	`array<GroupAgentDto>`	Não	—	aceita null
`currentUserPermission`	`AgentPermissionType`	Não	—	—
`agentCategoryId`	`integer · int32`	Não	—	—
`logoIconUrl`	`string`	Não	—	aceita null; maxLength: 2000
`webhookIds`	`array<integer · int32>`	Não	—	aceita null
`createdByUserId`	`integer · int32`	Não	—	—
`ownedByUserId`	`integer · int32`	Não	—	—
`defaultQuestions`	`array<string>`	Não	—	aceita null
`agentKnowledgeIds`	`array<integer · int32>`	Não	—	aceita null
`agentSkillIds`	`array<integer · int32>`	Não	—	aceita null

AgentDynamicVariableDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`name`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`agentId`	`integer · int32`	Não	—	—

AgentFilesDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`string`	Não	—	aceita null
`fileName`	`string`	Não	—	aceita null

AgentPermissionType

0 = View; 1 = Edit

integer

AgentToolContentType

0 = ApplicationJson; 1 = FormUrlEncoded; 2 = MultipartFormData

integer

AgentToolDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`agentToolType`	`AgentToolType`	Não	—	—
`agentId`	`integer · int32`	Não	—	—
`prompt`	`string`	Não	—	aceita null
`description`	`string`	Não	—	aceita null
`name`	`string`	Não	—	aceita null
`apiUrl`	`string`	Não	—	aceita null
`agentToolHttpMethod`	`AgentToolHttpMethod`	Não	—	—
`contentType`	`AgentToolContentType`	Não	—	—
`connectorType`	`ConnectorType`	Não	—	—
`connectorId`	`integer · int32`	Não	—	—
`model`	`string`	Não	—	aceita null; maxLength: 200
`agentToolHeaders`	`array<AgentToolHeader>`	Não	—	aceita null
`agentToolQueryParameters`	`array<AgentToolQueryParameter>`	Não	—	aceita null
`agentToolPathParameters`	`array<AgentToolPathParameter>`	Não	—	aceita null
`agentToolFormParameters`	`array<AgentToolFormParameter>`	Não	—	aceita null
`subAgentId`	`integer · int32`	Não	—	—
`handoffQueueId`	`integer · int32`	Não	—	aceita null
`handoffUserId`	`integer · int32`	Não	—	aceita null
`agent`	`AgentDto`	Não	—	—

AgentToolFormParameter

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`tenantId`	`integer · int32`	Não	—	—
`agentToolId`	`integer · int32`	Não	—	—
`key`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`parentAgentToolFormParameterId`	`integer · int32`	Não	—	—
`agentToolFormParameterType`	`AgentToolFormParameterType`	Não	—	—
`agentToolVariableType`	`AgentToolVariableType`	Não	—	—

AgentToolFormParameterType

0 = String; 1 = Object; 2 = Number; 3 = Boolean; 4 = Array

integer

AgentToolHeader

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`tenantId`	`integer · int32`	Não	—	—
`agentToolId`	`integer · int32`	Não	—	—
`key`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`agentToolVariableType`	`AgentToolVariableType`	Não	—	—

AgentToolHttpMethod

0 = GET; 1 = POST; 2 = PUT; 3 = DELETE; 4 = PATCH

integer

AgentToolPathParameter

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`tenantId`	`integer · int32`	Não	—	—
`agentToolId`	`integer · int32`	Não	—	—
`key`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`agentToolVariableType`	`AgentToolVariableType`	Não	—	—

AgentToolQueryParameter

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`tenantId`	`integer · int32`	Não	—	—
`agentToolId`	`integer · int32`	Não	—	—
`key`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`agentToolVariableType`	`AgentToolVariableType`	Não	—	—

AgentToolType

0 = ExecuteQuery; 1 = CreateQuery; 2 = WebSearch; 3 = GoogleMapsRoute; 4 = TaskScheduler; 5 = TextToImage; 6 = CreateFile; 7 = SubAgent; 8 = CodeInterpreter; 9 = EndConversation; 10 = OmieFinancialSummary; 11 = OmieAccountsPayable; 12 = OmieAccountsReceivable; 13 = OmieDueTitles; 14 = OmieTransactions; 15 = OmieBalance; 16 = OmieCategories; 17 = OmieEntryDetails; 18 = AgentMemory; 19 = HandoffToQueue; 20 = HandoffToUser; 21 = SendMail; 99 = Custom

integer

AgentToolVariableType

0 = Prompt; 1 = Constant

integer

AgentType

0 = ZildAssist; 1 = ZildFlow; 2 = ZildInsightChat; 3 = ZildChat; 4 = ZildDocs; 5 = ZildVoice; 6 = ZildCoach; 7 = ZildInsightChecklist

integer

BuiltInToolsDtos

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`endCall`	`EndCall`	Não	—	—
`transferToNumber`	`TransferToNumber`	Não	—	—

CommunicationChannel

0 = Default; 1 = WhatsApp; 2 = Telefonia; 3 = Email; 4 = WebChat; 5 = InstagramDirectMessage; 6 = FacebookMessenger; 7 = MicrosoftTeams; 8 = ZildCoach

integer

ConnectorType

0 = AnalysisService; 1 = PostgreSQL; 2 = MySQl; 3 = SQLServer; 4 = GoogleBigQuery; 5 = AzureOpenAI; 6 = Chart; 7 = OracleDB; 8 = Deepgram; 9 = AzureSpeech; 10 = AzureLanguageNotUsedAnymore; 11 = AzureStorage; 12 = RetellAI; 13 = AzureVision; 14 = OriginalSoftware; 15 = GoogleApi; 16 = OpenAI; 17 = AzureAiDocumentIntelligence; 18 = ElevenLabs; 19 = Twilio; 20 = Anthropic; 21 = GoogleGemini; 22 = Monday; 23 = Omie; 24 = MEM9

integer

EndCall

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`name`	`string`	Não	—	aceita null
`params`	`EndCallParams`	Não	—	—

EndCallParams

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`systemToolType`	`string`	Não	—	aceita null

GroupAgentDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`groupId`	`integer · int32`	Não	—	—
`agentId`	`integer · int32`	Não	—	—
`permissionType`	`AgentPermissionType`	Não	—	—
`createdAt`	`string · date-time`	Não	—	—
`tenantId`	`integer · int32`	Não	—	—

Language

0 = PtBr; 1 = EnUS; 2 = EsES; 3 = FrFR; 4 = DeDE; 5 = ItIT; 6 = ZhCN; 7 = ZhTW; 8 = JaJP; 9 = KoKR; 10 = RuRU; 11 = ArSA; 12 = HiIN; 13 = NlNL; 14 = PlPL; 15 = TrTR; 16 = ViVN; 17 = ThTH; 18 = IdID; 19 = SvSE

integer

PhoneNumberType

0 = Twilio; 1 = SipTrunk

integer

TransferDestination

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`phoneNumber`	`string`	Não	—	aceita null
`sipUri`	`string`	Não	—	aceita null
`type`	`string`	Não	—	aceita null

TransferItem

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`condition`	`string`	Não	—	aceita null
`transferDestination`	`TransferDestination`	Não	—	—
`transferType`	`string`	Não	—	aceita null

TransferParams

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`transfers`	`array<TransferItem>`	Não	—	aceita null

TransferToNumber

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`name`	`string`	Não	—	aceita null
`params`	`TransferParams`	Não	—	—