parts.page.mention.search

page.parts

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

scope string Optional

Optional scope identifier to narrow results within a service, as returned by a previous result's subscope.scope field

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.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Maximum number of results to return
Optional scope identifier to narrow results within a service, as returned by a previous result's subscope.scope field
Search query string
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"
      },
      "scope": {
        "type": "string",
        "description": "Optional scope identifier to narrow results within a service, as returned by a previous result's subscope.scope field"
      },
      "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."
}
aspectRatio object

No description available.

Properties

height integer Required

No description available.

width integer Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "width",
    "height"
  ],
  "properties": {
    "width": {
      "type": "integer"
    },
    "height": {
      "type": "integer"
    }
  }
}
embedInfo object

No description available.

Properties

aspectRatio ref #aspectRatio Optional

Aspect ratio of the embed. If provided, takes precedence over width/height for sizing.

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"
    },
    "aspectRatio": {
      "ref": "#aspectRatio",
      "type": "ref",
      "description": "Aspect ratio of the embed. If provided, takes precedence over width/height for sizing."
    }
  }
}
mentionLabel object

No description available.

Properties

text string Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "text": {
      "type": "string"
    }
  }
}
result object

No description available.

Properties

description string Optional

A description for the mentioned entity

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

labels array of ref#mentionLabel Optional

A set of labels to be rendered with the mentionedEntity

name string Required

Display name for the mentioned entity

subscope ref #subscopeInfo Optional

Optional subscope info indicating this result can be scoped into for further searching

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"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "#mentionLabel",
        "type": "ref"
      },
      "description": "A set of labels to be rendered with the mentionedEntity"
    },
    "subscope": {
      "ref": "#subscopeInfo",
      "type": "ref",
      "description": "Optional subscope info indicating this result can be scoped into for further searching"
    },
    "description": {
      "type": "string",
      "description": "A description for the mentioned entity"
    }
  }
}
subscopeInfo object

No description available.

Properties

label string Required

Display label for the scope-down button (e.g. 'Posts', 'Tracks')

maxLength: 100 bytes
scope string Required

Scope identifier passed back to the service in subsequent search queries

View raw schema 
{
  "type": "object",
  "required": [
    "scope",
    "label"
  ],
  "properties": {
    "label": {
      "type": "string",
      "maxLength": 100,
      "description": "Display label for the scope-down button (e.g. 'Posts', 'Tracks')"
    },
    "scope": {
      "type": "string",
      "description": "Scope identifier passed back to the service in subsequent search queries"
    }
  }
}

Lexicon Garden

@