Chat Sessions

A ChatSession represents one conversation with the Files.com AI Assistant.

List Chat Sessions

SDK Function

ChatSession.list()

Return Object

ListIterator<ChatSession>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.ChatSession;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<ChatSession> chatSessions = ChatSession.list(parameters);
  for (ChatSession chatSession : chatSessions.listAutoPaging()) {
    // Operate on chatSession
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Show Chat Session

SDK Function

ChatSession.find()

Return Object

ChatSession

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Function Arguments

ArgumentDescription
id
string
Required		Chat Session ID.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.ChatSession;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ChatSession chatSession = ChatSession.find(id, parameters);
  // Operate on chatSession
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The ChatSession Object

Some of the functions above return a ChatSession object. The attributes of this object are listed below.

AttributeDescription
id
string		Chat Session ID.
title
string		Short AI-generated chat title.
user_id
int64		User ID.
ai_task_id
int64		AI Task ID. Present when the conversation was started by an AI Task.
workspace_id
int64		Workspace ID. 0 means the default workspace.
last_active_at
date-time		Most recent chat activity date/time.
created_at
date-time		Chat session creation date/time.
messages
array(object)		Visible conversation messages in this chat session. For performance reasons, this is not provided when listing chat sessions.