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
Overview menu

Developers

Quickstart

From an API key to structured data from your first lease in a few minutes.

1. Get an API key

API access is by arrangement: talk to us for a key. It is shown once, so store it straight away:

bash
export ROWLAND_API_KEY="your_api_key"

Every request sends it in the x-api-key header. See Authentication.

2. Upload a document

Send a lease, deed, division order or any other supported file. Rowland reads it, works out what kind of document it is and extracts its fields:

bash
curl -X POST "https://api.rowland.ai/v1/read/documents" \
  -H "x-api-key: $ROWLAND_API_KEY" \
  -F "file=@whitfield-lease.pdf"

The response comes back straight away with the document's id, such as doc_2Hq8kLm4Vt, and status: "processing".

3. Wait until it is ready

Let Rowland tell you with a document.ready webhook, or check the document until its status is ready:

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

4. Get its fields

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

You get the document's records: every value Rowland extracted, each with a citation to the page and the exact words it came from.

Next steps