Get inbound router
Read an agent’s inbound router settings, its shared identity, and the tasks the router can choose from.
master_workflow and a task is a workflow. The agent ID goes in the path, and tasks appear in fields such as default_workflow_id and target_workflow_id.
How the router picks a task
For each new conversation, the router goes through these steps in order and stops at the first one that decides. Each step has alayer value, shown in List decisions.
error_fail_open).
Before you start
- The inbound router is not available on every account. Without it, every endpoint in this section returns 403
inbound_router_not_enabled. - MCP keys need
workflows:readto read andworkflows:writeto make changes. Full-access API keys need nothing else. - Every change requires
"confirm": truein the body. Without it, the API returns 400confirmation_requiredand changes nothing. - Errors return a stable code in
error, such asagent_group_not_found. Map the code to your own message. - To choose which numbers and inboxes reach the agent, see List entry points.
Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Path Parameters
Agent ID (master_workflow in the API). A malformed ID returns 400 invalid_group_id.
Response
Router of the agent.
Agent ID.
Router settings of the agent. null when the router was never configured for it.
The agent's shared identity: the name, voice, language, and instructions all of its tasks speak with, including while the agent works out which task should answer. When the agent has no complete identity of its own, the values shown come from the default task.
Tasks of the agent.