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 · Chat

Ask a question

Get an answer in plain language, with the document, page and line behind it.

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

Body parameters

  • questionstringRequired

    The question, in plain language.

  • conversationstringOptional

    A conversation ID, to ask a follow-up. Leave it out to start a new conversation.

  • documentsstring[]Optional

    Answer from these documents only. Leave it out to use all of yours.

  • rowland_brainbooleanOptional

    Also draw on the Rowland brain, the land and energy knowledge our team curates.

    Default true

  • stylestringOptional

    How the answer is written.

    One of normal, concise, formal, friendlyDefault normal

Returns

200OK. For failures, see Errors.

  • textstring

    The answer.

  • citationsobject[]

    Every source the answer relies on: the document, the page and the line quoted.

  • conversationstring

    Send it back to ask a follow-up.

curl -X POST "https://api.rowland.ai/v1/read/answers" \
  -H "x-api-key: $ROWLAND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "What is the NRI for Mary Whitfield on the Whitfield unit?",
  "documents": [
    "doc_2Hq8kLm4Vt",
    "doc_4Pc7hTy2Rn"
  ],
  "style": "concise"
}'

Response200

{
  "object": "answer",
  "conversation": "cnv_6Vb9zKe4Hs",
  "text": "Mary Whitfield’s NRI is 0.0234375: a 3/16 royalty (0.1875) times her 1/8 share of the unit (0.125).",
  "citations": [
    {
      "document": "doc_2Hq8kLm4Vt",
      "page": 2,
      "quote": "a royalty of three-sixteenths (3/16) of all oil and gas produced and saved"
    },
    {
      "document": "doc_4Pc7hTy2Rn",
      "page": 1,
      "quote": "Mary A. Whitfield, undivided one-eighth (1/8) interest"
    }
  ]
}