Chat & AI Agents (1.0.0)

Creates a new legacy chat session or soft-deletes an existing one.

POST — Creates a new Chatsession record, sets starttimestamp, session_timestamp, and update_timestamp to now, and returns the generated sessionid (HTTP 201).

DELETE /{sessionid}/ — Soft-deletes the session by setting is_deleted=True.

Note: This operates on the legacy Chatsession model. New session management uses ConversationSession in conversationController.py.

Creates a new legacy chat session or soft-deletes an existing one.

POST — Creates a new Chatsession record, sets starttimestamp, session_timestamp, and update_timestamp to now, and returns the generated sessionid (HTTP 201).

DELETE /{sessionid}/ — Soft-deletes the session by setting is_deleted=True.

Note: This operates on the legacy Chatsession model. New session management uses ConversationSession in conversationController.py.

Creates or updates a ConversationSession (current-generation chat session model replacing the legacy Chatsession).

POST — Creates a new ConversationSession, stamps start_time, create_timestamp, and update_timestamp to now, and returns the generated sessionid (HTTP 201).

PUT /{id}/ — Updates an existing session record and returns the sessionid (HTTP 200). Returns 404 if the session does not exist.

DELETE /{id}/ — Soft-deletes the session via the inherited destroy action.

Creates or updates a ConversationSession (current-generation chat session model replacing the legacy Chatsession).

POST — Creates a new ConversationSession, stamps start_time, create_timestamp, and update_timestamp to now, and returns the generated sessionid (HTTP 201).

PUT /{id}/ — Updates an existing session record and returns the sessionid (HTTP 200). Returns 404 if the session does not exist.

DELETE /{id}/ — Soft-deletes the session via the inherited destroy action.

Closes an active ConversationSession identified by its id in the URL path.

PUT /{id}/ — Marks the session as closed (status=False) and sets end_time and update_timestamp to now.

If the session has at least one ConversationMessage, the endpoint synchronously calls the asyncmessage-worker (ASYNC_MSG_URL/apis/prediction/session_summary/generate) to generate and store a session title. If the worker returns a summary, its title is persisted on the session. If the session has no messages, title is set to None and the session is still marked closed.

Returns the closed sessionid (HTTP 200). GET, POST, and DELETE are excluded from the public schema.

Retrieves active or inactive ConversationSession records for a given userId, with active sessions filtered to exclude those already linked to an open recommendation.

POST (active=True) — Returns open sessions (status=True) for the user. Incomplete RecommendationDetail rows targeting the same user are fetched and their associated session ids are removed from the result, so only sessions without a pending recommendation are returned. Returns 204 if none remain.

POST (active=False) — Returns closed sessions (status=False) for the user, ordered by id descending (most recent first). Returns 204 if none exist.

The active/inactive mode is injected by the URL router via the "active" kwarg.

Retrieves active or inactive ConversationSession records for a given userId, with active sessions filtered to exclude those already linked to an open recommendation.

POST (active=True) — Returns open sessions (status=True) for the user. Incomplete RecommendationDetail rows targeting the same user are fetched and their associated session ids are removed from the result, so only sessions without a pending recommendation are returned. Returns 204 if none remain.

POST (active=False) — Returns closed sessions (status=False) for the user, ordered by id descending (most recent first). Returns 204 if none exist.

The active/inactive mode is injected by the URL router via the "active" kwarg.

Retrieves all ConversationSession records belonging to a specific user, ordered by most recently updated first.

GET /{userid}/ — Returns all non-deleted sessions for the given userid, sorted descending by update_timestamp. Returns an empty list if no sessions exist.

Retrieves all ConversationSession records belonging to a specific user, ordered by most recently updated first.

GET /{userid}/ — Returns all non-deleted sessions for the given userid, sorted descending by update_timestamp. Returns an empty list if no sessions exist.

Retrieves the history of closed (inactive) chat sessions for a given userId from the legacy Chatsession model. Filters by userid and status=False (closed sessions only). Send the userId as a URL path parameter for a single user's history, or call without a parameter to list all closed sessions.

Retrieves the history of closed (inactive) chat sessions for a given userId from the legacy Chatsession model. Filters by userid and status=False (closed sessions only). Send the userId as a URL path parameter for a single user's history, or call without a parameter to list all closed sessions.

Retrieves all Interaction records for a specific client-therapist chat session, ordered chronologically.

