parts.page.mention.search

Documentation

Search a mention service for matching results. A single XRPC host can serve multiple mention services, distinguished by the service AT URI.

main query

Search a mention service for matching results. A single XRPC host can serve multiple mention services, distinguished by the service AT URI.

Parameters

limit integer Optional

Maximum number of results to return

search string Required

Search query string

service string at-uri Required

AT URI of the parts.page.mention.service record identifying which service to query

Output

Encodingapplication/json

results array Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

limit Maximum number of results to return

search * Search query string

service * AT URI of the parts.page.mention.service record identifying which service to query

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "results"
      ],
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "ref": "#result",
            "type": "ref"
          },
          "maxLength": 50
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "service",
      "search"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 50,
        "minimum": 1,
        "description": "Maximum number of results to return"
      },
      "search": {
        "type": "string",
        "description": "Search query string"
      },
      "service": {
        "type": "string",
        "format": "at-uri",
        "description": "AT URI of the parts.page.mention.service record identifying which service to query"
      }
    }
  },
  "description": "Search a mention service for matching results. A single XRPC host can serve multiple mention services, distinguished by the service AT URI."
}

embedInfo object

No description available.

Properties

height integer Optional

Default height of the embed in pixels

minimum: 16maximum: 3200

src string uri Required

Source URL for the iframe embed

width integer Optional

Default width of the embed in pixels

minimum: 16maximum: 3200

View raw schema

{
  "type": "object",
  "required": [
    "src"
  ],
  "properties": {
    "src": {
      "type": "string",
      "format": "uri",
      "description": "Source URL for the iframe embed"
    },
    "width": {
      "type": "integer",
      "maximum": 3200,
      "minimum": 16,
      "description": "Default width of the embed in pixels"
    },
    "height": {
      "type": "integer",
      "maximum": 3200,
      "minimum": 16,
      "description": "Default height of the embed in pixels"
    }
  }
}

result object

No description available.

Properties

embed ref #embedInfo Optional

Optional embed info for creating an embed block instead of an inline mention

href string uri Optional

Optional web URL for the mentioned entity

icon string uri Optional

Optional icon URL for the mentioned entity, displayed next to the mention

name string Required

Display name for the mentioned entity

uri string Required

Identifier for the mentioned entity

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "name"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "description": "Identifier for the mentioned entity"
    },
    "href": {
      "type": "string",
      "format": "uri",
      "description": "Optional web URL for the mentioned entity"
    },
    "icon": {
      "type": "string",
      "format": "uri",
      "description": "Optional icon URL for the mentioned entity, displayed next to the mention"
    },
    "name": {
      "type": "string",
      "description": "Display name for the mentioned entity"
    },
    "embed": {
      "ref": "#embedInfo",
      "type": "ref",
      "description": "Optional embed info for creating an embed block instead of an inline mention"
    }
  }
}