Sign in
transforms
public

Create Transform

Run the transformation defined in transformation params for all the assets in the project

Args: transform_id (str): The ID of the transformation to run.

Returns: {"message": "Transformation initiated", "transform_id": transform_id}

post/v1/transforms/create

Headers

API-Versionstring

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

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

Request body

proj_idstring required

The id of the project.

transform_namestring

The transform_name parameter is an optional parameter that provides a human-readable name or description for the transformation, which can be useful for identifying and referencing transformations. If provided, the transform_name parameter should be a string. If not provided, the value of transform_name will be None.

Example request

{
  "transform_params": {
    "mode": "document",
    "operations": [
      {
        "task_description": "Derive the invoice amount from {{Invoices}}, and add it to the rent from {{Rent Amount}}."
      }
    ]
  }
}

Response

Successful Response

messagestring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.