Home

Community

Blog

Trellis

Recipes

SDKs

API Reference

Book Demo

Sign Up

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

AssetsBaseResponse

Total Filtered Results Count

Total Results Count

AssetsResponseMetadata

Location

Message

Error Type

ValidationError

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

HTTPValidationError

The Trellis AI engine takes your documents and automates your business workflows.

Introduction

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

Trellis Platform Overview

Overview

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

Example: Analytics on Enron Email

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

Example: PDF to markdown extraction

Defining Transformation

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

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.

Private Network

API Concepts & Data Flow

Authentication

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

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

API that converts PDFs, Images and Audio files into nice markdow 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

Create Webhook

Get Webhook

Get All Webhooks

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

Create event triggers to automatically run the extraction and transformation

Overview

Project

Assets

Assets Extraction

Webhook

Transforms

Event Action

Get Assets

Authorizations

Query Parameters

Response