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.
"message":"Voice tests submitted to HyperExecute. Poll GET /api/voice-results/suite/0b8e2f34-6c1d-4f7a-9e52-3d84a1c07b96 for results."
}
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_idsarrayrequired
List of scenario IDs to test
suite_idstring
Suite ID (created if not provided)
suite_namestring
Suite name
voice_configobjectrequired
Voice configuration for TTS during voice agent testing.
endpoint_profile_idstringrequired
EndpointProfile ID with the voice agent's API configuration (endpoint profiles are created in the product UI)
max_turnsinteger
Max conversation turns per scenario
test_profile_idstring
Test profile ID for injecting test data into the simulated caller (test profiles are created in the product UI). Acts as suite-level override. Falls back to scenario-level test_profile_id, then project default.
scenario_matrixarray
Optional per-scenario matrix axes (voices/personas/test_profiles/iterations) for fan-out. Omit or leave empty to run one test per scenario using voice_config.
Response
application/json
Tests packaged and (when LambdaTest credentials are available) submitted to HyperExecute. Returns immediately — poll `GET /api/voice-results/suite/{suite_id}` for progress and results.
suite_idstringrequired
Suite grouping all runs from this submission
job_idstring
HyperExecute job ID (null if submission was skipped/failed)
hyperexecute_urlstring
HyperExecute dashboard deep-link for this job
package_urlstring
Download URL of the generated test package
total_scenariosintegerrequired
Number of test runs created (after matrix fan-out)