Get purchase overview

Calculates the cost and details for creating an assistant with specified videos

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

POST /assist-ai/purchase_overview

Calculates the cost of creating a Tutor AI for a given set of videos and language. Call this before buy_and_create to show the user how many credits will be charged.

Request Body

NameTypeRequiredDescription
video_idsarray of string (UUID)YesVideo IDs to estimate. Each must be a valid UUID.
langstringYesContent language. One of: pt-BR, en, es, fr, it, zh, de, ar, ru.
{
  "video_ids": ["{video_id_1}", "{video_id_2}"],
  "lang": "fr"
}

Response

{
  "num_of_videos": 2,
  "total_credit_cost": 0,
  "cost_per_minute": 0.2,
  "total_seconds": 27,
  "videos_to_generate_subtitles": [
    { "video_id": "{video_id_1}", "tier": "essential", "source_lang": "pt-BR" }
  ]
}
FieldTypeDescription
num_of_videosintegerTotal videos in the request.
total_credit_costnumberCredits that will be charged. 0 when all videos are covered by the free quota.
cost_per_minutenumberFixed rate: 0.2 (1 credit per 5 minutes of video, rounded up per video).
total_secondsintegerCombined duration of videos that still need a subtitle in the requested language.
videos_to_generate_subtitlesarrayVideos that need a new subtitle. Only listed when the video has no subtitle in lang.
videos_to_generate_subtitles[].video_idstringVideo ID.
videos_to_generate_subtitles[].tierstring"essential" when the subtitle is free (Gold/Enterprise within the daily quota of 100 videos). Absent when the video will be charged.
videos_to_generate_subtitles[].source_langstringPresent when the video already has a subtitle in another language and the new one will be generated by translation.

Notes

  • total_seconds only counts videos that need a subtitle. Videos that already have one in lang are excluded.
  • The response does not indicate whether a video is already bound to another Tutor AI. That conflict only surfaces on buy_and_create.

Errors

// 400 - video_ids not UUID
{ "errCode": "BadRequest", "errMsg": "video_ids must be a valid UUID" }

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

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

// 400 - video not yet converted
{ "errCode": "BadRequest", "errMsg": "Some videos are not converted yet" }
Body Params
video_ids
array of strings

Array of video IDs to calculate cost for

video_ids
string
enum

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:
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