Skip to content
UltimateTeam.ai Docs

Get contextual help for a page

GET
/api/v1/help/content
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/help/content?page_key=example&locale=en' \
  --header 'X-API-Key: <X-API-Key>'

UX-02: Return vertical-aware help content with 3-step fallback (vertical -> generic -> placeholder).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
page_key
required
Page Key

Dashboard page identifier

string

Dashboard page identifier

locale
Locale

Content locale

string
default: en
Allowed values: en es de fr pt ja

Content locale

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
HelpContentResponse

Response schema for a single help content entry.

Returned by GET /api/v1/help/content.

object
id
Any of:
string format: uuid
last_generated_at
Any of:
string format: date-time
locale
Locale

Content locale (BCP-47).

string
default: en
markdown
required
Markdown

Help content body in Markdown.

string
page_key
required
Page Key

Dashboard page identifier (e.g. ‘dashboard.hq’).

string
version
Any of:
string
vertical_slug
required
Vertical Slug

Vertical slug or ‘_generic’.

string
Example
{
  "locale": "en"
}

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