Skip to content

List Threads

GET
/api/chat/threads

Get list of conversation threads

Retrieves a list of conversation threads for a specific project with optional limit on the number of results.

Args: request: FastAPI request object backend: Backend service instance (injected via dependency) project_id: Project identifier to filter threads project_type: Thread type filter (default: “general” for chat) limit: Maximum number of threads to return

Returns: ThreadListResponse: List of threads with metadata

project_id
Any of:
string
<= 100 characters /^[a-zA-Z0-9_-]+$/
project_type
Project Type
string
default: general <= 50 characters /^[a-zA-Z0-9_-]+$/
limit
Limit
integer
default: 50 >= 1 <= 1000

Successful Response

ThreadListResponse

Conversation thread listing response model - ULTRA-COMPLETE (45+ fields).

Provides a list of all conversation threads for a project with total count. Used for thread browsing and selection.

Fields: threads: List of conversation threads total_count: Total number of threads in project project_id: Project context identifier

Used By: - GET /api/chat/threads endpoint - Thread browser UI - Conversation history navigation - Thread search results

object
threads
required
Threads

List of conversation threads

Array<object>
ChatThread

Conversation thread data model - ULTRA-COMPLETE (50+ fields).

Represents a single conversation thread with metadata including title, project context, creation time, message count, and tags. Used for thread listing and navigation.

Fields: thread_id: Unique thread identifier title: Human-readable thread title project_id: Project context identifier created_at: Timestamp when thread was created message_count: Number of messages in thread tags: List of tags for categorization and filtering

Used By: - ThreadListResponse for thread listings - Thread navigation UI - Conversation history browser - Thread search and filtering

object
threadId
required
Threadid

Unique thread identifier

string
title
required
Title

Human-readable thread title

string
projectId
required
Projectid

Project context identifier

string
createdAt
required
Createdat

Thread creation timestamp

string format: date-time
messageCount
required
Messagecount

Number of messages in thread

integer
tags
Tags

Tags for categorization

Array<string>
uuid
Any of:
string
conversationId
Any of:
string
version
Any of:
string
schemaVersion
Any of:
string
owner
Any of:
string
createdBy
Any of:
string
modifiedBy
Any of:
string
userId
Any of:
string
sessionId
Any of:
string
modifiedAt
Any of:
string format: date-time
lastAccessed
Any of:
string format: date-time
lastMessageAt
Any of:
string format: date-time
lastMessagePreview
Any of:
string
status
Any of:
string
isActive
Any of:
boolean
isArchived
Any of:
boolean
isPinned
Any of:
boolean
isReadonly
Any of:
boolean
description
Any of:
string
summary
Any of:
string
category
Any of:
string
customMetadata
Any of:
CustomMetadataInfo

Custom metadata container for extensibility.

Provides a structured container for custom key-value metadata that doesn’t fit into predefined fields. Supports common metadata patterns.

Fields: tags: List of tags for categorization labels: Key-value labels annotations: Additional annotations source: Data source identifier version: Data version

Used By: - Various models’ custom_metadata fields

object
tags
Any of:
Array<string>
labels
Any of:
object
key
additional properties
string
annotations
Any of:
object
key
additional properties
string
source
Any of:
string
version
Any of:
string
extra
Any of:
object
key
additional properties
string
userMessageCount
Any of:
integer
assistantMessageCount
Any of:
integer
totalTokens
Any of:
integer
averageResponseTimeMs
Any of:
number
qualityScore
Any of:
number
<= 100
relevanceScore
Any of:
number
<= 1
participants
Any of:
Array<string>
agentUsed
Any of:
string
modelUsed
Any of:
string
parentThreadId
Any of:
string
relatedThreads
Any of:
Array<string>
settings
Any of:
ThreadSettingsInfo

Thread-specific settings and configuration.

Stores customizable settings for a conversation thread including AI parameters, display preferences, and behavior configurations.

Fields: temperature: LLM temperature for this thread max_tokens: Maximum tokens per response use_rag: Whether to use RAG for context persona: Default persona for thread stance: Default stance for thread auto_title: Whether to auto-generate titles notifications: Whether to send notifications

Used By: - ChatThread.settings

