Agents overview

Create, configure, publish, inspect, and retire DialNexa v1 agents.

Agents combine prompts, language, voice, model, transcription, analysis, and telephony settings. Calls use a published agent version; a newly created agent starts with draft version 1.

Lifecycle

Stage	Operation	What happens
Create draft	Create Agent	Creates the agent and version 1.
Configure	Update Agent	Changes a draft version and can attach knowledge bases or phone numbers.
Publish	Update Agent	Send version_number and is_published: true before live calls.
Use	Create Call	Starts a call with the latest published version or a specified published version.
Inspect	List Agents and Get Agent	Lists lightweight records or fetches all version details.
Retire	Delete Agent	Removes the agent from normal use. Review active routing first.

Minimal agent

A single-prompt agent needs title, language_id, voice_id, and prompt_text. Fetch catalog IDs from Languages and Voices. Advanced telephony, fallback, analysis, and speech settings are optional.

Production checklist

• Publish the intended version before creating a call.
• Use signed IDs exactly as returned, including prefixes.
• Treat phone-number assignment as a routing change, not display metadata.
• Test dynamic variables with the same keys you will send in call metadata.
• Fetch one agent when you need functions and complete version details.

Dashboard-only capabilities

Some agent-management actions remain available only in the dashboard. Use the operations listed on this page for public API integrations, and use the dashboard when an action is not listed here.