ROroarkhq
Prospect Simulation

Run a free simulation against a prospect agent

Changed on

Public endpoint: provisions a per-prospect project, runs a canned scenario template against the submitted phone number, and returns a report token to poll. The teaser report is also emailed when ready.

post/v1/public/prospect-sim/run

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/public/prospect-sim/run
  • Auth
    HTTP bearer

Request body

templateKey'appointment' | 'support' | 'billing' required
phoneNumberstring required
emailstring email required
namestring
agentDescriptionstring
captchaTokenstring

Response

The simulation was accepted and started

Changes