GEgetpuppeteer
Simulations

Run Single Simulation

Start a single conversation simulation for a specific project. This endpoint creates a new thread, returns the thread_id immediately, and runs the simulation in the background. The simulation will stream messages to the websocket as it progresses.

post/projects/{project_id}/single-simulation

Request

  • Base URL
    https://api.puppeteerai.com
  • Auth
    none declared. Required headers: Authorization

Path parameters

project_idstring required

Headers

Authorizationstring required

Request body

is_voiceboolean

Whether to run in voice mode

call_direction'inbound' | 'outbound' nullable

Fake the call direction for voice runs so configs branching on <<call_direction>> can be tested

ai_promptstring required

AI system prompt to use

user_messagesstring[] nullable

List of user messages to send in the conversation

json_dataobject nullable

Initial JSON data for the thread

turn_countinteger required

Maximum number of turns (AI responses) per conversation (max 30)

thread_idstring required

Thread ID to use for the simulation

temperaturenumber nullable

Model temperature for randomness control (canonical scale 0-1)

message_delaynumber nullable

Delay in seconds between simulation messages (default 2.0, 0 = no delay)

persona_modelstring nullable

Model to use for persona message generation (default: gpt-5.6-luna)

env_variablesobject nullable

Environment variable overrides for this simulation

env_secretsobject nullable

Environment secret overrides for this simulation

retell_account_idstring nullable

Retell account to use for voice simulations; required when the project has multiple voice integrations

Response

Successful Response

thread_idstring required
statusstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.