Update a chatbot

Update configuration, pause/resume, or replace knowledge-base attachments.

PATCH /chatbots/{id}

Update a chatbot

cURL

curl --request PATCH \
  --url https://api.pineyard.ai/chatbots/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "systemPrompt": "<string>",
  "model": "<string>",
  "temperature": 1,
  "maxOutputTokens": 4128,
  "rateLimitPerMinute": 5000,
  "knowledgeBaseIds": [
    "<string>"
  ]
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "systemPrompt": "<string>",
  "model": "<string>",
  "status": "<string>",
  "temperature": 123,
  "maxOutputTokens": 123,
  "rateLimitPerMinute": 123,
  "secretKeyLast4": "<string>",
  "knowledgeBaseIds": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

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.

Path Parameters

id · string · required

Body

application/json

name · string

Required string length: 1 - 120

systemPrompt · string

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

status · enum<string>

Available options: ACTIVE, PAUSED

knowledgeBaseIds · string[]

Maximum array length: 50

Minimum string length: 1

Response

200

application/json

OK

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