Abstracts
Abstracts are an ordered collection of instruments and typically represent a title summary.
Abstract Object
Attributes
id
Integer
Unique id of the abstract
key
String
A unique key for the abstract
projectId
Integer
Id of the abstract's project
createdAt
String
ISO formatted DateTime when the abstract was created
updatedAt
String
ISO formatted DateTime when the abstract was last updated
createdBy
UserObject|null
Original creator of the abstract
updatedBy
UserObject|null
Last user who updated the abstract
Abstract Instrument Object
Create Abstract
POST https://api.annolab.ai/v1/abstract/create
Create a new abstract in a project. Each area of interest (AOI) is the land models target when examining documents. They are stored as one or more Legal Description tags on the abstract. Newly created abstracts start with no instruments; instruments are added as they are matched to those tags.
The project must already have a Legal Description tag type. Creating an abstract requires an API key with "Write" permissions, and the key's user must have view access to the project.
Headers
Authorization
string
Where you put your api key. Creating an abstract requires a key with "Write" permissions.
{"Authorization": "Api-Key XXXXXXX-XXXXXXX-XXXXXXX"}
Request Body
name
string
Name of the abstract to create
projectIdentifier
string|integer
Id or unique name of the project that will contain the abstract
groupName
string
Optional. Group that owns the project. When provided, the project is resolved as that group's project named or identified by projectIdentifier. Omit to resolve the project from the API key's user.
aois
AOI[]
At least one area of interest. Models use these to extract only information relevant to the target land. Each AOI is converted into Legal Description tags on the abstract. See Texas AOIs for how a single Texas AOI can produce two tags.
subdivisions
string[]
Optional. Subdivision names to associate with the abstract
A 400 is also returned when the project is missing a Legal Description tag type:
Example of how to make the request to create an abstract
Get Predicted Owners
POST https://api.annolab.ai/v1/abstract/land/predicted-owners
Ownership predictions require running the ownership chain agent first. See Ownership Chain Agent.
Return predicted mineral owners for a land abstract. Each result is a party ownership prediction, including the related party and the legal description the prediction applies to.
Requires an API key with "Read" permissions, and the key's user must have view access to the abstract's project.
Headers
Authorization
string
Where you put your api key. Getting predicted owners requires a key with "Read" permissions.
{"Authorization": "Api-Key XXXXXXX-XXXXXXX-XXXXXXX"}
Request Body
projectIdentifier
string|integer
Id or unique name of the project that contains the abstract
abstractIdentifier
string|integer
Id or name of the abstract
groupName
string
Optional. Group that owns the project. When provided, the project is resolved as that group's project named or identified by projectIdentifier.
Area of Interest (AOI) Object
An AOI is the target land for an abstract. When models examine documents, they use the AOI to cut through noise and extract only information relevant to that area. The exception is leases: when analyzing a lease, models extract lands both within the AOI and outside lands.
county and state are always required. state must be a two-letter US abbreviation. The remaining fields depend on whether the AOI is in Texas.
Omitted optional fields are stored as empty strings on the resulting Legal Description tag.
Non-Texas AOI
Use this shape when state is any US abbreviation except TX.
county
string
County name
state
string
Two-letter US state abbreviation other than TX
section
string
Optional PLSS section
township
string
Optional PLSS township
range
string
Optional PLSS range
Each non-Texas AOI creates one Legal Description tag with Section, Township, Range, County, and State.
Texas AOI
Use this shape when state is TX.
county
string
County name
state
string
Must be TX
section
string
Optional section
block
string
Optional block
township
string
Optional township
abstract
string
Optional abstract number / abstract id
survey
string
Optional survey name
A Texas AOI can create one or two Legal Description tags:
Block / township tag (Section, Block, Township, Survey Name, County, State) when block or township is provided, or when block, township, and abstract are all omitted.
Abstract tag (Section, Abstract Id, Survey Name, County, State) when
abstractis provided.
If both block/township and abstract are present, both tags are created. If only abstract is provided, only the abstract tag is created.
Example of creating an abstract from a Texas AOI
Predicted Owner Object
id
Integer
Unique id of the ownership prediction
partyId
Integer
Id of the predicted owner party
abstractId
Integer
Id of the abstract
ownsInterest
Boolean
Whether the party is predicted to own an interest
predictionNotes
String
Explanation of the prediction
section
String|null
Section the prediction applies to
township
String|null
Township the prediction applies to
range
String|null
Range the prediction applies to
legalBody
String|null
Legal body / tract description
lot
String|null
Lot the prediction applies to
subdivision
String|null
Subdivision the prediction applies to
predictionConfidence
String
Confidence of the prediction
interestTypes
String[]
Predicted interest types, for example Mineral
createdAt
String
ISO formatted DateTime when the prediction was created
updatedAt
String
ISO formatted DateTime when the prediction was last updated
party
Object|null
Party details: id, fullName, partyType, name parts, aliases, addresses
Last updated
Was this helpful?