 @font-face {
    font-family: 'Karla';
    font-style: normal;
    font-weight: 400;
    font-display: swap;
    src: url('https://fonts.gstatic.com/s/karla/v31/qkB9XvYC6trAT55ZBi1ueQVIjQTD-JrIH2G7nytkHRyQ8p4wUje6bg.woff2');
}

h1,h2,h3,p{
  font-family: 'Karla';
  letter-spacing: normal !important;
}


Retrieve all the assets and its id in a project.

Get Assets

AssetStatus

Asset Id

Created At

Ext File Id

Ext File Name

File Type

Proj Id

Transform Id

AssetsBaseResponse

Total Filtered Results Count

Total Results Count

AssetsResponseMetadata

Retrieve asset IDs from a project.

Parameters:
- asset_ids (List[str], optional): The list of asset IDs to retrieve. This is optional, but will override the proj_id if provided.
- proj_id (str, optional): The id of the project. This is optional, but will be used if asset_ids is not provided.
- status (AssetStatus, optional): Filters the results based on the status of the assets.
- limit (int, optional): The number of transformations to retrieve.
- offset (int, optional): The offset to start retrieving transformations from.
- order_by (str, optional): The column to order the transformations by.
- order (str, optional): The order to sort the transformations by.

If neither asset_ids or proj_id is provided, all assets will be retrieved.

Returns:
- dict: A dict containing the all the asset data.

APIKeyHeader

AssetsResponse

Trellis

Introduction

Trellis connects to your datasource, runs the transform you define in natural language, and writes to your systems of record.

Trellis Platform Overview

Share your projects with other Trellis customers!

Share your projects

Creating a template

The zero-day retention policy is designed to ensure the security and privacy of sensitive data handled by Trellis.

Trellis Zero-Day Data  Retention Policy

API Appendix

Authentication

file-lines

Create a new project where you can upload files and run a set of transformations.

Create Project

Get project API lists all the projects created by the user.

Get Projects

Delete Project

file

Creates presigned URLs for uploading files associated with specific IDs.

Create Presigned Urls

Upload files from URLs to a project in Trellis to be processed later. You need to create a project and get the `proj_id` before uploading assets.

Upload Assets

Delete an asset in a project for a given `asset_id`.

Delete Assets

file-export

API that converts PDFs, Images and Audio files into nice markdown text with all the format such as table and charts preserved.

Extract Files

Get the clean markdown from parsed values from the file

Get Extraction Values

bell

Create Webhook

Get Webhook

Get All Webhooks

file-contract

API that transforms unstructured data into structured format based on your schema. You can specify classification, extraction and generation options on the data all in the `transform_params`

Create Transform

Get Transforms

Run the transformation on the assets that have been added or updated since the last run.

Refresh Transform

Get Autoschema

Get the results of a transformation. You can filter and paginate the results by asset_ids.

Get Transform Results

Add Rows

Patch Rows

Create event triggers to automatically run the extraction and transformation

Create Event Subscriptions With Actions

Summary of changes made to the Trellis platform

Changelog

Home

Community

Blog

Recipes

SDKs

API Reference

Book Demo

Sign Up

Learn the key entities and mental models to make Trellis work for you

Overview

In this example, we will walkthrough how you can use our APIs to extract key features from thousands of medical documents in seconds.

Example: Medical Reports

Example: Analytics on Medical Documents

In this example, we will walkthrough how you can use Trellis to perform PDF to markdown extraction. 

Example: PDF to markdown extraction

In this example, we will walk through how you can configure webhooks to receive notifications when your transformations have finished running!

Example: Setting up Transformation Webhooks

 For large datasets that take a long time to export via the UI, Trellis provides an API export feature, allowing you to access the full processed dataset efficiently. You can also use this functionality as a foundation to integrate Trellis with your data store. 

Large CSV data export

In this example, you will create a custom email address to integrate with incoming emails for processing attachments or email content.

Create your own email agent right in your inbox

Transformation Schema

Defining a Transformation

Specify the data type you wish to extract.

The Column Types

Transformations: column_type

Configure how you get data from your assets and operations

The Transform Types

Transformation: `transform_type`

Utilize structured column types to manage complexity in your document pipelines

Lists and Objects in the UI

Transformations: Lists and Objects

Private Cloud & On-Prem deployment is available on Enterprise Tier

Deploying Trellis Enterprise using Kubernetes

Deploy Trellis Enterprise on Kubernetes Cluster

Deploying Trellis Enterprise on the private servers.

Overview

Project

Assets

Assets Extraction

Webhook

Transforms

Event Action

Get Assets

Authorizations

Headers

Query Parameters

Response