Skip to content
UltimateTeam.ai Docs

Search Messages

GET
/api/v1/team-chat/search
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/team-chat/search?q=example&limit=20' \
  --header 'X-API-Key: <X-API-Key>'

Search chat messages and thread titles by keyword.

Uses PostgreSQL full-text search with ranking and snippets.

Args: q: Search query string. limit: Maximum results to return. user: The authenticated user context. session: Async database session.

Returns: ChatSearchResponse with ranked results.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
q
required
Q

Search query

string
>= 1 characters <= 200 characters

Search query

limit
Limit

Max results

integer
default: 20 >= 1 <= 50

Max results

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
ChatSearchResponse

Full-text search results across chat messages and threads.

Attributes: results: Ranked search results. total: Total number of results. query: The original search query.

object
query
required
Query
string
results
required
Results
Array<object>
ChatSearchResult

A single search result from full-text message search.

Attributes: message_id: The matching message UUID. thread_id: The thread containing the message. thread_title: Human-readable thread title. sender_role: Who sent the message. content: Full message content. snippet: Highlighted snippet with tags. rank: Relevance score from ts_rank_cd. created_at: When the message was created.

object
content
required
Content
string
created_at
required
Created At
string format: date-time
message_id
required
Message Id
string format: uuid
rank
required
Rank
number
sender_role
required
Sender Role
string
snippet
required
Snippet
string
thread_id
required
Thread Id
string format: uuid
thread_title
required
Any of:
string
total
required
Total
integer
Examplegenerated
{
  "query": "example",
  "results": [
    {
      "content": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "message_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rank": 1,
      "sender_role": "example",
      "snippet": "example",
      "thread_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "thread_title": "example"
    }
  ],
  "total": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}