For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ownership Chain Agent

Launch, inspect, stop, and stream the ownership chain agent for a land abstract.

AnnoLab's ownership chain agent uses the instruments you've uploaded to an abstract, constructs an ownership chain, and predicts current ownership.

Agent Job Object

Name
Type
Description

id

Integer

Unique id of the agent job

abstractId

Integer

Abstract the job is running against

agentType

String|null

Agent type. Ownership chain jobs use OwnershipChain.

status

String

One of Initialized, Launching, Running, StopRequested, Stopped, Stalled, Errored, Completed

errorMessage

String|null

Error text when status is Errored

jobData

Object

Job payload, including optional progress counts

createdAt

String

ISO formatted DateTime when the job was created

createdBy

Integer|null

User id that launched the job

updatedAt

String

ISO formatted DateTime when the job was last updated

jobData.progress may include conveyancesAnalyzed, totalConveyances, partiesAnalyzed, partiesRequiringAnalysis, and totalParties.

Get latest ownership chain job

GET https://api.annolab.ai/v1/agents/ownership-chain/{abstractId}

Return the most recently updated ownership chain agent job for an abstract, or null if none exists. Requires an API key with "Read" permissions, and the key's user must have view access to the abstract's project.

Path Parameters

Name
Type
Description

abstractId

integer

Id of the abstract

Headers

Name
Type
Description

Authorization

string

Where you put your api key. Getting the latest job requires a key with "Read" permissions. {"Authorization": "Api-Key XXXXXXX-XXXXXXX-XXXXXXX"}

Launch ownership chain agent

POST https://api.annolab.ai/v1/agents/ownership-chain/{abstractId}/launch

Start an ownership chain agent job for the abstract. Requires an API key with "Write" permissions, and the key's user must be able to run model inference on the abstract's project. Returns the created Agent Job.

Path Parameters

Name
Type
Description

abstractId

integer

Id of the abstract

Headers

Name
Type
Description

Authorization

string

Where you put your api key. Launching the agent requires a key with "Write" permissions. {"Authorization": "Api-Key XXXXXXX-XXXXXXX-XXXXXXX"}

Stop ownership chain agent

POST https://api.annolab.ai/v1/agents/ownership-chain/{abstractId}/stop

Request that the running ownership chain agent for the abstract stop. Requires an API key with "Write" permissions, and the key's user must be able to run model inference on the abstract's project.

If a running job is found, its status becomes StopRequested and a stop command is published to the agent. Returns the updated Agent Job, or null if nothing was updated.

Path Parameters

Name
Type
Description

abstractId

integer

Id of the abstract

Headers

Name
Type
Description

Authorization

string

Where you put your api key. Stopping the agent requires a key with "Write" permissions. {"Authorization": "Api-Key XXXXXXX-XXXXXXX-XXXXXXX"}

Last updated

Was this helpful?