Get Chat Thread

GET /api/v1/chat/{workspaceId}/history/{threadId}

Retrieve a specific chat thread.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace
threadId	path	string (uuid)	Yes	The ID of the chat thread

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Update Chat Thread Title

POST /api/v1/chat/{workspaceId}/history/{threadId}

Update the title of a chat thread.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace
threadId	path	string (uuid)	Yes	The ID of the chat thread

Request Body

Type	Description
ChatThread_Full	The updated chat thread details

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Remove History

DELETE /api/v1/chat/{workspaceId}/history/{threadId}

Delete a specific chat thread.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace
threadId	path	string (uuid)	Yes	The ID of the chat thread

Responses

Status Code	Description
200	OK
500	Internal Server Error

Add Chat

POST /api/v1/chat/{workspaceId}/completions

Add a new chat message.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace

Request Body

Type	Description
ChatCompletionRequestSF	The chat completion request details

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Add Chat Stream

POST /api/v1/chat/{workspaceId}/completions/stream

Add a new chat message and receive a streamed response.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace

Request Body

Type	Description
ChatCompletionRequestSF	The chat completion request details

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Add File

POST /api/v1/chat/{plusId}/add-file

Add a file to the chat.

Parameters

Name	In	Type	Required	Description
plusId	path	string (uuid)	Yes	The ID of the SectorFlow Plus
collection	query	string	No	The collection name
threadId	query	string (uuid)	No	The ID of the chat thread
models	query	array of string (uuid)	No	The model IDs
summarize	query	boolean	No	Whether to summarize the file
files	query	array of string (binary)	Yes	The file(s) to add

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Get Sample Prompts

GET /api/v1/chat/{workspaceId}/sample-prompts

Retrieve sample prompts for a workspace.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace
limit	query	integer	No	The maximum number of prompts to retrieve (default: 6)

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Get Chat History

GET /api/v1/chat/{workspaceId}/history

Retrieve the chat history for a workspace.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Remove All History

DELETE /api/v1/chat/{workspaceId}/history

Delete all chat history for a workspace.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace

Responses

Status Code	Description
200	OK
500	Internal Server Error

Get Greeting

GET /api/v1/chat/{workspaceId}/greeting

Retrieve the greeting for a workspace.

Parameters

Name	In	Type	Required	Description
workspaceId	path	string (uuid)	Yes	The ID of the workspace

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Get Prompt Logs

GET /api/v1/chat/prompt-logs

Retrieve prompt logs within a date range.

Parameters

Name	In	Type	Required	Description
q	query	string	No	Search query
startDate	query	string (date-time)	Yes	Start date for the log search
endDate	query	string (date-time)	Yes	End date for the log search

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Get Paged Prompt Logs

GET /api/v1/chat/prompt-logs/paged

Retrieve paged prompt logs.

Parameters

Name	In	Type	Required	Description
q	query	string	No	Search query
startDate	query	string (date-time)	No	Start date for the log search
endDate	query	string (date-time)	No	End date for the log search
pageable	query	Pageable	Yes	Pagination information

Responses

Status Code	Description	Content Type
200	OK	application/json
500	Internal Server Error	application/json

Get Logs Between Dates CSV

GET /api/v1/chat/prompt-logs/csv

Retrieve prompt logs as CSV within a date range.

Parameters

Name	In	Type	Required	Description
q	query	string	No	Search query
startDate	query	string (date-time)	Yes	Start date for the log search
endDate	query	string (date-time)	Yes	End date for the log search

Responses

Status Code	Description	Content Type
200	OK	text/csv
500	Internal Server Error	application/json