Skip to main content
POST
Create a chatbot. The secret key is returned ONCE.
Required scope: chatbots.edit
Requires chatbots enabled on your account. Otherwise the request is refused; see Errors.

Authorizations

Authorization
string
header
required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json
name
string
required
Required string length: 1 - 120
systemPrompt
string
required
Required string length: 1 - 20000
model
string | null
Required string length: 1 - 120
temperature
number | null
Required range: 0 <= x <= 2
maxOutputTokens
integer | null
Required range: 64 <= x <= 8192
rateLimitPerMinute
integer
Required range: 1 <= x <= 10000
knowledgeBaseIds
string[]
Maximum array length: 50
Minimum string length: 1

Response

Created

id
string
required
name
string
required
systemPrompt
string
required
model
string | null
required
status
string
required
temperature
number | null
required
maxOutputTokens
number | null
required
rateLimitPerMinute
number
required
secretKeyLast4
string
required
knowledgeBaseIds
string[]
required
createdAt
string
required
updatedAt
string
required
secret
string
required