Voxli Voxli

Agents

Create agent

Create a new agent of a given type, with its config and secrets. Secrets are never returned.

KINDLY (only where your account allows it): optionally config.market and config.languageCode. The response's config.callbackToken makes the bot's callback URL, https://api.voxli.io/callbacks/kindly/{callbackToken}: create the Kindly application with it as the webhook URL, then set the application's API key as secrets.applicationKey, here or later with Update Agent. The agent can't run until it has the key.

POST /agents/

Authorization

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

Body

application/json
PropertyTypeDescription
namerequired
string
typerequired
string
configrequired
object
metadata
object
Default: {}
secrets
object
Default: {}

Response

  • 201Successful 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

Get agent