Skip to main content
Outbound calling is temporarily disabled. Use the browser tester or incoming calls to test your agent. The reference below does not enable outbound calling.

Choose the right public run route

Bandwidth Agent Builder exposes two public outbound agent run route families. They are not interchangeable, even though both path parameters look like UUIDs.
Do not pass a workflow UUID to /public/agent/{uuid} and do not pass a trigger UUID to /public/agent/workflow/{workflow_uuid}. Bandwidth Agent Builder treats these as different identifier types and the request will fail if you mix them up.
Once Bandwidth Agent Builder resolves the target agent, both route families behave the same:
  • They accept the same request body
  • They return the same response shape
  • They require a Labs OAuth user access token with super_user and at least Editor access to the selected workspace
  • They use the same telephony configuration selection rules
If you specifically need the API Trigger route, see Trigger an outbound agent run by API Trigger node. To execute by Agent UUID, see Trigger an outbound agent run by Agent UUID.

Using initial context

initial_context passes runtime data into the agent at run time. Values are available as template variables in your agent’s prompt using double-brace syntax.
Your agent prompt can then reference {{customer_name}} and {{appointment_date}} and they will be substituted when the run starts.

Run state

Run records use state (initialized, running, or completed) and is_completed. Completion describes execution; review call disposition and results to determine the outcome. See calls and results.