Sign in
chatbots

POST `/api/v0/main-frontend/chatbots/{chatbot_configuration_id}`

Changed on
post/api/v0/main-frontend/chatbots/{chatbot_configuration_id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

chatbot_configuration_idstring uuid required

Chatbot configuration id

Request body

chatbot_namestring required
chatbotconf_idstring uuid nullable
course_idstring uuid nullable
daily_tokens_per_userinteger required
default_chatbotboolean required
enabled_to_studentsboolean required
enabled_tool_categoriesToolCategory[] required
frequency_penaltynumber float required
hide_citationsboolean required
initial_messagestring required
initial_suggested_messagesstring[] nullable
maintain_azure_search_indexboolean required
max_output_tokensinteger required
model_idstring uuid required
presence_penaltynumber float required
promptstring required
publicly_accessibleboolean required
reasoning_effort'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' required
suggest_next_messagesboolean required
temperaturenumber float required
top_pnumber float required
use_azure_searchboolean required
use_semantic_rerankingboolean required
verbosity'low' | 'medium' | 'high' required
weekly_tokens_per_userinteger required

Response

Updated chatbot configuration

chatbot_namestring required
course_idstring uuid nullable
created_atstring date-time required
daily_tokens_per_userinteger required
default_chatbotboolean required
deleted_atstring date-time nullable
enabled_to_studentsboolean required
enabled_tool_categoriesToolCategory[] required
frequency_penaltynumber float required
hide_citationsboolean required
idstring uuid required
initial_messagestring required
initial_suggested_messagesstring[] nullable
maintain_azure_search_indexboolean required
max_output_tokensinteger required
model_idstring uuid required
presence_penaltynumber float required
promptstring required
publicly_accessibleboolean required
reasoning_effort'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' required
suggest_next_messagesboolean required
temperaturenumber float required
top_pnumber float required
updated_atstring date-time required
use_azure_searchboolean required
use_semantic_rerankingboolean required
verbosity'low' | 'medium' | 'high' required
weekly_tokens_per_userinteger required

Changes

  • 9a9373001977Revision changes
    • ▲

      added the new required request property

    • ▲

      removed the required property from the response with the status

    • ●

      removed the request property

    • ○

      added the non-success response with the status

    • ○

      added the required property to the response with the status

  • 09e472056408Revision changes
    • ▲

      added the new required request property

    • ○

      added the required property to the response with the status