Get assistant details

Retrieves detailed information about a specific AI assistant

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

GET /assist-ai/assistant_by_id/{assistant_id}

Returns the full details of a Tutor AI, including its videos, files, and per-item processing status.

Parameters

NameInTypeRequiredDescription
assistant_idpathstring (UUID)YesTutor AI identifier. Must be a valid UUID.

Response

{
  "id": "{assistant_id}",
  "name": "Curso de Financas",
  "lang": "pt-BR",
  "status": "failed",
  "failure_reason": "provider_error",
  "question_suggestions": true,
  "open_new_tab": false,
  "show_watch_video_button": true,
  "initial_question": "Como posso te ajudar hoje?",
  "prompt": null,
  "pullzone_name": "{pullzone}",
  "answers_count": 0,
  "updating": false,
  "suggestions": ["Como evitar que legendas aparecam durante gravacoes?"],
  "videos": [
    {
      "id": "{video_id_1}",
      "title": "Aula 01",
      "status": "CONVERTED",
      "failure_reason": null,
      "video_external_id": "{video_external_id}",
      "chat_is_visible": true,
      "process_status": "success"
    },
    {
      "id": "{video_id_2}",
      "title": "Aula 02.mkv",
      "status": "CONVERTED",
      "failure_reason": "provider_error",
      "video_external_id": "{video_external_id}",
      "chat_is_visible": true,
      "process_status": "failed"
    }
  ],
  "files": [],
  "items": [
    { "id": "{video_id_1}", "type": "video", "status": "success", "failure_reason": null },
    { "id": "{video_id_2}", "type": "video", "status": "failed", "failure_reason": "provider_error" }
  ],
  "has_processing_items": false
}
FieldTypeDescription
statusstringTutor status: queued, processing, ready, failed, disabled, payment_failed.
failure_reasonstring or nullnull when the Tutor is not in a failure state. See failure reasons.
show_watch_video_buttonbooleanWhether the "Watch video" button appears in chat answers.
answers_countintegerTotal chat answers delivered by this Tutor.
updatingbooleantrue when the Tutor was previously ready and is reprocessing items.
videos[].statusstringVideo status in the library (e.g. CONVERTED).
videos[].process_statusstringVideo status inside the Tutor: queued, processing, success, failed.
videos[].failure_reasonstring or nullPer-video failure reason.
files[]arrayKnowledge base files. Each has id, file_name, file_type, file_id, status, failure_reason, processed_at.
items[]arrayUnified list of all items (videos and files) with id, type, status, failure_reason.
has_processing_itemsbooleantrue if any item is still being processed.

Failure reasons

ValueDashboard labelCan retry?
no_speech"Video sem fala identificada"No. Remove the video.
subtitle_error"Falha temporaria"Yes
provider_error"Falha temporaria"Yes
insufficient_credits"Creditos insuficientes"No. Add credits first.

failure_reason is null when the item or Tutor is not in a failure state.

Errors

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

// 404 - Tutor not found
{ "errCode": "NotFound", "errMsg": "Assistant not found" }
Path Params
uuid
required

Unique identifier of the assistant

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