Skip to content

Popular

  • QuickstartDevelopers
  • AuthenticationBasics
  • WebhooksBasics
  • Upload a documentPOST /v1/read/documents
  • Get a document’s fieldsGET /v1/read/documents/{id}/fields
  • Extract your own fieldsREAD · Document Extraction
READ menu

READ · Documents

Documents

Upload a document and Rowland reads, classifies and extracts it in the background.

A document is one file you upload: a lease, a deed, a division order, a revenue statement. Everything else in READ works on documents.

What happens after upload

  1. Reading. Rowland reads every page, typed or scanned.
  2. Classifying. Rowland works out the document type, unless you gave one.
  3. Extracting. Rowland extracts the fields for that type, cites each one, and writes a short summary.

All of this happens in the background. Get the document to check on it, or use a webhook.

Statuses

Status Meaning
processing Being read and extracted.
ready Done. Its fields are ready.
failed It could not be processed. The document says why.

Needs review

When something in a document needs a person's judgment, such as two acreage figures that disagree, needs_review is true and the document's fields say what to check and why.

Your own references

Attach tags and metadata when you upload, such as a lease number or a tract ID. They come back with the document, and you can filter lists by type and status.