Skip to content
HALOWERK

Text Tools

html ruby script inventory

Web page ruby scripts count annotations containing kana, Han, bopomofo or Latin characters. Use it when an agent needs script support in a text renderer.

POST https://text.halowerk.com/v1/html-ruby-script-inventory

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
urlstringYes
limitintegerNo
reuse_licenseSee schemaNo
Show full input schema
{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 640,
      "minLength": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "reuse_license": {
      "enum": [
        "CC0",
        "CC-BY-4.0",
        "public-domain",
        "own-content"
      ]
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "url": "https://www.w3.org/International/articles/ruby/markup",
  "limit": 1
}

Result & documentation

Show published result schema
{
  "type": "object",
  "required": [
    "measured_at",
    "source",
    "data",
    "limitations"
  ],
  "properties": {
    "measured_at": {
      "type": "string"
    },
    "source": {
      "type": "object",
      "required": [
        "reference",
        "retrieved_at"
      ],
      "properties": {
        "reference": {
          "type": "string"
        },
        "retrieved_at": {
          "type": "string"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "kana": {
          "type": "integer"
        },
        "han": {
          "type": "integer"
        },
        "bopomofo": {
          "type": "integer"
        },
        "latin": {
          "type": "integer"
        }
      },
      "required": [
        "kana",
        "han",
        "bopomofo",
        "latin"
      ]
    },
    "limitations": {
      "type": "string"
    }
  }
}

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-20 UTC.

More endpoints in this hub

All endpoints in this hub →