#API Reference

#Overview

The AbstractCRE data model is built around the following objects:

• An Asset represents a property or deal and is the top-level container.
• An Abstract is a structured set of extracted data that belongs to an Asset.
• A Document is a source PDF or file attached to an Abstract.
• A Template defines the structure of an Abstract: its sections and the field names and types within them (text, date, currency, dropdown, grid, etc.).
• A Field Value is a single extracted value, derived from the Template definition and the source Documents.
• A Link is a citation that pins a Field Value to a specific region of a Document page.

#Common use cases

#Pushing data to AbstractCRE

Create assets, upload documents, and create abstracts programmatically, for example, to sync records from an external system or automate document ingestion. The key endpoints are POST /assets, POST /documents/multiple, and POST /abstracts.

#Pulling all data

Export your entire portfolio at once. Use GET /teams/{team_id}/abstracts/stream to stream all abstracts as newline-delimited JSON, and GET /organizations/{organization_id}/templates to fetch the templates needed to interpret field names and structure.

#Authentication

#Generate an API Key

Navigate to User Settings in the AbstractCRE UI and scroll down to the API Key section to generate your secret key.

#Authenticate Requests

Include your API key in the x-api-key header with every request:

x-api-key: YOUR_API_KEY

#Getting Started

Before making your first request, complete Authentication to generate and configure your API key. Then follow the steps below.

#1. Retrieve Your IDs

Call GET /users/me to retrieve your organization and team IDs, which you'll need for subsequent requests.

#2. Fetch Templates

Call GET /organizations/{organization_id}/templates to retrieve the templates available to your organization. Templates define fields (e.g. "Lease", "Loan", "JV", ...).

#3. Stream Abstracts

Use GET /teams/{team_id}/abstracts/stream to stream all abstracts for a team as newline-delimited JSON. This is the recommended way to fetch large datasets.

#4. Combine Templates and Abstracts

Combine the Template and Abstract data to map field values with field definitions. This is required to properly display the value for Dropdowns, Grids, and Text when the template is using citations. See Displaying Values for details.

#AI Integrations

AbstractCRE offers deeper integration options beyond the REST API for teams building AI-powered workflows or embedding AbstractCRE capabilities into their own products.

#MCP

AbstractCRE exposes a Model Context Protocol (MCP) server that connects AI assistants directly to your portfolio data (abstracts, assets, templates, and documents) without writing custom integration code.

#Agents

AbstractCRE Agents are purpose-built AI workflows scoped to specific levels of the data model. Each Agent is invokable over a simple REST API and can be embedded directly in your own applications to automate extraction, analysis, and reporting tasks.

#Resources

#Assets

#Abstracts

#Templates

#Documents

#Users

#Displaying Values

ResponseField values require some interpretation depending on the field type. Match each ResponseField to its template field using the field property (which corresponds to the template field id).

#Text

When citations are enabled on a template, a single text field may produce multiple ResponseField entries, one per cited segment. To reconstruct the full value, filter all ResponseField entries for that field, sort ascending by position, and concatenate the value strings.

Each entry also carries a links array of Link IDs. A Link pins that segment to a specific region on a document page, so you can display the source citation alongside the value. Fetch the full Link objects from the abstract's links collection using those IDs.

#Dropdown

For TemplateFieldDropdown fields, value is stored as a stringified integer index into the field's options array. To get the display name:

displayValue = templateField.options[parseInt(responseField.value)]

For multi-select dropdowns (multi: true), value is a comma-separated list of indices. Split on "," and look up each index in options.

#Grid

For TemplateFieldGrid fields, each cell is stored as a separate ResponseField. The position represents the row number and field identifies the column via GridColumn.id.

To render a grid:

1. Filter all ResponseField entries for the grid field.
2. Group entries by position (row).
3. Within each row, order cells by the column order defined in TemplateFieldGrid.columns.
4. Use GridColumn.name as the column header.

#Schemas

These are the response object types returned across the API.