Skip to main content
POST
cURL
This endpoint lets you create a new Bring Your Own Agent (BYOA). See BYOA Agent for more information.

Authorizations

X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Body

application/json

Input serializer for creating a Bring Your Own Agent (BYOA) agent.

webhookUrl
string
required

The webhook URL where messages will be forwarded

Response

201 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 255
systemPrompt
string
required
firstMessage
string
required
profilePicture
string
required
read-only
tools
object[]
required
read-only
documents
object[]
required
read-only
memoryKeys
object[]
required
read-only
wakeUpConfigs
object[]
required
read-only
outboundTriggers
object[]
required
read-only
websiteTools
object[]
required
read-only
imageGenerateTools
object[]
required
read-only
handoffTools
object[]
required
read-only
mcpConfigs
object[]
required
read-only
paywallConfig
string
required
read-only
adConfig
string
required
read-only
creditSettings
string
required
read-only
voiceCallConfig
string
required
read-only
owner
string
required
read-only
sharings
string
required
read-only
phoneNumbers
object[]
required
read-only
totalMessages
string
required
read-only
totalSessions
string
required
read-only
connectUrl
string
required
read-only
ownerActive
string
required
read-only
createdAt
string<date-time>
required
read-only
description
string
icebreakers
any
llmModel
string | null