> For the complete documentation index, see [llms.txt](https://docs.fylr.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fylr.io/for-developers/api/endpoints/api-suggest.md).

# /api/v1/suggest

Auto-suggest / autocomplete. Given the user's current input, returns candidate completions either as token frequencies (`tokens`) or as per-field value matches (`fields`), plus optionally the full linked-object descriptors for picker UIs (`linked_objects`). Backed by the search index — the same language settings apply.

Read-only: the request runs in a read transaction; nothing is written. Requires an authenticated user. Suggestions are limited to what that user may see: `fields` and `linked_objects` come only from records the user may read, `tokens` only from the mask and pool combinations of the user's best-mask filter.

### `GET /suggest` — Auto-suggest with the request encoded in the URL.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/suggest" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-c66962d021f9281075604517b7590deaf0d3f984%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `POST /suggest` — Auto-suggest with the request as a JSON body.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/suggest" method="post" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-c66962d021f9281075604517b7590deaf0d3f984%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}