POST
/
v1
/
transforms
/
{transform_id}
/
results
curl --request POST \
  --url https://api.runtrellis.com/v1/transforms/{transform_id}/results \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "asset_ids": [
    "<string>"
  ],
  "row_ids": [
    "<string>"
  ],
  "blocking": false,
  "filters": {}
}'
{
  "message": "<string>",
  "transform_status": "running",
  "metadata": {
    "total_results_count": 123,
    "total_filtered_results_count": 123,
    "column_definitions": [
      {
        "id": "<string>",
        "name": "<string>",
        "group": "default",
        "visual_index": 123
      }
    ]
  },
  "data": {
    "asset_id": "asset_id_1",
    "result_id": "result_id_1",
    "ext_file_id": "ext_id_1",
    "ext_file_name": "file_name_1.pdf",
    "trellis_validation_status": true,
    "your_field_1": 0.5,
    "your_field_2": "some string",
    "your_field_3": true
  }
}

Authorizations

​
Authorization
string
header
required

Headers

​
API-Version
string

Pass in an API version to guarantee a consistent response format.

The latest version should be used for all new API calls. Existing API calls should be updated to the latest version when possible.

Valid versions:

  • Latest API version (recommended): 2025-03

  • Previous API version (maintenance mode): 2025-02

If no API version header is included, the response format is considered unstable and could change without notice (not recommended).

Path Parameters

​
transform_id
string
required

Transformation ID for the transformation to retrieve.

Query Parameters

​
result_id
string

Result ID to retrieve. Will be deprecated in Jan 2025.

​
limit
integer
default:50
Required range: x > 0
​
offset
integer
default:0
Required range: x >= 0
​
order_by
string
default:increment_id
​
order
enum<string>
default:asc

An enumeration.

Available options:
asc,
desc

Body

application/json
​
asset_ids
string[]

List of asset IDs to filter by. When this paramter is passed in, blocking defaults to True. This will override any asset_id filters in the request body.

​
row_ids
string[]

List of row IDs to filter by. When this paramter is passed in, blocking defaults to True. This will override any row_id filters in the request body.

​
blocking
boolean
default:false

Checks whether to block the return until all the asset_ids results are completed. If set to False, the response will return immediately with the results that are available.

​
filters
object

Response

200
application/json
Successful Response
​
message
string
required
​
data
object[]
required
Example:
{
  "asset_id": "asset_id_1",
  "result_id": "result_id_1",
  "ext_file_id": "ext_id_1",
  "ext_file_name": "file_name_1.pdf",
  "trellis_validation_status": true,
  "your_field_1": 0.5,
  "your_field_2": "some string",
  "your_field_3": true
}
​
transform_status
enum<string>

An enumeration.

Available options:
running,
failed,
completed,
not_started
​
metadata
object