Create new AI assistant

Creates a new AI assistant with specified video bindings and configuration

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

POST /assist-ai/buy_and_create

Creates a new Tutor AI with the specified videos and configuration. The Tutor is created in queued status and transitions to processing, then ready (or failed). Track progress with Get assistant details or List Tutors (paginated).

Request Body

NameTypeRequiredDescription
video_idsarray of string (UUID)YesVideos to include. Each must be a valid UUID.
langstringYesContent language. One of: pt-BR, en, es, fr, it, zh, de, ar, ru.
namestringYesTutor name. Must not be empty or whitespace-only.
open_new_tabbooleanYesWhether the chat opens in a new browser tab.
question_suggestionsbooleanNoEnable suggested questions in the chat.
initial_questionstringYesGreeting shown when the chat opens. Supports \n for line breaks. Must not be empty or whitespace-only.
{
  "video_ids": ["{video_id_1}", "{video_id_2}"],
  "lang": "fr",
  "name": "Cours de finance",
  "open_new_tab": false,
  "question_suggestions": true,
  "initial_question": "Comment puis-je vous aider ?\nPosez votre question."
}

A video belongs to one Tutor AI. Creating a Tutor AI with a video that is already in another (non-deleted) Tutor AI returns 400 and lists the conflicting video_ids in errMsg. Nothing is charged.

Response

{
  "message": "Assistant AI created successfully",
  "assistant": {
    "id": "{assistant_id}",
    "status": "queued",
    "name": "Cours de finance",
    "prompt": null,
    "initial_question": "Comment puis-je vous aider ?\nPosez votre question.",
    "videos": [
      {
        "id": "{video_id_1}",
        "status": "CONVERTED",
        "video_external_id": "{video_external_id}"
      }
    ]
  }
}

The Tutor starts in queued and moves to processing automatically. Poll assistant_by_id or get_all until status reaches ready.

Credit cost

Videos that already have a subtitle in the Tutor's language are free. Videos without one cost 1 credit per 5 minutes of video (rounded up per video). Gold and Enterprise accounts get free Essential subtitles in 34 languages within a daily quota of 100 videos. Use Get purchase overview to preview the cost before creating.

Errors

// 400 - video_ids not UUID (the old example ["video1","video2"] triggers this)
{ "errCode": "BadRequest", "errMsg": "video_ids must be a valid UUID" }

// 400 - missing video_ids
{ "errCode": "BadRequest", "errMsg": "must have required property 'video_ids'" }

// 400 - video already in another Tutor (errMsg is an object, not a string)
{
  "errCode": "BadRequest",
  "errMsg": {
    "message": "Video already bound to another assistant",
    "video_ids": ["{video_id_1}"]
  }
}

// 400 - empty name
{ "errCode": "BadRequest", "errMsg": "name must not be empty" }

// 400 - insufficient credits
{ "errCode": "BadRequest", "errMsg": "Insufficient credits" }

// 404 - video not found
{ "errCode": "NotFound", "errMsg": "Given video ids were not found" }

errMsg is an object when the error is about duplicate videos. In all other 400 errors errMsg is a string. Code that reads errMsg as a string will show [object Object] for this specific error.

show_watch_video_button vs assistantVisible. show_watch_video_button (Tutor AI setting, set via Update assistant information) removes the "Watch video" button from chat answers. assistantVisible=false (embed URL parameter) hides the Tutor AI icon in that specific embed. Neither one affects the other.

Body Params
video_ids
array of strings
required

Array of video IDs to bind to the assistant

video_ids*
string
enum
required

Idioma do Tutor, usado para gerar resumos, sugestoes de perguntas e respostas do chat. Valores aceitos: pt-BR, en, es. Outros valores sao normalizados para o idioma mais proximo; valores nao reconhecidos usam pt-BR como padrao. Recomenda-se enviar exatamente um dos tres.

Allowed:
string
required

Name of the assistant

boolean
required

Whether to open chat in a new tab

boolean

Whether to enable question suggestions

string
required

Initial question to display in the chat

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