Skip to main content
PATCH
Update test case

Authorizations

X-API-Key
string
header
required

Organization API key for authentication

Path Parameters

test_case_id
string
required

Test case ID

Required string length: 22

Body

application/json

Update request. Only provided fields will be updated.

input_str
string

Input for the test case

Minimum string length: 1
Example:

"What is the weather today?"

test_set_id
string

Test set ID (can move to different test set)

Required string length: 8
Example:

"newset12"

expected_behaviors
string[] | null

Expected behaviors (list of strings). This is the preferred field.

Example:
expected_output_str
string | null

DEPRECATED: Use expected_behaviors instead. If provided and expected_behaviors is not, this value will be wrapped in a list and used as expected_behaviors.

Example:

"The weather is sunny."

expected_output_json
object

Expected output as JSON object

description
string | null

Human-readable description

Example:

"Updated description"

input_type
enum<string> | null

Type of input for the test case. When set to SCRIPT, the simulation_metadata_input should contain a script_turns field with ordered persona turn texts.

Available options:
SCENARIO,
TRANSCRIPT,
IVR,
AUDIO,
MANUAL,
SCRIPT
Example:

"SCRIPT"

simulation_metadata_input
object

Metadata for simulation. Contents vary by input_type. When input_type is SCRIPT, include a script_turns field (array of strings) with the ordered lines for the persona to deliver.

metric_input
object

Input for metrics

user_notes
string | null

User notes

Example:

"Updated notes"

Response

Test case updated successfully

test_case
object

Test case resource.