OMIAAgents

List available agents

Retrieves the conversational agents enabled for the account of the authenticated API Key. The response is minimalistic: identifier, name, status and the list of variables the agent needs to hold the conversation. Every variable listed must be covered when launching a call, either by the request or by a default value configured in the agent.

Authentication

x-api-keystring
Account authentication key.

Response

List of agents.
idstringOptional

Unique identifier of the agent. It is used in the agent field when launching a call.

namestringOptional
Descriptive name of the agent.
statusbooleanOptional
Indicates whether the agent is enabled.
variableslist of stringsOptional
Variables the agent needs to hold the conversation. Every variable must be covered when launching a call, either by the request or by a default value configured in the agent.