Bot

Edit an existing bot

PATCH
/api/v1/bot/edit/{botId}
/api/v1/bot/edit/{botId}

The Authorization access token

Authorization

Authorization
Required
<token>

Please enter a valid access token

In: header

Request Body

application/jsonOptional

The updated bot data

createdAtstring

Format: "date-time"

updatedAtstring

Format: "date-time"

namestring | null

iconstring | null

avatarUrlstring | null

descriptionstring | null

hideUserAvatarboolean

hideUserNameboolean

alignUserMessagesLeftboolean

modelIdstring | null

systemPromptstring | null

starterPromptsarray | null

chunkLimitinteger

Format: "int32"

chatMemoryinteger

Format: "int32"

maxTokensinteger

Format: "int32"

temperaturenumber

Format: "double"

topPnumber

Format: "double"

frequencyPenaltynumber

Format: "double"

presencePenaltynumber

Format: "double"

stopSequencesstring | null

welcomeMessagestring | null

placeholderstring | null

peekMessagestring | null

peekMessageDelayinteger

Format: "int32"

headerTextstring | null

headerSubtextstring | null

positioninteger

Format: "int32"Value in: 0 | 1 | 2 | 3

hideBrandingboolean

primaryColorstring | null

secondaryColorstring | null

accentColorstring | null

backgroundColorstring | null

textColorstring | null

headerColorstring | null

headerTextColorstring | null

systeminteger

Format: "int32"Value in: 0 | 1 | 2

Path Parameters

botId
Required
string

The ID of the bot to edit

curl -X PATCH "https://example.com/api/v1/bot/edit/string" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": null,
    "icon": null,
    "avatarUrl": null,
    "description": null,
    "hideUserAvatar": true,
    "hideUserName": true,
    "alignUserMessagesLeft": true,
    "modelId": null,
    "systemPrompt": null,
    "starterPrompts": null,
    "chunkLimit": 0,
    "chatMemory": 0,
    "maxTokens": 0,
    "temperature": 0.1,
    "topP": 0.1,
    "frequencyPenalty": 0.1,
    "presencePenalty": 0.1,
    "stopSequences": null,
    "welcomeMessage": null,
    "placeholder": null,
    "peekMessage": null,
    "peekMessageDelay": 0,
    "headerText": null,
    "headerSubtext": null,
    "position": 0,
    "hideBranding": true,
    "primaryColor": null,
    "secondaryColor": null,
    "accentColor": null,
    "backgroundColor": null,
    "textColor": null,
    "headerColor": null,
    "headerTextColor": null,
    "system": 0
  }'

OK

Previous

Delete a bot

Next

Get a bot by ID