Lexicon Garden

garden.lexicon.suggest

Typeahead suggestions for indexed lexicons. Unlike garden.lexicon.browse, the query is matched against every segment-aligned suffix of an NSID, so 'feed.post' matches 'app.bsky.feed.post'. Results are sorted by NSID ascending and are not paginated.

Repository @lexicon.garden did:plc:akhgi4ekkeaupiqsis6g2gqg namespace authority
Details · query
Kindquery
Authoritylexicon.garden
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

lexiconType

array

Filter suggestions to these definition types. Repeat the parameter for multiple types. Omit to include all types.

  • maxLength: 5
itemsstring
  • maxLength: 32
  • knownValues: record | query | procedure | subscription | permission-set

limit

integer

Maximum number of suggestions to return.

  • minimum: 1
  • maximum: 20
  • default: 10

q

requiredstring

Search prefix, matched against an NSID or any of its segment-aligned suffixes.

  • minLength: 2
  • maxLength: 253

Output

application/json

suggestions

requiredarray
itemsref
Reference

#lexiconSuggestion

object

An indexed lexicon whose NSID matched the query.

Properties

did

requiredstring · did

DID of the authority that published the lexicon.

lexiconType

string

Definition type of the lexicon's main def. Absent when the indexed type is unknown.

  • maxLength: 32
  • knownValues: record | query | procedure | subscription | permission-set

nsid

requiredstring · nsid

The full NSID of the lexicon.

uri

requiredstring · at-uri

AT-URI of the com.atproto.lexicon.schema record backing this suggestion.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • garden.lexicon.browse

    query

    Browse indexed lexicons whose NSID begins with a segment-aligned prefix. Segment-aligned means 'community.lexicon' matches 'community.lexicon.foo' but not 'community.lexiconfoo'. Results are sorted by NSID ascending.