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 · Document Extraction

Get a document’s fields

The records Rowland extracted from a document, with a citation for every value.

GEThttps://api.rowland.ai/v1/read/documents/{id}/fields

Path parameters

  • idstringRequired

    The document ID.

Returns

200OK. For failures, see Errors.

  • recordsobject[]

    One record per instrument, or more when the document holds several (a statement with many properties). Each has values and, for every value, a citation: the page and the exact text.

  • reviewobject[]

    Anything a person should check, and why, instead of a silent guess.

curl "https://api.rowland.ai/v1/read/documents/doc_2Hq8kLm4Vt/fields" \
  -H "x-api-key: $ROWLAND_API_KEY"

Response200

{
  "object": "document_fields",
  "document": "doc_2Hq8kLm4Vt",
  "type": "oil_gas_lease",
  "records": [
    {
      "values": {
        "lessor": "Mary A. Whitfield",
        "lessee": "Permian Land Co.",
        "effective_date": "2019-03-14",
        "primary_term_years": 7,
        "royalty": 0.1875,
        "gross_acres": 320,
        "pugh_clause": true
      },
      "citations": {
        "royalty": {
          "page": 2,
          "text": "a royalty of three-sixteenths (3/16) of all oil and gas produced and saved"
        },
        "primary_term_years": {
          "page": 1,
          "text": "for a primary term of seven (7) years"
        }
      }
    }
  ],
  "review": [
    {
      "field": "gross_acres",
      "note": "Page 1 says 320 acres; Exhibit A totals 318.6."
    }
  ]
}