Skip to content

Input Tips

  • Endpoint Path: /api/v2/common/input-tips
  • Method: GET
  • Request: Query

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Query Params

Parameter NameTypeRequiredDescription
typeStringrequiredChoose one from user, group, hashtag, post, extend
keyStringrequiredKeyword

Return

json
{
    "code": 0,
    "message": "ok",
    "data": [
        {
            "fsid": "String / Abbreviated id or slug",
            "name": "String / Name (or nickname)",
            "image": "String / Image URL",
            "followStatus": "Boolean / type=user specific, follow status",
        }
    ]
}

Released under the Apache-2.0 License