Voxli Voxli

Agents

Get agent

Retrieve a specific agent by its ID.

GET /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 retrieve

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

Agents

Register local agent