Voxli Voxli

Agents

Update agent

Update an existing agent. Only the fields you send change; config and secrets are each replaced as a whole. Secrets are never returned. Set isArchived to true to archive.

KINDLY: set or rotate the Kindly application's key with {"secrets": {"applicationKey": "..."}}. The callback URL stays the same.

PATCH /agents/{id}

Authorization

HeaderTypeDescription
Authorizationrequired
string
Header with your API key as a Bearer token: Bearer <api-key>. See Authentication.

Path parameters

NameTypeDescription
idrequired
string
The id of the item to update

Body

application/json
PropertyTypeDescription
isEnabled
boolean
name
string
config
object
metadata
object
secrets
object
isArchived
boolean

Response

  • 200Successful Response
PropertyTypeDescription
idrequired
string
createdAt
string (date-time)
updatedAt
string (date-time)
namerequired
string
typerequired
string
config
object
The agent's settings, by type. A KINDLY agent's callbackToken makes its reply URL. Secrets are kept apart and never returned.
Default: {}
metadata
object
Metadata set when the agent was registered
Default: {}
owner
object
The member a personal agent belongs to
id
string
name
string
isEnabled
boolean
Default: true
isArchived
boolean
Default: false

Test Results

Get test result