Skip to content
HALOWERK

Text Tools

manual preview heading index

Web manual extraction maps an embedded example to its preceding section and standalone source. Use it when an agent needs a reading pointer for an embedded demonstration.

POST https://text.halowerk.com/v1/manual-preview-heading-index

Inputs

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

Open original schema

Published input example

{
  "url": "https://design-system.service.gov.uk/components/details/",
  "index": 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": {
        "examples": {
          "type": "integer"
        },
        "section": {
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "examples",
        "section",
        "source"
      ]
    },
    "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 →