POST
/
v1
/
assets
/
extract
curl --request POST \
  --url https://api.runtrellis.com/v1/assets/extract \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "asset_ids": [
    "<string>"
  ],
  "transform_id": "<string>",
  "parse_strategy": "optimized",
  "blocking": false
}'
{
  "message": "<string>",
  "data": [
    {
      "asset_id": "<string>",
      "ext_file_name": "<string>",
      "ext_file_id": "<string>",
      "file_type": "<string>",
      "url": "<string>",
      "status": "uploading"
    }
  ]
}

The proj_id parameter is now deprecated. Please use asset_ids to specify which assets to extract.

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).

Body

application/json
asset_ids
string[]

Optional. Asset IDs to run extraction on. Overrides transform_id.

transform_id
string

Optional. Transformation ID of the transform housing the assets to extract.

parse_strategy
enum<string>
default:advanced_markdown

Enum representing different parsing strategies. Note that OCR and XML will be deprecated soon.

Available options:
optimized,
ocr,
xml,
markdown,
advanced_markdown
blocking
boolean
default:false

Optional, defaults to False. If True, a response will come back after at most 120 seconds with the extracted values.

Response

200
application/json
Successful Response
message
string
required
data
object[]
required