Skip to content
UltimateTeam.ai Docs

Search help content

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

UX-02: Full-text search across help content using PostgreSQL tsvector with ranked results.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
q
required
Q

Search query

string

Search query

limit
Limit

Max results

integer
default: 10 <= 25

Max results

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
HelpSearchResponse

Response schema for help content search.

object
results
Results
Array<object>
HelpSearchResult

A single ranked search result from full-text search.

object
id
required
Id

Content row ID.

string format: uuid
markdown
required
Markdown

Full Markdown body.

string
page_key
required
Page Key

Dashboard page identifier.

string
rank
required
Rank

Ts_rank_cd relevance score.

number
snippet
required
Snippet

Highlighted excerpt with tags.

string
vertical_slug
required
Vertical Slug

Vertical slug or ‘_generic’.

string
total
Total

Number of matching results.

integer
0
Example
{
  "total": 0
}

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"
    }
  ]
}