v28

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-05-2887246443.7 KB

Create a new draft agent version from a base version.

post/create-agent-version/{agent_id}

Path parameters

agent_idstring required
Example:agent_xxx

Unique id of the agent.

Request body

base_versioninteger required

Existing version used as the base when creating a new draft.

Example request

{
  "base_version": 12
}

Response

Draft version created successfully.

OR

Example response

{
  "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
  "base_version": 12,
  "agent_name": "Jarvis",
  "version_description": "Customer support agent for handling product inquiries",
  "voice_id": "retell-Cimo",
  "fallback_voice_ids": [
    "cartesia-Cimo",
    "minimax-Cimo"
  ],
  "voice_temperature": 1,
  "voice_speed": 1,
  "enable_dynamic_voice_speed": true,
  "enable_dynamic_responsiveness": true,
  "volume": 1,
  "voice_emotion": "calm",
  "responsiveness": 1,
  "interruption_sensitivity": 1,
  "enable_backchannel": true,
  "backchannel_frequency": 0.9,
  "backchannel_words": [
    "yeah",
    "uh-huh"
  ],
  "reminder_trigger_ms": 10000,
  "reminder_max_count": 2,
  "ambient_sound_volume": 1,
  "language": "en-US",
  "webhook_url": "https://webhook-url-here",
  "webhook_timeout_ms": 10000,
  "boosted_keywords": [
    "retell",
    "kroger"
  ],
  "data_storage_setting": "everything",
  "data_storage_retention_days": 30,
  "opt_in_signed_url": true,
  "signed_url_expiration_ms": 86400000,
  "pronunciation_dictionary": [
    {
      "word": "actually",
      "alphabet": "ipa",
      "phoneme": "ˈæktʃuəli"
    }
  ],
  "end_call_after_silence_ms": 600000,
  "max_call_duration_ms": 3600000,
  "voicemail_message": "Hi, please give us a callback.",
  "voicemail_detection_timeout_ms": 30000,
  "voicemail_option": {
    "action": {
      "type": "static_text",
      "text": "Please give us a callback tomorrow at 10am."
    }
  },
  "ivr_option": {
    "action": {
      "type": "hangup"
    }
  },
  "call_screening_option": {
    "agent_identity": "Acme Health scheduling team",
    "call_purpose": "confirming your appointment for tomorrow"
  },
  "post_call_analysis_data": [
    {
      "type": "string",
      "name": "customer_name",
      "description": "The name of the customer.",
      "examples": [
        "John Doe",
        "Jane Smith"
      ]
    }
  ],
  "analysis_successful_prompt": "The agent finished the task and the call was complete without being cutoff.",
  "analysis_summary_prompt": "Summarize the outcome of the conversation in two sentences.",
  "analysis_user_sentiment_prompt": "Evaluate the user's sentiment based on their tone and satisfaction level.",
  "begin_message_delay_ms": 1000,
  "ring_duration_ms": 30000,
  "stt_mode": "fast",
  "vocab_specialization": "general",
  "allow_user_dtmf": true,
  "user_dtmf_options": {
    "termination_key": "#"
  },
  "denoising_mode": "noise-cancellation",
  "timezone": "America/New_York",
  "last_modification_timestamp": 1703413636133
}