# app.bivri.search.suggestTags

> Published by [lexicons.bivri.app](https://lexicon.garden/identity/did:plc:uqat5a7hrbww3snbbinxgwah)

✓ This is the authoritative definition for this NSID.

## Description

Get tag autocomplete suggestions for a prefix.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.search.suggestTags)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.search.suggestTags/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.search.suggestTags/examples)

## Definitions

### `app.bivri.search.suggestTags`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of suggestions to return. |
| `prefix` | `string` | Yes | Prefix the suggested tags must start with. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tags` | `array` | Yes |  |

## Raw Schema

```json
{
  "id": "app.bivri.search.suggestTags",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "tags"
          ],
          "properties": {
            "tags": {
              "type": "array",
              "items": {
                "ref": "app.bivri.search.searchArtworks#tagSuggestion",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "prefix"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "default": 10,
            "maximum": 30,
            "minimum": 1,
            "description": "Maximum number of suggestions to return."
          },
          "prefix": {
            "type": "string",
            "minLength": 1,
            "description": "Prefix the suggested tags must start with."
          }
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Get tag autocomplete suggestions for a prefix."
}
```