READ · Advanced Search
Preview a search
See how Rowland reads your question, and what the search will cost, before you run it.
POSThttps://api.rowland.ai/v1/read/searches/preview
Body parameters
questionstringRequiredWhat to find, the way you would ask a colleague.
Returns
200OK. For failures, see Errors.
understood_asobjectHow Rowland read the question, as filters: types, royalty, term, acreage, parties, keywords and exact phrases. Change any of them and pass them to Run a search.
costobjectWhat running the search will cost. Previewing is free.
curl -X POST "https://api.rowland.ai/v1/read/searches/preview" \
-H "x-api-key: $ROWLAND_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "Leases in Reeves County with a royalty above 3/16 and a primary term over five years"
}'Response200
{
"object": "search_preview",
"understood_as": {
"types": [
"oil_gas_lease"
],
"royalty": {
"greater_than": 0.1875
},
"primary_term_years": {
"greater_than": 5
},
"keywords": [
"Reeves County"
]
},
"cost": {
"credits": 12
}
}