WHwhispa
scenarios

List Scenarios

List all scenarios with summary information.

When the voice-agent feature is off (VOICE_AGENT_ENABLED is false, the default), ai_agent scenarios are filtered out of the API surface entirely. This is defense in depth on top of the seed-time skip: it hides the demo scenarios even in DBs that were seeded before the flag existed, so they never reach a client UI or get enumerated.

get/scenarios

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Response

Successful Response

idstring uuid required
namestring required
display_namestring required
descriptionstring required
tool_countinteger required
scenario_metadataobject required
is_activeboolean required
is_defaultboolean required
modestring required
scorecard_template_keystring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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