GEgetpuppeteer
Scenarios

Create Scenario

Create a new test scenario for a project.

post/scenarios/{project_id}

Request

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

Path parameters

project_idstring required

Headers

Authorizationstring required

Request body

namestring required

Human-readable label for the scenario

descriptionstring nullable

What this scenario is meant to test

json_dataobject nullable

Initial mocked data that seeds the conversation

mock_responsesobject nullable

Predefined HTTP-service responses keyed by service name

trigger_dataobject nullable

Maps a trigger class name to the payload delivered to its check() when the scenario is applied, e.g. {'ReceivedHealthieWebhookTrigger': {...}}.

env_variablesobject nullable

Environment variable overrides for this scenario

env_secretsobject nullable

Environment secret overrides, merged per key: the '****' mask keeps the stored value, any other value replaces it, and an omitted key is removed.

retell_account_idstring nullable

Voice integration used when the scenario is run in voice mode

Response

Successful Response

unknown required

Changes

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