Skip to main content
GET
/
v0
/
applications
/
{id}
/
chatbot-config
Get application chatbot config
curl --request GET \
  --url https://api.avidoai.com/v0/applications/{id}/chatbot-config \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "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"

Response

Successfully retrieved chatbot playground config

Successful response containing chatbot playground configuration.

data
ApplicationChatbotConfig · object
required

Per-application chatbot playground configuration.