Text URL

The documents endpoint returns a paginated list of document objects under results. Each document may include two fields related to extracted text:

  • has_text: true if this document has extracted text available. The text was manually transcribed or produced via OCR during upload.

  • text_url: the endpoint where you can fetch that extracted text.

Example

A document record may include:

  • has_text: true

  • text_url: "https://www.clearinghouse.net/api/v2p1/documents/15745/text/"

Requesting text_url returns:

{
  "id": 15745,
  "text": "..."
}

where text contains the extracted document text (OCR/transcription).

Last updated