Skip to main content
PUT
/
v0
/
applications
/
{id}
/
chatbot-config
Update application chatbot config
curl --request PUT \
  --url https://api.avidoai.com/v0/applications/{id}/chatbot-config \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data @- <<EOF
{
  "systemPrompt": "You are a helpful customer support chatbot.\n\nAnswer the user's question using the conversation history and the available knowledge tools. For factual product, policy, support, or troubleshooting questions, search the knowledge base before answering. Cite the articles you use. If the available knowledge is missing or insufficient, say that clearly instead of guessing. Keep answers concise, practical, and written for an end user."
}
EOF
{
  "data": {
    "systemPrompt": "You are a helpful customer support chatbot.\n\nAnswer the user's question using the conversation history and the available knowledge tools. For factual product, policy, support, or troubleshooting questions, search the knowledge base before answering. Cite the articles you use. If the available knowledge is missing or insufficient, say that clearly instead of guessing. Keep answers concise, practical, and written for an end user.",
    "defaultSystemPrompt": "You are a helpful customer support chatbot.\n\nAnswer the user's question using the conversation history and the available knowledge tools. For factual product, policy, support, or troubleshooting questions, search the knowledge base before answering. Cite the articles you use. If the available knowledge is missing or insufficient, say that clearly instead of guessing. Keep answers concise, practical, and written for an end user.",
    "platformInstructionsPreview": "Avido automatically appends fixed instructions at runtime that define the available knowledge tools, citation behavior, current-application knowledge scope, no-mutation behavior, and safety rules. These platform instructions are not editable."
  }
}

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

id
string<uuid>
required

The unique identifier of the application

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for updating chatbot playground configuration.

systemPrompt
string | null

Customer-editable chatbot behavior prompt. Empty strings normalize to null.

Maximum string length: 12000
Example:

"You are a helpful customer support chatbot.\n\nAnswer the user's question using the conversation history and the available knowledge tools. For factual product, policy, support, or troubleshooting questions, search the knowledge base before answering. Cite the articles you use. If the available knowledge is missing or insufficient, say that clearly instead of guessing. Keep answers concise, practical, and written for an end user."

Response

Successfully updated chatbot playground config

Successful response containing chatbot playground configuration.

data
ApplicationChatbotConfig · object
required

Per-application chatbot playground configuration.