WayloAIWaylo Docs
APIReferenceAgents

Update agent

PATCH
/agents/{id}

Change any part of the configuration except its workspace. An update that changes the configuration bumps version and records it in the history; one that changes nothing, or only active, does not. documentIds and toolIds each replace their whole set. Refused (409) if the resulting tools would give the model one function name twice — two tools sharing a name, or a tool shadowing a builtin of the resulting preset.

Access: workspace_admin · API key agents:write

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Path Parameters

id*string

Header Parameters

Authorization*string

Your API key.

Request Body

application/json
  1. body
name?string
Lengthlength <= 100
greeting?string
Lengthlength <= 500
systemPrompt?string
Lengthlength <= 20000
language?string
Match^[a-z]{2,3}$
Default"en"
sttProvider?string
sttModel?string
sttOptions?
llmProvider?string
llmModel?string
llmOptions?
ttsProvider?string
ttsModel?string
ttsVoiceId?string
ttsOptions?
runtimeConfig?
catalogId?|
Formatuuid
presetId?|
Value in"catalog_order_assistant""item_capture_assistant"null
toolFeedbackOverrides?
spokenReply?boolean
Defaulttrue
spokenReplyPrompt?|
Lengthlength <= 1000
active?boolean
documentIds?array<>
Itemsitems <= 100
toolIds?array<>
Itemsitems <= 20
destinationIds?array<>
Itemsitems <= 5

Response Body

Success

application/json
  1. response
id*string
workspaceId*string
name*string
greeting*string
systemPrompt*string
language*string
sttProvider*string
sttModel*string
sttOptions*
llmProvider*string
llmModel*string
llmOptions*
ttsProvider*string
ttsModel*string
ttsVoiceId*string
ttsOptions*
runtimeConfig*
catalogId*string|null
catalog*
presetId*string|null
toolFeedbackOverrides*
spokenReply*boolean
spokenReplyPrompt*string|null
documents*array<>
tools*array<>
destinations*array<>
version*number
active*boolean
createdByUserId*|
Formatuuid
createdByUserName*string|null
updatedByUserId*|
Formatuuid
updatedByUserName*string|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.poc.app.waylovoice.ai/agents/string' \  -H 'Authorization: Bearer sk_waylo_...' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "workspaceId": "string",  "name": "string",  "greeting": "string",  "systemPrompt": "string",  "language": "string",  "sttProvider": "string",  "sttModel": "string",  "sttOptions": {    "property1": "string",    "property2": "string"  },  "llmProvider": "string",  "llmModel": "string",  "llmOptions": {    "property1": "string",    "property2": "string"  },  "ttsProvider": "string",  "ttsModel": "string",  "ttsVoiceId": "string",  "ttsOptions": {    "property1": "string",    "property2": "string"  },  "runtimeConfig": {    "endpointing": {      "mode": "fixed",      "minDelayMs": 300,      "maxDelayMs": 1000,      "alpha": 0.9    },    "vad": {      "activationThreshold": 0.5,      "minSpeechDurationMs": 50,      "minSilenceDurationMs": 550    },    "backgroundAudio": {      "sound": "off",      "volume": 0.1,      "delaySeconds": 0    },    "thinkingSound": {      "enabled": false,      "delaySeconds": 1.5,      "volume": 0.3    },    "silenceTimeoutMs": 15000,    "silenceRetryAttempts": 3  },  "catalogId": "string",  "catalog": {    "id": "string",    "name": "string",    "description": "string",    "active": true  },  "presetId": "string",  "toolFeedbackOverrides": {    "property1": {      "ack": [        "string"      ],      "filler": [        "string"      ]    },    "property2": {      "ack": [        "string"      ],      "filler": [        "string"      ]    }  },  "spokenReply": true,  "spokenReplyPrompt": "string",  "documents": [    {      "id": "string",      "name": "string"    }  ],  "tools": [    {      "id": "string",      "name": "string",      "type": "api_request"    }  ],  "destinations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string"    }  ],  "version": 0,  "active": true,  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "createdByUserName": "string",  "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",  "updatedByUserName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}