---
title: "Named Entity Recognition"
method: POST
path: "/v1/named-entity-recognition"
tags: ["documents"]
---

# Named Entity Recognition

`POST /v1/named-entity-recognition`

## Request

- Base URL: `https://agent.pocket.network`
- URL: `https://agent.pocket.network/v1/named-entity-recognition`
- Auth: none required

Rule-based named-entity recognition for English text, from patterns and word lists rather than a trained model: persons, organisations, places, dates, money, percentages, emails, URLs and products, with character offsets. Best on clean, well-capitalised text; it misses names off its lists. POST /v1/ner with {text}. Pay per request in USDC; no account, no API key.

## Request body

- object: The body of POST /v1/ner.
  - `text` string, required: English text to tag.

## Response `200`

The upstream response, served after payment settles.

- object: For POST /v1/ner, a JSON object with entities (text, label, start, end), count, model and deterministic. Labels are PERSON, ORG, LOC, DATE, MONEY, PERCENT, EMAIL, URL and PRODUCT. A bad request answers 400 with an `error` string. Properties are pinned from live paid responses; nothing is required, because every route's 2xx response is validated against this one schema.
  - `entities` object[]
    - `text` string
    - `label` string
    - `start` number
    - `end` number
  - `count` number
  - `model` string
  - `deterministic` boolean
  - `service` string

## Other responses

- `400`: Malformed request.
- `402`: Payment required. The x402 v2 terms are in the PAYMENT-REQUIRED header and, identically, in this body; sign the chosen option and retry with the PAYMENT-SIGNATURE header. The receipt arrives in PAYMENT-RESPONSE.
- `503`: This service is not currently available to serve.

---

[API](https://skmtc.dev/pocket/apis/pocket-agentic-portal.md) · [All operations](https://skmtc.dev/pocket/apis/pocket-agentic-portal/llms.txt) · [OpenAPI document](https://skmtc.dev/pocket/apis/pocket-agentic-portal/revisions/96d2176db014?raw)
