Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

agentId
string<uuid>
required

Body

application/json

Input for setting up an existing agent

industry
enum<string>

The industry the agent serves.

Available options:
HEALTHCARE,
FINANCIAL_SERVICES,
INSURANCE,
DEBT_COLLECTION,
RETAIL,
TRAVEL_AND_HOSPITALITY,
TELECOMMUNICATIONS,
TECHNOLOGY,
PUBLIC_SECTOR,
UTILITIES,
LOGISTICS,
AUTOMOTIVE,
HOME_SERVICES,
RESTAURANTS,
EDUCATION,
OTHER
websiteUrl
string<uri>

A page Roark reads to learn about the business.

testingInstructions
string

What you want tested, in your own words. Each scenario you describe becomes a flow.

Maximum string length: 50000
capabilities
enum<string>[]

The capabilities to test. Omit to let Roark work them out from the agent.

Available options:
APPOINTMENT_BOOKING,
FAQ,
IDENTITY_VERIFICATION,
ACCOUNT_MANAGEMENT,
BILLING_AND_PAYMENTS,
ORDER_MANAGEMENT,
TROUBLESHOOTING,
CALL_ROUTING,
LEAD_QUALIFICATION,
COLLECTIONS,
OUTBOUND_CALLING
agentEndpointId
string<uuid>

The endpoint the run plan calls. Defaults to the agent's newest endpoint.

explore
object

Exploration settings

Response

Setup has started

data
object
required

The tests Roark generated for an agent, and why