For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Skip to main content
Voice Testing›Edit a voice scenario
TestMu AI
StatusCommunityBlog
Selenium Automation API
Automated Screenshots API
App Automation API (Real Devices)
Smart UI
Cypress Automation
User Management
Test Manager
HyperExecute
Accessibility Testing
Analytics
Performance Testing
Audit logs
Agent Testing API
Voice Testing

Edit a voice scenario

Edit an existing voice scenario.

PUT
/api/projects/{project_id}/voice-scenarios/edit
Edit a voice scenario
curl --request PUT \
  --url "https://agent-testing.lambdatest.com/api/projects/{project_id}/voice-scenarios/edit" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "scenario_id": "5a1e2b7c-9d3f-4e21-8c47-0f6b2d9a1e34",
    "scenario_data": {
      "title": "Order status lookup",
      "description": "Caller checks an existing order and now also asks to change the delivery address.",
      "persona": "Adaptable Communicator",
      "expected_output": [
        "Agent asks for the order number",
        "Agent confirms the new delivery address",
        "Agent summarizes the change before ending the call"
      ],
      "max_turns": 15
    }
  }'
{
  "success": true,
  "scenario": {
    "id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "persona": "<string>",
    "category": "task_completion",
    "expected_output": [
      "<string>"
    ],
    "max_turns": 123,
    "first_speaker": "<string>",
    "max_duration_seconds": 123,
    "prompt_version_id": "<string>",
    "sync_status": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

project_idstringrequired

Body

application/json
scenario_idstringrequired
scenario_dataobjectrequired

Response

application/json

The updated scenario.

successbooleanrequired
scenarioobjectrequired

The created/updated scenario

scenario.idstring
Example: "<string>"
scenario.titlestring
Example: "<string>"
scenario.descriptionstring
Example: "<string>"
scenario.personastring
Example: "<string>"
scenario.categorystring
Example: "task_completion"
scenario.expected_outputstring[]
Example:
["<string>"]
scenario.max_turnsnumber
scenario.first_speakerstring
Example: "<string>"
scenario.max_duration_secondsnumber
scenario.prompt_version_idstring
Example: "<string>"
scenario.sync_statusstring
Example: "<string>"
Edit a voice scenario
curl --request PUT \
  --url "https://agent-testing.lambdatest.com/api/projects/{project_id}/voice-scenarios/edit" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "scenario_id": "5a1e2b7c-9d3f-4e21-8c47-0f6b2d9a1e34",
    "scenario_data": {
      "title": "Order status lookup",
      "description": "Caller checks an existing order and now also asks to change the delivery address.",
      "persona": "Adaptable Communicator",
      "expected_output": [
        "Agent asks for the order number",
        "Agent confirms the new delivery address",
        "Agent summarizes the change before ending the call"
      ],
      "max_turns": 15
    }
  }'
{
  "success": true,
  "scenario": {
    "id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "persona": "<string>",
    "category": "task_completion",
    "expected_output": [
      "<string>"
    ],
    "max_turns": 123,
    "first_speaker": "<string>",
    "max_duration_seconds": 123,
    "prompt_version_id": "<string>",
    "sync_status": "<string>"
  }
}