Text Tools
html ruby reading index
Web page ruby readings return base text and annotation strings in document order. Use it when an agent needs readings for a glossary.
POST https://text.halowerk.com/v1/html-ruby-reading-indexInputs
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | Yes | |
| limit | integer | No | |
| reuse_license | See schema | No |
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
}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": {
"total": {
"type": "integer"
},
"readings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"base": {
"type": "string"
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"base",
"notes"
]
}
}
},
"required": [
"total",
"readings"
]
},
"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
- Text Tools0.002 USDC
acronym ideas
POSThttps://text.halowerk.com/v1/acronym-ideasSplits the title into words, marks German and English stop words (and, of, für, und ), and enumerates in word order every combination of the first 1-3 letters of each significant word (stop words contribute 0 or 1 letter when allowed), with
- Text Tools0.005 USDC
agg check
POSThttps://text.halowerk.com/v1/agg-checkApplies documented rules to the ad text and its first line or title: explicit age limits and age ranges, youth-related team wording and career-stage target groups (age); native-speaker, accent and origin requirements, nationality (ethnic or
- Text Tools0.002 USDC
anglicism replace
POSThttps://text.halowerk.com/v1/anglicism-replaceLooks up every word in about 1,050 entries that OpenThesaurus (export 2026-10-30, LGPL-2.1 or CC BY-SA 4.0) labels English, Anglicism or Denglisch, matching inflected forms from german-pos-dict 1.2.2 (CC BY-SA 4.0) and English heads of comp