POST
/
v1
/
transforms
/
{transform_id}
/
results
{
  "message": "<string>",
  "transform_status": "running",
  "metadata": {
    "total_results_count": 123,
    "total_filtered_results_count": 123,
    "column_definitions": [
      {
        "id": "<string>",
        "name": "<string>",
        "group": "default"
      }
    ]
  },
  "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

Path Parameters

​
transform_id
string
required

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.

​
blocking
boolean

Only valid when asset_ids is passed in. Checks whether to block the return until all the asset_ids results are completed. Defaults to True when asset_ids is passed in.

If set to False, the response will return immediately with the results that are available.

​
filters
object

Response

200 - application/json
​
data
object[]
required
​
message
string
required
​
metadata
object
required
​
transform_status
enum<string>

An enumeration.

Available options:
running,
failed,
completed,
not_started