GET /{sessionid}/ — Returns all non-deleted interactions for the given sessionid, ordered by interactionid ascending (chronological order). Returns an empty list if no interactions exist.

POST, PUT, and DELETE are excluded from the public schema.

Retrieves all Interaction records for a specific client-therapist chat session, ordered chronologically.

GET /{sessionid}/ — Returns all non-deleted interactions for the given sessionid, ordered by interactionid ascending (chronological order). Returns an empty list if no interactions exist.

POST, PUT, and DELETE are excluded from the public schema.

Creates a new client-therapist chat session (legacy Chatsession model).

POST — Creates a new Chatsession record, stamps update_timestamp, starttimestamp, and session_timestamp to now, and returns the generated sessionid (HTTP 201). Authentication is currently disabled (permission_classes=[]).

DELETE /{sessionid}/ — Soft-deletes the session via the inherited destroy action.

GET and PUT actions are excluded from the public schema.

Creates a new client-therapist chat session (legacy Chatsession model).

POST — Creates a new Chatsession record, stamps update_timestamp, starttimestamp, and session_timestamp to now, and returns the generated sessionid (HTTP 201). Authentication is currently disabled (permission_classes=[]).

DELETE /{sessionid}/ — Soft-deletes the session via the inherited destroy action.

GET and PUT actions are excluded from the public schema.

Retrieves active client-therapist chat sessions for a specific TherapistClient relationship.

GET /{therapist_client_id}/ — Returns all non-deleted, active (status=True) Chatsession records associated with the given therapist_client_id. Returns HTTP 204 if no active sessions exist.

POST, PUT, and DELETE are excluded from the public schema.

Retrieves active client-therapist chat sessions for a specific TherapistClient relationship.

GET /{therapist_client_id}/ — Returns all non-deleted, active (status=True) Chatsession records associated with the given therapist_client_id. Returns HTTP 204 if no active sessions exist.

POST, PUT, and DELETE are excluded from the public schema.

Creates or updates an Interaction record for a client-therapist chat session, and triggers real-time push/web notifications.

POST — Upserts an interaction keyed on userloginname. If a matching record exists it is updated; otherwise a new one is created.

After persisting, if aianswer is present in the payload, a chat_notification_task_app Celery task is dispatched to send an FCM push notification to the client's registered device token.

If userquery is present instead, a process_web_notification Celery task is dispatched to alert the therapist of a new client message via web push.

Returns the interactionid (HTTP 201 for create, HTTP 200 for update).

PUT /{interactionid}/ — If userquery is in the payload, updates the interaction body fields using UpdateTherapistClientInteractionSerializer (userquery field is stripped before saving). Otherwise, updates the like/dislike feedback via UpdateUserInteractionLikeDislikeSerializer.

GET / GET /{interactionid}/ — Lists or retrieves interactions using InteractionGetSerializer.

DELETE is excluded from the public schema.

Creates or updates an Interaction record for a client-therapist chat session, and triggers real-time push/web notifications.

POST — Upserts an interaction keyed on userloginname. If a matching record exists it is updated; otherwise a new one is created.

After persisting, if aianswer is present in the payload, a chat_notification_task_app Celery task is dispatched to send an FCM push notification to the client's registered device token.

If userquery is present instead, a process_web_notification Celery task is dispatched to alert the therapist of a new client message via web push.

Returns the interactionid (HTTP 201 for create, HTTP 200 for update).

PUT /{interactionid}/ — If userquery is in the payload, updates the interaction body fields using UpdateTherapistClientInteractionSerializer (userquery field is stripped before saving). Otherwise, updates the like/dislike feedback via UpdateUserInteractionLikeDislikeSerializer.

GET / GET /{interactionid}/ — Lists or retrieves interactions using InteractionGetSerializer.

DELETE is excluded from the public schema.

Creates or updates an Interaction record for a client-therapist chat session, and triggers real-time push/web notifications.

POST — Upserts an interaction keyed on userloginname. If a matching record exists it is updated; otherwise a new one is created.

After persisting, if aianswer is present in the payload, a chat_notification_task_app Celery task is dispatched to send an FCM push notification to the client's registered device token.

If userquery is present instead, a process_web_notification Celery task is dispatched to alert the therapist of a new client message via web push.

Returns the interactionid (HTTP 201 for create, HTTP 200 for update).

PUT /{interactionid}/ — If userquery is in the payload, updates the interaction body fields using UpdateTherapistClientInteractionSerializer (userquery field is stripped before saving). Otherwise, updates the like/dislike feedback via UpdateUserInteractionLikeDislikeSerializer.

