Skip to navigation

Get agent

Returns one agent with the same fields as in the list: name, language, phone line, state and the variables declared by the organization. The value of a variable with a fixed value is never returned here: has_default only tells whether it is set (read it with GET /agents/{agent_id}/variables). An agent of another organization, a colleague of a team and an agent that does not exist all give 404. Required scope: agents:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

agent_idstringRequiredformat: "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"

Id of an agent of the organization, as returned by GET /agents.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Response

Successful response.
object"agent"

Always agent.

idstring

Id of the agent. Use it in the path of the other agent endpoints and as agent_id wherever an agent is asked for.

namestring

Name of the agent: the name of the assistant, or the name of the business when the assistant has no name. A default name when neither is set.

languagestring

Base language of the agent, for example it; multi for a multilingual agent.

line_numberstring or null
The phone line assigned to the agent, if any.
statusenum

active: the agent works normally. suspended: the agent does not answer (callers hear busy), does not call, its web widget does not open and its campaigns are paused. Calls already in progress end normally.

Allowed values:
suspended_atdatetime or null

When the agent was suspended; null when it is active.

created_atdatetime or null

When the agent was created. null for some older agents.

updated_atdatetime or null

When the agent was last changed. null when it is not recorded.

variableslist of objects

Variables declared by the organization for this agent (not the ones the platform always provides).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error