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

Start an extraction

Extract your own fields from one or many documents.

POSThttps://api.rowland.ai/v1/read/extractions

Body parameters

  • documentsstring[]Required

    The documents to read.

  • schemaobjectRequired

    The fields you want, as a JSON Schema. Each property’s description tells Rowland what to look for.

  • perstringOptional

    document: one record per document. item: one record per item found, such as every tract or every well.

    One of document, itemDefault document

  • itemstringOptional

    With per: item, what one item is, such as tract.

  • instructionsstringOptional

    Anything the schema cannot say, such as which royalty to use when a lease states two.

Returns

202Accepted: the work continues in the background. For failures, see Errors.

  • idstring

    The extraction ID, starting ext_.

  • statusstring

    running, then completed or failed.

curl -X POST "https://api.rowland.ai/v1/read/extractions" \
  -H "x-api-key: $ROWLAND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "documents": [
    "doc_2Hq8kLm4Vt",
    "doc_7Rw3nPz9Xc"
  ],
  "schema": {
    "type": "object",
    "properties": {
      "lessor": {
        "type": "string",
        "description": "Every lessor named"
      },
      "royalty": {
        "type": "number",
        "description": "Landowner royalty as a decimal, e.g. 0.1875"
      },
      "depth_limit": {
        "type": "string",
        "description": "Any depth limitation, as written"
      }
    }
  },
  "per": "document"
}'

Response202

{
  "object": "extraction",
  "id": "ext_9Fd2sQw7Lp",
  "status": "running",
  "documents": 2,
  "created_at": "2026-11-20T15:10:00Z"
}