---
title: "Call entity extraction on a document or collection of documents"
method: GET
path: "/api/nlp/entities/{id}"
tags: ["nlp"]
---

# Call entity extraction on a document or collection of documents

`GET /api/nlp/entities/{id}`

## Request

- Base URL: `/exist/apps/tei-publisher` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/exist/apps/tei-publisher/api/nlp/entities/{id}`
- Auth: one of:
  - API key in cookie `teipublisher.com.login`
  - HTTP basic

## Path parameters

- `id` string, required

## Query parameters

- `model` string, required
- `debug` boolean

## Response `200`

JSON structure listing the entities found

- unknown[]
  - unknown

## Changes

- **2024-01-17** `32eb62a344de`: 1 breaking
  - the response's body type changed from `object` to `array` for status `200`
- **2022-03-11** `69487e45fc43`: 1 breaking
  - added the new required `query` request parameter `model`
- **2022-03-11** `d2df2f300484`: 2 warning, 1 info
  - deleted the `query` request parameter `lang`
  - deleted the `query` request parameter `mode`
  - added the new optional `query` request parameter `debug`
- **2022-03-11** `cea1c7a10072`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/eeditiones/apis/tei-publisher-documentation-and-demo/changes/api/nlp/entities/:id/get.md)

---

[API](https://skmtc.dev/eeditiones/apis/tei-publisher-documentation-and-demo.md) - [All operations](https://skmtc.dev/eeditiones/apis/tei-publisher-documentation-and-demo/llms.txt) - [OpenAPI document](https://skmtc.dev/eeditiones/apis/tei-publisher-documentation-and-demo/revisions/07216792837f?raw)