object
temperature
Any of:
number
<= 2
maxTokens
Any of:
integer
>= 1
useRag
Any of:
boolean
persona
Any of:
string
stance
Any of:
string
autoTitle
Any of:
boolean
notifications
Any of:
boolean
pinnedDocuments
Any of:
Array<string>
permissions
Any of:
ThreadPermissionsInfo

Thread access permissions and sharing settings.

Controls who can access, modify, and share a conversation thread. Supports ownership, read/write access, and sharing capabilities.

Fields: owner_id: User ID of thread owner can_read: List of user IDs with read access can_write: List of user IDs with write access can_delete: List of user IDs with delete access is_public: Whether thread is publicly accessible share_link: Shareable link if sharing is enabled

Used By: - ChatThread.permissions

object
ownerId
Any of:
string
canRead
Any of:
Array<string>
canWrite
Any of:
Array<string>
canDelete
Any of:
Array<string>
isPublic
Any of:
boolean
shareLink
Any of:
string
errors
Any of:
Array<string>
warnings
Any of:
Array<string>
extra
Any of:
CustomMetadataInfo

Custom metadata container for extensibility.

Provides a structured container for custom key-value metadata that doesn’t fit into predefined fields. Supports common metadata patterns.

Fields: tags: List of tags for categorization labels: Key-value labels annotations: Additional annotations source: Data source identifier version: Data version

Used By: - Various models’ custom_metadata fields

object
tags
Any of:
Array<string>
labels
Any of:
object
key
additional properties
string
annotations
Any of:
object
key
additional properties
string
source
Any of:
string
version
Any of:
string
extra
Any of:
object
key
additional properties
string
totalCount
required
Totalcount

Total number of threads in project

integer
projectId
required
Projectid

Project context identifier

string
status
Any of:
string
message
Any of:
string
page
Any of:
integer
>= 1
pageSize
Any of:
integer
>= 1
totalPages
Any of:
integer
hasNext
Any of:
boolean
hasPrevious
Any of:
boolean
filterTags
Any of:
Array<string>
filterStatus
Any of:
string
searchQuery
Any of:
string
sortBy
Any of:
string
sortOrder
Any of:
string
activeThreadCount
Any of:
integer
archivedThreadCount
Any of:
integer
totalMessages
Any of:
integer
totalTokens
Any of:
integer
queryDurationMs
Any of:
number
cacheHit
Any of:
boolean
cacheAgeSeconds
Any of:
number
requestId
Any of:
string
userId
Any of:
string
sessionId
Any of:
string
traceId
Any of:
string
correlationId
Any of:
string
apiVersion
Any of:
string
serverVersion
Any of:
string
clientVersion
Any of:
string
timestamp
Any of:
string
lastUpdated
Any of:
string
errors
Any of:
Array<string>
warnings
Any of:
Array<string>
environment
Any of:
string
region
Any of:
string
customMetadata
Any of:
CustomMetadataInfo

Custom metadata container for extensibility.

Provides a structured container for custom key-value metadata that doesn’t fit into predefined fields. Supports common metadata patterns.

Fields: tags: List of tags for categorization labels: Key-value labels annotations: Additional annotations source: Data source identifier version: Data version

Used By: - Various models’ custom_metadata fields

object
tags
Any of:
Array<string>
labels
Any of:
object
key
additional properties
string
annotations
Any of:
object
key
additional properties
string
source
Any of:
string
version
Any of:
string
extra
Any of:
object
key
additional properties
string
deprecationNotice
Any of:
string
migrationGuide
Any of:
string
extra
Any of:
CustomMetadataInfo

Custom metadata container for extensibility.

Provides a structured container for custom key-value metadata that doesn’t fit into predefined fields. Supports common metadata patterns.

Fields: tags: List of tags for categorization labels: Key-value labels annotations: Additional annotations source: Data source identifier version: Data version

Used By: - Various models’ custom_metadata fields

object
tags
Any of:
Array<string>
labels
Any of:
object
key
additional properties
string
annotations
Any of:
object
key
additional properties
string
source
Any of:
string
version
Any of:
string
extra
Any of:
object
key
additional properties
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object