---
title: "The API returns a list of recognized entities in a given document."
method: POST
path: "/entities"
tags: ["Entities"]
---

# The API returns a list of recognized entities in a given document.

`POST /entities`

The API returns a list of recognized entities in a given document. To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.The API returns a list of known entities and general named entities ("Person", "Location", "Organization" etc) in a given document. Known entities are returned with Wikipedia Id and Wikipedia link, and also Bing Id which can be used in Bing Entity Search API. General named entities are returned with entity types. If a general named entity is also a known entity, then all information regarding it (Wikipedia Id, Bing Id, entity type etc) will be returned. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking#supported-types-for-named-entity-recognition">Supported Entity Types in Text Analytics API</a> for the list of supported Entity Types. See the <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported languages in Text Analytics API</a> for the list of enabled languages.

## Request body

- MultiLanguageBatchInput
  - `documents` MultiLanguageInput[]
    - `language` string — This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,
    - `id` string — Unique, non-empty document identifier.
    - `text` string

## Response `200`

A successful call results in a list of recognized entities returned for each valid document

- EntitiesBatchResultV2dot1
  - `documents` EntitiesBatchResultItemV2dot1[]
    - `id` string — Unique document identifier.
    - `entities` EntityRecordV2dot1[] — Recognized entities in the document.
      - `name` string — Entity formal name.
      - `matches` MatchRecordV2dot1[] — List of instances this entity appears in the text.
        - `text` string — Entity text as appears in the request.
        - `offset` integer — Start position (in Unicode characters) for the entity match text.
        - `length` integer — Length (in Unicode characters) for the entity match text.
      - `wikipediaLanguage` string — Wikipedia language for which the WikipediaId and WikipediaUrl refers to.
      - `wikipediaId` string — Wikipedia unique identifier of the recognized entity.
      - `wikipediaUrl` string — URL for the entity's English Wikipedia page.
      - `bingId` string — Bing unique identifier of the recognized entity. Use in conjunction with the Bing Entity Search API to fetch additional relevant information.
      - `type` string — Entity type from Named Entity Recognition model
      - `subType` string — Entity sub type from Named Entity Recognition model
  - `errors` ErrorRecord[]
    - `id` string — Input document unique identifier the error refers to.
    - `message` string — Error message.

## Other responses

- `default` — Error Response

---

[API](https://skmtc.dev/azure/apis/text-analytics-client.md) · [All operations](https://skmtc.dev/azure/apis/text-analytics-client/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/text-analytics-client/revisions/d82ca1bb88d0/schema)