Create a simulation scenario

Create a new simulation scenario. Scenarios are templates used when generating test cases to ensure coverage of specific situations.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

namestringRequired

Name of the simulation scenario template

descriptionstringRequired

Description of what the scenario template should verify when generating test cases

200

statusstring

Whether the request was successful.

responseobject

400

Bad Request Error

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

Name of the simulation scenario template

Description of what the scenario template should verify when generating test cases

Whether the request was successful.

$	curl -X POST https://api.synthflow.ai/v2/simulation_scenarios \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Verify customer satisfaction",
>	"description": "Ensure the agent maintains a positive tone and resolves customer issues"
>	}'

1	{
2	"status": "ok",
3	"response": {
4	"simulation_scenario": {
5	"id": "9ad09ad3-9c22-441e-ae35-c05016a09786",
6	"name": "Verify customer satisfaction"
7	}
8	}
9	}

$	curl -X POST https://api.synthflow.ai/v2/simulation_scenarios \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Verify customer satisfaction",
>	"description": "Ensure the agent maintains a positive tone and resolves customer issues"
>	}'

1	{
2	"status": "ok",
3	"response": {
4	"simulation_scenario": {
5	"id": "9ad09ad3-9c22-441e-ae35-c05016a09786",
6	"name": "Verify customer satisfaction"
7	}
8	}
9	}