---
title: "Entity-name typeahead"
method: GET
path: "/v1/entities/autocomplete"
tags: ["Entities"]
---

# Entity-name typeahead

`GET /v1/entities/autocomplete`

## Request

- Base URL: `https://brain.inite.ai`
- URL: `https://brain.inite.ai/v1/entities/autocomplete`
- Auth: HTTP bearer

Word-start match over the edge-ngram `prefix` fulltext index, BM25-ranked via `search::score`. A query under 2 characters returns nothing (the tokenizer produces no grams). Live, tenant-global entities only — merged-away redirects and personal-scoped entities are excluded. Source: src/entities/entities.controller.ts.

Required scope: `brain:read`.

## Query parameters

- `q` string
- `limit` integer

## Response `200`

Ranked suggestions.

- EntityAutocompleteResponse
  - `suggestions` EntityAutocompleteSuggestion[], required
    - `canonicalName` string, required
    - `entityId` string, required
    - `score` number, required
    - `type` string, required

## Other responses

- `401`: Missing or unknown bearer key.
- `403`: The key lacks the required scope.

---

[API](https://skmtc.dev/inite/apis/inite-brain-platform-api.md) · [All operations](https://skmtc.dev/inite/apis/inite-brain-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/inite/apis/inite-brain-platform-api/revisions/c7c3eb5e304b?raw)