Get started
Glossary
Short definitions of the words these docs use, with a link to the page that covers each one in depth.
| Term | Meaning |
|---|---|
| Agent | One voice agent configuration: welcome message, prompt, LLM, voice, transcriber, call settings, tools and analytics. See Agents. |
| Agent version | A full copy of an agent saved on every create, update, duplicate and restore. The last 10 are kept. See Versions. |
| API key | A secret starting with vx_ that lets your code act as a developer in one workspace. See Authentication. |
| Call | One conversation between an agent and a caller. See The call object. |
| Call slot | One unit of a workspace’s concurrency limit. A ringing or in-progress call holds a slot. |
| Calling hours | The hours in which an agent’s outbound calls may be dialled. See Call flow. |
| Channel | phone (Plivo) or web (browser WebSocket). |
| Concurrency limit | How many calls a workspace may have live at once. See Limits and billing. |
| Credits | The workspace’s prepaid balance, in paise (100 paise = ₹1). Calls are billed per second. |
| Direction | outbound, inbound or web. |
| Event | One step of a call (user.turn, tool.result, call.ended…), saved on the timeline and sent to webhooks. See Webhook events. |
| Hang-up prompt | An optional check, after each agent reply, that asks the LLM whether the conversation is over. See Call tab. |
| Interruption | The caller talking over the agent, which stops speaking. |
| Paise | The unit of every amount in the API. 50000 is ₹500.00. |
| Queue | Where outbound calls wait for a free call slot and the calling window. See Call flow. |
| Timeline | A call’s list of events, from GET /api/v1/calls/{id}/events. |
| Tool | An HTTP endpoint the agent can call mid-conversation. See Tools. |
| Turn | One stretch of speech by the caller or the agent. A caller’s turn ends when the transcriber detects they have finished. |
user_data | Values you pass when placing a call; they fill the agent’s {variables} and are sent to your tools. |
| Variable | A {name} placeholder in the welcome message or prompt. See Agent tab. |
| Webhook | An HTTPS endpoint on your server that receives call events. See Webhooks. |
| Workspace | One company’s space in Voxa. Everything belongs to exactly one workspace. |