GET / GET /{interactionid}/ — Lists or retrieves interactions using InteractionGetSerializer.

DELETE is excluded from the public schema.

Creates or updates an Interaction record for a client-therapist chat session, and triggers real-time push/web notifications.

POST — Upserts an interaction keyed on userloginname. If a matching record exists it is updated; otherwise a new one is created.

After persisting, if aianswer is present in the payload, a chat_notification_task_app Celery task is dispatched to send an FCM push notification to the client's registered device token.

If userquery is present instead, a process_web_notification Celery task is dispatched to alert the therapist of a new client message via web push.

Returns the interactionid (HTTP 201 for create, HTTP 200 for update).

PUT /{interactionid}/ — If userquery is in the payload, updates the interaction body fields using UpdateTherapistClientInteractionSerializer (userquery field is stripped before saving). Otherwise, updates the like/dislike feedback via UpdateUserInteractionLikeDislikeSerializer.

GET / GET /{interactionid}/ — Lists or retrieves interactions using InteractionGetSerializer.

DELETE is excluded from the public schema.

Creates, updates, deletes, and retrieves legacy Interaction records, and handles like/dislike feedback on existing interactions.

POST — Creates a new Interaction record and returns the interactionid (HTTP 201).

GET / GET /{interactionid}/ — Returns all interactions or a single one via InteractionGetSerializer.

PUT /{interactionid}/ — Updates the like/dislike indicator on an existing interaction via UpdateUserInteractionLikeDislikeSerializer and refreshes update_timestamp.

DELETE /{interactionid}/ — Soft-deletes the interaction by setting is_deleted=True.

Creates, updates, deletes, and retrieves legacy Interaction records, and handles like/dislike feedback on existing interactions.

POST — Creates a new Interaction record and returns the interactionid (HTTP 201).

GET / GET /{interactionid}/ — Returns all interactions or a single one via InteractionGetSerializer.

PUT /{interactionid}/ — Updates the like/dislike indicator on an existing interaction via UpdateUserInteractionLikeDislikeSerializer and refreshes update_timestamp.

DELETE /{interactionid}/ — Soft-deletes the interaction by setting is_deleted=True.

Creates, updates, deletes, and retrieves legacy Interaction records, and handles like/dislike feedback on existing interactions.

POST — Creates a new Interaction record and returns the interactionid (HTTP 201).

GET / GET /{interactionid}/ — Returns all interactions or a single one via InteractionGetSerializer.

PUT /{interactionid}/ — Updates the like/dislike indicator on an existing interaction via UpdateUserInteractionLikeDislikeSerializer and refreshes update_timestamp.

DELETE /{interactionid}/ — Soft-deletes the interaction by setting is_deleted=True.

Creates, updates, deletes, and retrieves legacy Interaction records, and handles like/dislike feedback on existing interactions.

POST — Creates a new Interaction record and returns the interactionid (HTTP 201).

GET / GET /{interactionid}/ — Returns all interactions or a single one via InteractionGetSerializer.

PUT /{interactionid}/ — Updates the like/dislike indicator on an existing interaction via UpdateUserInteractionLikeDislikeSerializer and refreshes update_timestamp.

DELETE /{interactionid}/ — Soft-deletes the interaction by setting is_deleted=True.

Creates, updates, deletes, and retrieves legacy Interaction records, and handles like/dislike feedback on existing interactions.

POST — Creates a new Interaction record and returns the interactionid (HTTP 201).

GET / GET /{interactionid}/ — Returns all interactions or a single one via InteractionGetSerializer.

PUT /{interactionid}/ — Updates the like/dislike indicator on an existing interaction via UpdateUserInteractionLikeDislikeSerializer and refreshes update_timestamp.

DELETE /{interactionid}/ — Soft-deletes the interaction by setting is_deleted=True.

Creates or updates a ConversationMessage (an individual turn within a ConversationSession).

POST — If id is present in the request body, updates the existing message and returns the id (HTTP 200). If id is absent, creates a new message, stamps create_timestamp to now, and returns the new id (HTTP 201). Returns 404 if the specified id does not exist.

PUT /{id}/ — Updates the like/dislike feedback on an existing message using UpdateConversationMessageLikeDislikeSerializer, stamps update_timestamp to now, and returns the id (HTTP 200).

DELETE /{id}/ — Soft-deletes the message via the inherited destroy action.

