Chats

Stream Chat Response

Changed on
get/chats/{chat_id}/stream

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/chats/{chat_id}/stream
  • Auth: none declared

Path parameters

chat_idstring required

Query parameters

ticketstring nullable

Single-use stream ticket from POST /auth/stream-ticket

tokenstring nullable

Legacy (bundles before EXC-1084): the access token itself

session_idstring nullable
exercise_idstring nullable
course_idstring nullable
course_route_kind'my_course' | 'assigned_course' nullable
cpge_exercise_idstring nullable
teacher_exercise_idstring nullable
assignment_idstring nullable
admin_feedback_idstring nullable
copy_correction_idstring nullable
copy_correction_copy_idstring nullable
copy_review_idstring nullable

A copy the student brought in to review (EXC-1529)

copy_review_exercise_idinteger nullable
teacher_exam_idstring nullable
teacher_exam_exercise_idinteger nullable
teacher_course_idstring nullable
teacher_course_unit_idstring nullable
results_assignment_idstring nullable
results_course_idstring nullable
results_class_idstring nullable
in_class_activity_idstring nullable
blank_pageboolean

The student is on the blank page of the course in context (EXC-1481): the chat is told, with the sheet on screen (blank_page_recall_id) when there is one.

blank_page_recall_idstring nullable
subject'maths' | 'physique-chimie' nullable

The matière the student is currently in (from the subject selector). Teachers derive it from their own subject. Defaults to maths.

request_idstring nullable
attach_onlyboolean
capabilitiesstring nullable

Comma-separated chat capabilities the client's bundle renders (EXC-1209, domain/chat_capabilities.py). Absent on bundles that predate them: those get the baseline rules only.

Response

Successful Response

unknown required

Changes

  • 7925dd21e4d0Revision changes
    • info

      added the new optional query request parameter blank_page

    • info

      added the new optional query request parameter blank_page_recall_id

    • info

      added the new optional query request parameter copy_review_exercise_id

    • info

      added the new optional query request parameter copy_review_id

    • info

      added the new optional query request parameter in_class_activity_id

  • 1160feeb2038Revision changes
    • info

      added the new optional query request parameter ticket

    • info

      the query request parameter token became optional

    • info

      query request parameter token was deprecated

    • info

      query request parameter token list-of-types was widened by adding types null

    • info

      for the query request parameter token, the type was generalized from string to no type