---
title: "Encode and decode HTML entities (named, decimal, hex)."
method: POST
path: "/api/v1/html-entity"
tags: ["Encoders & Decoders"]
---

# Encode and decode HTML entities (named, decimal, hex).

`POST /api/v1/html-entity`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/html-entity`
- Auth: none declared

HTML Entity Encoder & Decoder. Operations: `encode` — Encode text into HTML entities. `decode` — Decode HTML entities back to plain text.

## Request body

- union
  - HtmlEntityEncode: Encode text into HTML entities.
    - `operation` 'encode', required
    - `input` string: The text to encode.
    - `options` object
      - `format` 'named' | 'decimal' | 'hex': Output entity format.
      - `encodeAll` boolean: Encode every character.
      - `preferNamed` boolean: Prefer a named entity when one exists.
  - HtmlEntityDecode: Decode HTML entities back to plain text.
    - `operation` 'decode', required
    - `input` string: The text containing HTML entities.
    - `options` object

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'html-entity', required
  - `operation` 'encode' | 'decode', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

[API](https://skmtc.dev/programmes/apis/programmes-net-api.md) · [All operations](https://skmtc.dev/programmes/apis/programmes-net-api/llms.txt) · [OpenAPI document](https://skmtc.dev/programmes/apis/programmes-net-api/revisions/aa939784a2e6?raw)