Creates or updates a ConversationMessage (an individual turn within a ConversationSession).

POST — If id is present in the request body, updates the existing message and returns the id (HTTP 200). If id is absent, creates a new message, stamps create_timestamp to now, and returns the new id (HTTP 201). Returns 404 if the specified id does not exist.

PUT /{id}/ — Updates the like/dislike feedback on an existing message using UpdateConversationMessageLikeDislikeSerializer, stamps update_timestamp to now, and returns the id (HTTP 200).

DELETE /{id}/ — Soft-deletes the message via the inherited destroy action.

Creates or updates a ConversationMessage (an individual turn within a ConversationSession).

POST — If id is present in the request body, updates the existing message and returns the id (HTTP 200). If id is absent, creates a new message, stamps create_timestamp to now, and returns the new id (HTTP 201). Returns 404 if the specified id does not exist.

PUT /{id}/ — Updates the like/dislike feedback on an existing message using UpdateConversationMessageLikeDislikeSerializer, stamps update_timestamp to now, and returns the id (HTTP 200).

DELETE /{id}/ — Soft-deletes the message via the inherited destroy action.

Creates or updates a ConversationMessage (an individual turn within a ConversationSession).

POST — If id is present in the request body, updates the existing message and returns the id (HTTP 200). If id is absent, creates a new message, stamps create_timestamp to now, and returns the new id (HTTP 201). Returns 404 if the specified id does not exist.

PUT /{id}/ — Updates the like/dislike feedback on an existing message using UpdateConversationMessageLikeDislikeSerializer, stamps update_timestamp to now, and returns the id (HTTP 200).

DELETE /{id}/ — Soft-deletes the message via the inherited destroy action.

Creates or updates a ConversationMessage (an individual turn within a ConversationSession).

POST — If id is present in the request body, updates the existing message and returns the id (HTTP 200). If id is absent, creates a new message, stamps create_timestamp to now, and returns the new id (HTTP 201). Returns 404 if the specified id does not exist.

PUT /{id}/ — Updates the like/dislike feedback on an existing message using UpdateConversationMessageLikeDislikeSerializer, stamps update_timestamp to now, and returns the id (HTTP 200).

DELETE /{id}/ — Soft-deletes the message via the inherited destroy action.

Retrieves ConversationMessage records for a specific session using the AI-optimised serializer (ConversationMessageForAiGetSerializer), which returns a subset of fields suited for AI inference context.

GET /{sessionid}/ — Returns all non-deleted messages for the given sessionid ordered by id ascending. NaN values are normalised to null. Returns HTTP 204 if no messages exist.

Retrieves ConversationMessage records for a specific session using the AI-optimised serializer (ConversationMessageForAiGetSerializer), which returns a subset of fields suited for AI inference context.

GET /{sessionid}/ — Returns all non-deleted messages for the given sessionid ordered by id ascending. NaN values are normalised to null. Returns HTTP 204 if no messages exist.

Retrieves all ConversationMessage records for a specific session, sorted by message id ascending (chronological order).

GET /{sessionid}/ — Returns all non-deleted messages for the given sessionid ordered by id. NaN values are normalised to null. Returns HTTP 204 if no messages exist.

GET /{sessionid}/count/ — Returns the total count of non-deleted messages for the session as {"count": N}.

Retrieves all ConversationMessage records for a specific session, sorted by message id ascending (chronological order).

GET /{sessionid}/ — Returns all non-deleted messages for the given sessionid ordered by id. NaN values are normalised to null. Returns HTTP 204 if no messages exist.

GET /{sessionid}/count/ — Returns the total count of non-deleted messages for the session as {"count": N}.

Retrieves all ConversationMessage records for a specific session, sorted by message id ascending (chronological order).

GET /{sessionid}/ — Returns all non-deleted messages for the given sessionid ordered by id. NaN values are normalised to null. Returns HTTP 204 if no messages exist.

GET /{sessionid}/count/ — Returns the total count of non-deleted messages for the session as {"count": N}.

Retrieves all ConversationMessage records authored by a specific user, sorted by message id ascending (chronological order).

GET /{userid}/ — Returns all non-deleted messages for the given userid ordered by id. Returns HTTP 204 if no messages exist.

Retrieves all ConversationMessage records authored by a specific user, sorted by message id ascending (chronological order).

GET /{userid}/ — Returns all non-deleted messages for the given userid ordered by id. Returns HTTP 204 if no messages exist.

