Start a simulation

1 curl -X POST https://api.synthflow.ai/v2/simulations/start \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "simulation_case_id": "string", 6 "target_agent_id": "string" 7 }'

1 { 2 "status": "ok", 3 "response": { 4 "simulation_id": "string", 5 "simulation_session_id": "string", 6 "simulation_case_id": "string", 7 "simulation_case_name": "string", 8 "simulation_case_prompt": "string", 9 "success_criteria": [ 10 "string" 11 ], 12 "call_success_type": "all", 13 "persona_agent_id": "string", 14 "persona_phone_number": "string", 15 "target_agent_id": "string", 16 "agent_name": "string", 17 "agent_avatar_url": "string", 18 "target_phone_number": "string", 19 "target_call_id": "string", 20 "custom_variables": {}, 21 "status": "in-progress", 22 "workspace_id": "string", 23 "created_at": "2024-01-15T09:30:00Z", 24 "updated_at": "2024-01-15T09:30:00Z", 25 "error_info": { 26 "message": "string", 27 "code": 1, 28 "type": "string" 29 }, 30 "recording_url": "string", 31 "timeline": [ 32 { 33 "sender_type": "string", 34 "value": "string", 35 "type": "string", 36 "timestamp_datetime": "2024-01-15T09:30:00Z", 37 "timestamp": 1.1 38 } 39 ], 40 "success_criteria_analysis": { 41 "success": true, 42 "evaluations": [ 43 { 44 "success": true, 45 "reasoning": "string" 46 } 47 ] 48 } 49 } 50 }

Start a new simulation using a simulation case.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

simulation_case_idstringRequiredformat: "uuid"

target_agent_idstringRequiredformat: "uuid"

simulation_session_idstring or nullOptionalformat: "uuid"

custom_variablesmap from strings to anyOptional

Response

200

statusstring or null

Whether the request was successful.

responseobject or null

Simulation details.

Authentication

Request

Response

Errors