Skip to content
HALOWERK

Text Tools

doc head index entry

Web page index discovery finds the direct subject index and determines whether it resides in the document directory. Use it when an agent needs the subject index for a technical manual.

POST https://text.halowerk.com/v1/doc-head-index-entry

Inputs

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

Open original schema

Published input example

{
  "url": "https://docs.python.org/3.14/tutorial/datastructures.html"
}

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": {
        "index": {
          "type": [
            "string",
            "null"
          ]
        },
        "same_directory": {
          "type": "boolean"
        },
        "number": {
          "type": "integer"
        }
      },
      "required": [
        "index",
        "same_directory",
        "number"
      ]
    },
    "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 →