Retrieves all interactions belonging to a specific chat session. Filters Interaction records directly by "sessionid". Send the sessionId as a URL path parameter.

Retrieves all interactions belonging to a specific chat session. Filters Interaction records directly by "sessionid". Send the sessionId as a URL path parameter.

Retrieves all interactions for a user identified by their userId. Traverses one FK level via "sessionid__userid" to filter Interaction → Chatsession. Send the userId as a URL path parameter.

Retrieves all interactions for a user identified by their userId. Traverses one FK level via "sessionid__userid" to filter Interaction → Chatsession. Send the userId as a URL path parameter.

Retrieves all interactions for a user identified by their userLoginName. Traverses two FK levels via "sessionid__userid__userloginname" to filter Interaction → Chatsession → Users. Send the userLoginName as a URL path parameter.

Retrieves all interactions for a user identified by their userLoginName. Traverses two FK levels via "sessionid__userid__userloginname" to filter Interaction → Chatsession → Users. Send the userLoginName as a URL path parameter.

Retrieves all interactions (messages) for a given support chat session, ordered by id (chronological). Filters TherapistSupportInteraction records by therapist_support_session_id. Send the session id as a URL path parameter.

Retrieves all interactions (messages) for a given support chat session, ordered by id (chronological). Filters TherapistSupportInteraction records by therapist_support_session_id. Send the session id as a URL path parameter.

Opens a new support chat session for a therapist. Accepts a POST request with the therapist user details via SupportChatSessionCreateSerializer and creates a TherapistSupportSession record. Returns the new session id on success (HTTP 201).

Retrieves all active support chat sessions across all therapists, ordered by most recently created. Filters TherapistSupportSession records where status=True (open sessions). Intended for support staff to view the full queue of open sessions. Returns 204 if no active sessions exist.

Retrieves all active support chat sessions across all therapists, ordered by most recently created. Filters TherapistSupportSession records where status=True (open sessions). Intended for support staff to view the full queue of open sessions. Returns 204 if no active sessions exist.

Retrieves all active support chat sessions for a given therapist. Filters TherapistSupportSession records by therapist_user_id and status=True (open sessions only). Send the therapist userId as a URL path parameter. Returns 204 if no active sessions are found.

Retrieves all active support chat sessions for a given therapist. Filters TherapistSupportSession records by therapist_user_id and status=True (open sessions only). Send the therapist userId as a URL path parameter. Returns 204 if no active sessions are found.

Creates or updates a support chat interaction (message) within a support session, and handles like/dislike feedback on existing interactions.

POST — Creates a new TherapistSupportInteraction. After saving, fires a Celery "process_web_notification" task:

• If "support_answer" is set: sends a "support-chat" notification to the therapist informing them of a new reply from the support team.
• If "user_query" is set: sends a "therapist-support-chat" notification to the support user informing them of a new message from the therapist.

PUT /{id}/ — Updates an existing interaction. If "likedislikeindicator" is present in the body, only the like/dislike field is updated via SupportChatInteractionUpdateSerializer. Otherwise a full partial update is performed and the same real-time notifications are dispatched as on create.

Generates structured therapy goals from a treatment plan using AI. Supports two modes: 'llm' (default) uses a language model for direct generation, 'agent' uses an AI agent workflow for more detailed goal creation.

Used when:

• Therapist wants to auto-generate goals from a treatment plan
• Creating structured, trackable goals from clinical documentation

Input:

• treatment_plan (required): Treatment plan content as JSON
• mode (optional): 'llm' (default) or 'agent'

Returns: Generated goals structured for the Kana goal tracking system

Common errors:

• 500: AI service error during goal generation

Streaming version of the ask_DSM chat endpoint that provides real-time status updates

Get MBC (Measurement-Based Care) tool recommendations. This endpoint can be called by other services (like AsyncMessage) for tool selection.

Args: request: Contains client_data with clinical information

Returns: MBC tool recommendations with domains, tools, safety flags, and summary

Get clinical documentation instructions. This endpoint provides instruction sets for various clinical documentation tasks.

Args: instruction_type: Type of instruction (clinical_notes, safety_plan, etc.) user_id: Optional user ID for personalized instructions

Returns: Instructions for the specified documentation task

Execute a clinical documentation task. This endpoint fetches instructions and provides them with clinical data for LLM processing.

Args: request: Contains task_type, clinical_data, user_id, and additional_params

Returns: Task execution result with instructions