Update assistant information

Updates the basic information and configuration of an existing AI assistant

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

PUT /assist-ai/update_assistant_info/{assistant_id}

Updates the configuration of an existing Tutor AI. Only the fields you send are changed; omitted fields keep their current value.

Parameters

NameInTypeRequiredDescription
assistant_idpathstring (UUID)YesTutor AI identifier.

Request Body

All fields are optional. Send only the ones you want to change.

NameTypeDescription
namestringTutor name.
open_new_tabbooleanWhether the chat opens in a new tab.
question_suggestionsbooleanEnable suggested questions.
initial_questionstringGreeting shown when the chat opens.
promptstringCustom system prompt for the assistant.
show_watch_video_buttonbooleanShow the "Watch video" button inside chat answers. Default true. Tutors created before this feature default to true.
statusstringready or disabled only. See the status rules below.
{
  "show_watch_video_button": false
}

Status rules

The status field only accepts ready and disabled. Any other value returns 400 InvalidStatus.

TransitionCondition
To readyThe Tutor must have at least one successfully processed video or file.
To disabledAlways allowed. The Tutor is removed from the player.

Response

{ "message": "Assistant AI updated successfully" }

Errors

// 400 - invalid status value (e.g. "active", "inactive")
{ "errCode": "InvalidStatus", "errMsg": "Invalid status" }

// 400 - activating a Tutor with no items
{
  "errCode": "AssistantWithoutContent",
  "errMsg": "A Tutor AI needs at least one video or file before it can be activated"
}

// 400 - activating a Tutor where all items failed
{
  "errCode": "AssistantWithoutReadyContent",
  "errMsg": "A Tutor AI with only failed items must be reprocessed before it can be activated"
}

// 400 - activating a Tutor that is not ready or disabled
{
  "errCode": "AssistantNotActivatable",
  "errMsg": "Only a disabled or ready Tutor AI can be activated"
}

// 400 - Tutor in payment_failed
{
  "errCode": "AssistantPaymentFailed",
  "errMsg": "Assistant status cannot be updated if payment failed"
}

If the update is saved but fails to propagate to all player edges, the API returns 500 AssistantPropagationFailed. Repeating the same call is safe.

Path Params
uuid
required

Unique identifier of the assistant

Body Params
string

Updated name for the assistant

boolean

Whether to open chat in a new tab

boolean

Whether to enable question suggestions

string

Initial question to display

string

Custom prompt for the assistant

string
enum

Status of the assistant

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json