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.

Body

application/json

Input for creating a new agent

name
string
required

Name of the agent

Minimum string length: 1
description
string | null

Description of the agent

customId
string | null

Custom identifier for the agent. Must be unique in the project.

industry
enum<string> | null

The industry the agent serves. Picks the default capabilities and industry checks setup adds.

Available options:
HEALTHCARE,
FINANCIAL_SERVICES,
INSURANCE,
DEBT_COLLECTION,
RETAIL,
TRAVEL_AND_HOSPITALITY,
TELECOMMUNICATIONS,
TECHNOLOGY,
PUBLIC_SECTOR,
UTILITIES,
LOGISTICS,
AUTOMOTIVE,
HOME_SERVICES,
RESTAURANTS,
EDUCATION,
OTHER
prompt
string | null

The agent's system prompt. Setup reads it to decide what to test.

Required string length: 1 - 200000
endpoint
object | null

The phone number Roark calls to test the agent. Needed for the run plan and exploration calls.

websiteUrl
string<uri> | null

A page Roark reads to learn about the business.

testingInstructions
string | null

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

Maximum string length: 50000
autoSetup
object | null

Controls the flows, metrics and run plan Roark generates for the agent

Response

The created agent, and the setup Roark started for it

data
object
required