Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.konbiniapi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What it does

Returns the public Highlights tab selection as visible to not logged in users. This feed is not guaranteed to be chronological.

​
Tool details

FieldValue
Tool namex_get_user_highlights
PlatformX
REST endpointGET /v1/x/users/{username}/highlights
Result typeCollection tool

​
Parameters

ParameterTypeRequiredDescription
usernamestringYesX username (with or without @ symbol)
countintegerNoMaximum number of highlighted posts to return from the public profile selection (maximum: 100) Default: 40.
projection_presetstringNoDefaults to minimal. Allowed values: full, minimal, identity, engagement, content.
data_fieldsstring[]NoAdds top-level keys from data on top of the selected projection_preset.
item_fieldsstring[]NoAdds keys from data.orderedItems[] on top of the selected projection_preset.

​
Example

{
  "name": "x_get_user_highlights",
  "arguments": {
    "username": "khaby.lame",
    "count": 40,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}

​
Available data fields

  • @context
  • type
  • partOf
  • totalItems
  • cursor
  • nextCursor
  • next
  • itemCount
  • orderedItems

​
Available item fields

  • type
  • id
  • url
  • entityId
  • content
  • published
  • likeCount
  • replyCount
  • viewCount
  • repostCount
  • quoteCount
  • saveCount
  • contentFormat
  • isEdited
  • attributedTo
  • inReplyTo
  • quote
  • image
  • attachment
  • tag

​
Response notes

Successful calls return a JSON object with a top-level data field and, when available, metadata.creditsUsed and metadata.creditsRemaining. See response format, pagination, and credits.