Atualizar conhecimento web do agente
Atualizar conhecimento web do agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
/Agent/web-linkAtualizar conhecimento web do agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
Descrição no OpenAPI: This endpoint removes the old web page content and fetches the updated content, replacing it in the agent's knowledge.
Autenticação
Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.
Parâmetros
Esta operação não possui parâmetros de rota, query ou header.
Corpo da requisição
Content type: application/json · Schema: AgentRefreshWebLinkRequestDto
| Propriedade | Tipo | Obrigatório | Descrição | Restrições |
|---|---|---|---|---|
agentId | integer · int32 | Não | — | — |
fileId | string | Não | — | aceita null |
url | string | Não | — | aceita null |
Exemplo de requisição
curl --request PUT \
--url 'https://api.zild.ai/Agent/web-link' \
--header 'X-API-Key: YOUR_USER_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"agentId": 0,
"fileId": "string",
"url": "string"
}'
Respostas
| Status | Descrição | Corpo da resposta |
|---|---|---|
200 | Web page knowledge updated successfully | application/json · AgentDto |
Exemplo de resposta (200):
{
"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": "string"
}
},
"transferToNumber": {
"name": "string",
"params": {
"transfers": [
{
"condition": null,
"transferDestination": null,
"transferType": 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
AgentRefreshWebLinkRequestDto
| Propriedade | Tipo | Obrigatório | Descrição | Restrições |
|---|---|---|---|---|
agentId | integer · int32 | Não | — | — |
fileId | string | Não | — | aceita null |
url | string | Não | — | aceita null |
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
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 | — | — |