version: a version ID or slug such as v2 from get_agent’s versions. Leave it out to act on the live version (Agent versions).
Workspace
get_account_overview
The starting point, read-only, no inputs. Returns the workspace (name, currency, available credits, billing type), its phone numbers with a usable_for_live_calls flag, its agents, the last 30 days of call metrics, a ready_to_call verdict and suggested next steps.
Calls
place_call
Dials a real number with an agent and returns a call_id straight away. It spends credits; clients should ask you before running it.
If the caller ID can’t place live calls, for example a Ringg test number, the error lists numbers that can.
get_call
A call’s status and, once it has ended, the transcript, recording link, tool calls and post-call analysis.
Final statuses:
completed, failed, error, cancelled, forwarded. retry means Ringg will redial under the agent’s retry settings.
list_calls
Recent calls, newest first, as compact rows without transcripts; use get_call for detail.
get_call_analytics
Totals for a period: calls attempted and completed, connection rate, average duration and minutes connected. Inputs: start_date (default 30 days ago), end_date (default today) and an optional agent_id.
Agents
list_agents
One page of agents with ID, name, type and versions. Inputs: search (case-insensitive, on the name), limit (1 to 100, default 25) and offset. When the response says has_more, ask again with offset set to next_offset.
get_agent
One agent’s full configuration: every prompt section, language, voice, the custom variables the prompt expects (fill them with place_call’s variables), and the tools attached per phase. Inputs: agent_id, optional version.
create_agent
Creates a ready-to-call voice agent from a plain-language brief. Ringg picks a voice for the language and adds default tools.
update_agent
Changes an agent’s name, language, voice, intro line or variables. Only the fields you pass change, and calls already in progress are unaffected. Two shortcuts edit one prompt section each: call_purpose replaces the Task section and additional_info replaces FAQ Guidelines. custom_variables replaces the whole list. Returns the updated configuration.
list_voices
Voices you can assign, each with a preview_url. Filter by language (for example hi-IN) and gender (male or female).
Prompt editing
edit_prompt_section
Changes one prompt section and leaves the rest alone; the client reads the sections with get_agent first. Set section to the section title and mode to one of:
In prompt text, variables are written
{{name}}, pre-call tool outputs ((tool.field)), and on-call tools @||tool||.
set_agent_prompt
Replaces every section at once with sections (1 to 30 items, each a unique title and its content). Sections you leave out are deleted, so use it only to restructure or write a prompt from scratch.
Agent tools
These manage the tools an agent calls before, during and after a call.
Tool names may use letters, digits,
_ and -, up to 64 characters, and must be unique across phases. Header and query values that look like credentials are masked when read back; sending the masked value keeps the stored secret.
Multi-prompt agents
These build and edit multi-prompt agents, which the server calls flow or multi-node agents.
Node types, as
get_flow_building_guide defines them: agent_node, speak_node, router_node, action_node, transfer_node (terminal; hands the call to a number or target), collect_node, keypad_menu_node, widget_node, plus start_node and end_node.