Zum Inhalt
HALOWERK

Bürowerk

clause extract

Takes a contract as text, a public URL or inline base64 — PDF, DOCX, ODT, HTML and Markdown are read — and returns the passages governing the requested topics. Termination, liability, term, payment and jurisdiction are the default; confidentiality, data protection, IP, warranty, force majeure, assignment and notice can be requested as well. Every finding comes back with the clause quoted word for word, the character offset and line where it stands, the section heading if the document names.

POST https://buero.halowerk.com/v1/clause-extract

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
documentobjectJaThe contract. Exactly one of text, url or content_base64.
clause_typesarrayNeinWhich topics to look for. Default: termination, liability, term, payment, jurisdiction.
document_charsintegerNeinOnly needed when the contract arrives by url or content_base64: its length in characters, which is what you are billed for. A longer text is refused with its real length and nothing is charged.
include_unverifiedbooleanNeinAlso return findings whose quote could not be located in the source, clearly marked. Off means they are only counted.
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "document"
  ],
  "additionalProperties": false,
  "properties": {
    "document": {
      "type": "object",
      "additionalProperties": false,
      "description": "The contract. Exactly one of text, url or content_base64.",
      "properties": {
        "text": {
          "type": "string",
          "maxLength": 200000,
          "description": "The text directly. Cheapest and clearest — its length is billed as counted here."
        },
        "url": {
          "type": "string",
          "maxLength": 2048,
          "description": "Public http(s) URL of a PDF, DOCX, ODT, HTML or text file. Private and local addresses are refused."
        },
        "content_base64": {
          "type": "string",
          "maxLength": 4000000,
          "description": "The file inline, base64."
        },
        "filename": {
          "type": "string",
          "maxLength": 260,
          "description": "Only consulted when the bytes carry no recognisable signature."
        },
        "format": {
          "type": "string",
          "enum": [
            "auto",
            "pdf",
            "docx",
            "odt",
            "html",
            "markdown",
            "rtf",
            "text"
          ],
          "default": "auto",
          "description": "Override the detected format. \"auto\" reads it from the bytes."
        }
      }
    },
    "clause_types": {
      "type": "array",
      "minItems": 1,
      "maxItems": 12,
      "description": "Which topics to look for. Default: termination, liability, term, payment, jurisdiction.",
      "items": {
        "type": "string",
        "enum": [
          "termination",
          "liability",
          "term",
          "payment",
          "jurisdiction",
          "confidentiality",
          "data_protection",
          "ip",
          "warranty",
          "force_majeure",
          "assignment",
          "notice"
        ]
      }
    },
    "document_chars": {
      "type": "integer",
      "minimum": 1,
      "maximum": 24000,
      "description": "Only needed when the contract arrives by url or content_base64: its length in characters, which is what you are billed for. A longer text is refused with its real length and nothing is charged."
    },
    "include_unverified": {
      "type": "boolean",
      "default": true,
      "description": "Also return findings whose quote could not be located in the source, clearly marked. Off means they are only counted."
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "document": {
    "text": "§ 4 Laufzeit und Kuendigung\nDer Vertrag laeuft zwoelf Monate ab Unterzeichnung. Er verlaengert sich um jeweils zwoelf Monate, wenn er nicht mit einer Frist von drei Monaten zum Laufzeitende gekuendigt wird.\n\n§ 9 Gerichtsstand\nGerichtsstand ist Berlin."
  },
  "clause_types": [
    "termination",
    "term",
    "jurisdiction"
  ]
}

Ergebnis & Dokumentation

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →